Skip to content
v2.275.0

TelemetryDestinationConfigurationProperty Struct ​

Configuration specifying where and how telemetry data should be delivered for AWS resources.

Example ​

ts
// 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 telemetryDestinationConfigurationProperty: observabilityadmin.CfnTelemetryRule.TelemetryDestinationConfigurationProperty = {
  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',
  },
  kmsKeyArn: 'kmsKeyArn',
  logDeliveryParameters: {
    logTypes: ['logTypes'],
  },
  mskMonitoringParameters: {
    enhancedMonitoring: 'enhancedMonitoring',
  },
  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',
    }],
  },
};

Properties ​

cloudtrailParametersoptionalIResolvable | CfnTelemetryRule.CloudtrailParametersPropertycloudtrail_parametersoptionaltyping.Union[IResolvable, CloudtrailParametersProperty]cloudtrailParametersoptionalIResolvableCloudtrailParametersoptionalIResolvableCloudtrailParametersoptionalinterface{}#
Configuration parameters specific to AWS CloudTrail when CloudTrail is the source type.
destinationPatternoptionalstringdestination_patternoptionalstrdestinationPatternoptionalStringDestinationPatternoptionalstringDestinationPatternoptional*string#
The pattern used to generate the destination path or name, supporting macros like <resourceId> and <accountId>.
destinationTypeoptionalstringdestination_typeoptionalstrdestinationTypeoptionalStringDestinationTypeoptionalstringDestinationTypeoptional*string#
The type of destination for the telemetry data (e.g., "Amazon CloudWatch Logs", "S3").
elbLoadBalancerLoggingParametersoptionalIResolvable | CfnTelemetryRule.ELBLoadBalancerLoggingParametersPropertyelb_load_balancer_logging_parametersoptionaltyping.Union[IResolvable, ELBLoadBalancerLoggingParametersProperty]elbLoadBalancerLoggingParametersoptionalIResolvableElbLoadBalancerLoggingParametersoptionalIResolvableElbLoadBalancerLoggingParametersoptionalinterface{}#
Configuration parameters specific to ELB load balancer logging when ELB is the resource type.
kmsKeyArnoptionalstringkms_key_arnoptionalstrkmsKeyArnoptionalStringKmsKeyArnoptionalstringKmsKeyArnoptional*string#
The Amazon Resource Name (ARN) of the customer-managed AWS KMS key used to encrypt the destination log groups specified in the Telemetry Rule.
logDeliveryParametersoptionalIResolvable | CfnTelemetryRule.LogDeliveryParametersPropertylog_delivery_parametersoptionaltyping.Union[IResolvable, LogDeliveryParametersProperty]logDeliveryParametersoptionalIResolvableLogDeliveryParametersoptionalIResolvableLogDeliveryParametersoptionalinterface{}#
Configuration parameters specific to Amazon Bedrock AgentCore logging when Amazon Bedrock AgentCore is the resource type.
mskMonitoringParametersoptionalIResolvable | CfnTelemetryRule.MskMonitoringParametersPropertymsk_monitoring_parametersoptionaltyping.Union[IResolvable, MskMonitoringParametersProperty]mskMonitoringParametersoptionalIResolvableMskMonitoringParametersoptionalIResolvableMskMonitoringParametersoptionalinterface{}#
Configuration parameters for Amazon MSK cluster monitoring.
retentionInDaysoptionalnumberretention_in_daysoptionalint | floatretentionInDaysoptionalNumberRetentionInDaysoptionaldoubleRetentionInDaysoptional*float64#
The number of days to retain the telemetry data in the destination.
vpcFlowLogParametersoptionalIResolvable | CfnTelemetryRule.VPCFlowLogParametersPropertyvpc_flow_log_parametersoptionaltyping.Union[IResolvable, VPCFlowLogParametersProperty]vpcFlowLogParametersoptionalIResolvableVpcFlowLogParametersoptionalIResolvableVpcFlowLogParametersoptionalinterface{}#
Configuration parameters specific to VPC Flow Logs when VPC is the resource type.
wafLoggingParametersoptionalIResolvable | CfnTelemetryRule.WAFLoggingParametersPropertywaf_logging_parametersoptionaltyping.Union[IResolvable, WAFLoggingParametersProperty]wafLoggingParametersoptionalIResolvableWafLoggingParametersoptionalIResolvableWafLoggingParametersoptionalinterface{}#
Configuration parameters specific to WAF logging when WAF is the resource type.