class CfnDeliveryChannelPropsMixin

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.Config.Mixins.CfnDeliveryChannelPropsMixin
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsconfig/mixins#CfnDeliveryChannelPropsMixin
Java	software.amazon.awscdk.mixins.preview.services.config.mixins.CfnDeliveryChannelPropsMixin
Python	aws_cdk.mixins_preview.aws_config.mixins.CfnDeliveryChannelPropsMixin
TypeScript	@aws-cdk/mixins-preview » aws_config » mixins » CfnDeliveryChannelPropsMixin

Implements IMixin

Extends Mixin

Specifies a delivery channel object to deliver configuration information to an Amazon S3 bucket and Amazon topic.

Before you can create a delivery channel, you must create a configuration recorder. You can use this action to change the Amazon S3 bucket or an Amazon topic of the existing delivery channel. To change the Amazon S3 bucket or an Amazon topic, call this action and specify the changed values for the S3 bucket and the SNS topic. If you specify a different value for either the S3 bucket or the SNS topic, this action will keep the existing value for the parameter that is not changed.

In the China (Beijing) Region, when you call this action, the Amazon S3 bucket must also be in the China (Beijing) Region. In all the other regions, AWS Config supports cross-region and cross-account delivery channels.

You can have only one delivery channel per region per AWS account, and the delivery channel is required to use AWS Config .

AWS Config does not support the delivery channel to an Amazon S3 bucket bucket where object lock is enabled. For more information, see How S3 Object Lock works .

When you create the delivery channel, you can specify; how often AWS Config delivers configuration snapshots to your Amazon S3 bucket (for example, 24 hours), the S3 bucket to which AWS Config sends configuration snapshots and configuration history files, and the Amazon topic to which AWS Config sends notifications about configuration changes, such as updated resources, AWS Config rule evaluations, and when AWS Config delivers the configuration snapshot to your S3 bucket. For more information, see Deliver Configuration Items in the AWS Config Developer Guide.

To enable AWS Config , you must create a configuration recorder and a delivery channel. If you want to create the resources separately, you must create a configuration recorder before you can create a delivery channel. AWS Config uses the configuration recorder to capture configuration changes to your resources. For more information, see AWS::Config::ConfigurationRecorder .

For more information, see Managing the Delivery Channel in the AWS Config Developer Guide.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-deliverychannel.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 config_mixins } from '@aws-cdk/mixins-preview/aws-config';
const cfnDeliveryChannelPropsMixin = new config_mixins.CfnDeliveryChannelPropsMixin({
  configSnapshotDeliveryProperties: {
    deliveryFrequency: 'deliveryFrequency',
  },
  name: 'name',
  s3BucketName: 's3BucketName',
  s3KeyPrefix: 's3KeyPrefix',
  s3KmsKeyArn: 's3KmsKeyArn',
  snsTopicArn: 'snsTopicArn',
}, /* all optional props */ {
  strategy: mixins.PropertyMergeStrategy.OVERRIDE,
});

Initializer

new CfnDeliveryChannelPropsMixin(props: CfnDeliveryChannelMixinProps, options?: CfnPropertyMixinOptions)

Parameters

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

Create a mixin to apply properties to AWS::Config::DeliveryChannel.

Properties

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

---

props

Type: CfnDeliveryChannelMixinProps

---

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.