interface CfnDeliveryChannelProps
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.Config.CfnDeliveryChannelProps |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsconfig#CfnDeliveryChannelProps |
![]() | software.amazon.awscdk.services.config.CfnDeliveryChannelProps |
![]() | aws_cdk.aws_config.CfnDeliveryChannelProps |
![]() | aws-cdk-lib » aws_config » CfnDeliveryChannelProps |
Properties for defining a CfnDeliveryChannel
.
Example
// 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
Name | Type | Description |
---|---|---|
s3 | string | The name of the Amazon S3 bucket to which AWS Config delivers configuration snapshots and configuration history files. |
config | IResolvable | Config | The options for how often AWS Config delivers configuration snapshots to the Amazon S3 bucket. |
name? | string | A name for the delivery channel. |
s3 | string | The prefix for the specified Amazon S3 bucket. |
s3 | string | The Amazon Resource Name (ARN) of the AWS Key Management Service ( AWS KMS ) AWS KMS key (KMS key) used to encrypt objects delivered by AWS Config . |
sns | string | The Amazon Resource Name (ARN) of the Amazon SNS topic to which AWS Config sends notifications about configuration changes. |
s3BucketName
Type:
string
The name of the Amazon S3 bucket to which AWS Config delivers configuration snapshots and configuration history files.
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 .
configSnapshotDeliveryProperties?
Type:
IResolvable
|
Config
(optional)
The options for how often AWS Config delivers configuration snapshots to the Amazon S3 bucket.
name?
Type:
string
(optional)
A name for the delivery channel.
If you don't specify a name, AWS 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.
s3KeyPrefix?
Type:
string
(optional)
The prefix for the specified Amazon S3 bucket.
s3KmsKeyArn?
Type:
string
(optional)
The Amazon Resource Name (ARN) of the AWS Key Management Service ( AWS KMS ) AWS KMS key (KMS key) used to encrypt objects delivered by AWS Config .
Must belong to the same Region as the destination S3 bucket.
snsTopicArn?
Type:
string
(optional)
The Amazon Resource Name (ARN) of the Amazon SNS topic to which AWS Config sends notifications about configuration changes.
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 .