interface TelemetryRuleProperty

Language	Type name
.NET	`Amazon.CDK.AWS.ObservabilityAdmin.CfnTelemetryRule.TelemetryRuleProperty`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsobservabilityadmin#CfnTelemetryRule_TelemetryRuleProperty`
Java	`software.amazon.awscdk.services.observabilityadmin.CfnTelemetryRule.TelemetryRuleProperty`
Python	`aws_cdk.aws_observabilityadmin.CfnTelemetryRule.TelemetryRuleProperty`
TypeScript	`aws-cdk-lib` » `aws_observabilityadmin` » `CfnTelemetryRule` » `TelemetryRuleProperty`

Defines how telemetry should be configured for specific AWS resources.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_observabilityadmin as observabilityadmin } from 'aws-cdk-lib';
const telemetryRuleProperty: observabilityadmin.CfnTelemetryRule.TelemetryRuleProperty = {
  resourceType: 'resourceType',
  telemetryType: 'telemetryType',

  // the properties below are optional
  destinationConfiguration: {
    cloudtrailParameters: {
      advancedEventSelectors: [{
        fieldSelectors: [{
          endsWith: ['endsWith'],
          equalTo: ['equalTo'],
          field: 'field',
          notEndsWith: ['notEndsWith'],
          notEquals: ['notEquals'],
          notStartsWith: ['notStartsWith'],
          startsWith: ['startsWith'],
        }],

        // the properties below are optional
        name: 'name',
      }],
    },
    destinationPattern: 'destinationPattern',
    destinationType: 'destinationType',
    elbLoadBalancerLoggingParameters: {
      fieldDelimiter: 'fieldDelimiter',
      outputFormat: 'outputFormat',
    },
    logDeliveryParameters: {
      logTypes: ['logTypes'],
    },
    retentionInDays: 123,
    vpcFlowLogParameters: {
      logFormat: 'logFormat',
      maxAggregationInterval: 123,
      trafficType: 'trafficType',
    },
    wafLoggingParameters: {
      loggingFilter: {
        defaultBehavior: 'defaultBehavior',
        filters: [{
          behavior: 'behavior',
          conditions: [{
            actionCondition: {
              action: 'action',
            },
            labelNameCondition: {
              labelName: 'labelName',
            },
          }],
          requirement: 'requirement',
        }],
      },
      logType: 'logType',
      redactedFields: [{
        method: 'method',
        queryString: 'queryString',
        singleHeader: {
          name: 'name',
        },
        uriPath: 'uriPath',
      }],
    },
  },
  selectionCriteria: 'selectionCriteria',
  telemetrySourceTypes: ['telemetrySourceTypes'],
};

Properties

Name	Type	Description
resourceType	`string`	The type of AWS resource to configure telemetry for (e.g., "AWS::EC2::VPC", "AWS::EKS::Cluster", "AWS::WAFv2::WebACL").
telemetryType	`string`	The type of telemetry to collect (Logs, Metrics, or Traces).
destinationConfiguration?	`IResolvable` `\|` `TelemetryDestinationConfigurationProperty`	Configuration specifying where and how the telemetry data should be delivered.
selectionCriteria?	`string`	Criteria for selecting which resources the rule applies to, such as resource tags.
telemetrySourceTypes?	`string[]`	The specific telemetry source types to configure for the resource, such as VPC_FLOW_LOGS or EKS_AUDIT_LOGS.

resourceType

Type: string

The type of AWS resource to configure telemetry for (e.g., "AWS::EC2::VPC", "AWS::EKS::Cluster", "AWS::WAFv2::WebACL").

telemetryType

Type: string

The type of telemetry to collect (Logs, Metrics, or Traces).

destinationConfiguration?

Type: IResolvable | TelemetryDestinationConfigurationProperty (optional)

Configuration specifying where and how the telemetry data should be delivered.

selectionCriteria?

Type: string (optional)

Criteria for selecting which resources the rule applies to, such as resource tags.

telemetrySourceTypes?

Type: string[] (optional)

The specific telemetry source types to configure for the resource, such as VPC_FLOW_LOGS or EKS_AUDIT_LOGS.

TelemetrySourceTypes must be correlated with the specific resource type.

AWS CDK

2.234.1