class CfnTelemetryRulePropsMixin

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.ObservabilityAdmin.Mixins.CfnTelemetryRulePropsMixin
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsobservabilityadmin/mixins#CfnTelemetryRulePropsMixin
Java	software.amazon.awscdk.mixins.preview.services.observabilityadmin.mixins.CfnTelemetryRulePropsMixin
Python	aws_cdk.mixins_preview.aws_observabilityadmin.mixins.CfnTelemetryRulePropsMixin
TypeScript	@aws-cdk/mixins-preview » aws_observabilityadmin » mixins » CfnTelemetryRulePropsMixin

Implements IMixin

Extends Mixin

Creates a telemetry rule that defines how telemetry should be configured for AWS resources in your account.

The rule specifies which resources should have telemetry enabled and how that telemetry data should be collected based on resource type, telemetry type, and selection criteria.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-observabilityadmin-telemetryrule.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins } from '@aws-cdk/mixins-preview';
import { mixins as observabilityadmin_mixins } from '@aws-cdk/mixins-preview/aws-observabilityadmin';
const cfnTelemetryRulePropsMixin = new observabilityadmin_mixins.CfnTelemetryRulePropsMixin({
  rule: {
    destinationConfiguration: {
      cloudtrailParameters: {
        advancedEventSelectors: [{
          fieldSelectors: [{
            endsWith: ['endsWith'],
            equalTo: ['equalTo'],
            field: 'field',
            notEndsWith: ['notEndsWith'],
            notEquals: ['notEquals'],
            notStartsWith: ['notStartsWith'],
            startsWith: ['startsWith'],
          }],
          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',
        }],
      },
    },
    resourceType: 'resourceType',
    selectionCriteria: 'selectionCriteria',
    telemetrySourceTypes: ['telemetrySourceTypes'],
    telemetryType: 'telemetryType',
  },
  ruleName: 'ruleName',
  tags: [{
    key: 'key',
    value: 'value',
  }],
}, /* all optional props */ {
  strategy: mixins.PropertyMergeStrategy.OVERRIDE,
});

Initializer

new CfnTelemetryRulePropsMixin(props: CfnTelemetryRuleMixinProps, options?: CfnPropertyMixinOptions)

Parameters

• props CfnTelemetryRuleMixinProps — L1 properties to apply.
• options CfnPropertyMixinOptions — Mixin options.

Create a mixin to apply properties to AWS::ObservabilityAdmin::TelemetryRule.

Properties

Name	Type	Description
props	CfnTelemetryRuleMixinProps
strategy	PropertyMergeStrategy
static CFN_PROPERTY_KEYS	string[]

---

props

Type: CfnTelemetryRuleMixinProps

---

strategy

Type: PropertyMergeStrategy

---

static CFN_PROPERTY_KEYS

Type: string[]

Methods

Name	Description
applyTo(construct)	Apply the mixin properties to the construct.
supports(construct)	Check if this mixin supports the given construct.

---

applyTo(construct)

public applyTo(construct: IConstruct): IConstruct

Parameters

• construct IConstruct

Returns

• IConstruct

Apply the mixin properties to the construct.

---

supports(construct)

public supports(construct: IConstruct): boolean

Parameters

• construct IConstruct

Returns

• boolean

Check if this mixin supports the given construct.