AWS CDK Reference

Appearance

v2.275.0

CfnDeliveryChannelProps Struct ​

Properties for defining a CfnDeliveryChannel.

Source
Generated code

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_config as config } from 'aws-cdk-lib';
const cfnDeliveryChannelProps: config.CfnDeliveryChannelProps = {
  s3BucketName: 's3BucketName',

  // the properties below are optional
  configSnapshotDeliveryProperties: {
    deliveryFrequency: 'deliveryFrequency',
  },
  name: 'name',
  s3KeyPrefix: 's3KeyPrefix',
  s3KmsKeyArn: 's3KmsKeyArn',
  snsTopicArn: 'snsTopicArn',
};

Properties ​

configSnapshotDeliveryPropertiesoptionalIResolvable | CfnDeliveryChannel.ConfigSnapshotDeliveryPropertiesPropertyconfig_snapshot_delivery_propertiesoptionaltyping.Union[IResolvable, ConfigSnapshotDeliveryPropertiesProperty]configSnapshotDeliveryPropertiesoptionalIResolvableConfigSnapshotDeliveryPropertiesoptionalIResolvableConfigSnapshotDeliveryPropertiesoptionalinterface{}#
The options for how often AWS Config delivers configuration snapshots to the Amazon S3 bucket.
nameoptionalstringnameoptionalstrnameoptionalStringNameoptionalstringNameoptional*string#
A name for the delivery channel.
notes

If you don't specify a name, CloudFormation generates a unique physical ID and uses that ID for the delivery channel name. For more information, see Name Type .

Updates are not supported. To change the name, you must run two separate updates. In the first update, delete this resource, and then recreate it with a new name in the second update.

s3BucketNamestrings3_bucket_namestrs3BucketNameStringS3BucketNamestringS3BucketName*stringrequired#
The name of the Amazon S3 bucket to which AWS Config delivers configuration snapshots and configuration history files.
notes

If you specify a bucket that belongs to another AWS account , that bucket must have policies that grant access permissions to AWS Config . For more information, see Permissions for the Amazon S3 Bucket in the AWS Config Developer Guide .

s3KeyPrefixoptionalstrings3_key_prefixoptionalstrs3KeyPrefixoptionalStringS3KeyPrefixoptionalstringS3KeyPrefixoptional*string#
The prefix for the specified Amazon S3 bucket.
s3KmsKeyArnoptionalstrings3_kms_key_arnoptionalstrs3KmsKeyArnoptionalStringS3KmsKeyArnoptionalstringS3KmsKeyArnoptional*string#
The Amazon Resource Name (ARN) of the AWS Key Management Service ( AWS ) AWS KMS key (KMS key) used to encrypt objects delivered by AWS Config .

Must belong to the same Region as the destination S3 bucket.

snsTopicArnoptionalstringsns_topic_arnoptionalstrsnsTopicArnoptionalStringSnsTopicArnoptionalstringSnsTopicArnoptional*string#
The Amazon Resource Name (ARN) of the Amazon SNS topic to which AWS Config sends notifications about configuration changes.
notes

If you choose a topic from another account, the topic must have policies that grant access permissions to AWS Config . For more information, see Permissions for the Amazon SNS Topic in the AWS Config Developer Guide .