Menu
AWS CloudFormation
User Guide (API Version 2010-05-15)

AWS::Config::DeliveryChannel

The AWS::Config::DeliveryChannel resource describes where AWS Config stores configuration changes to an AWS resource.

Note

If you create this resource, you must also create or have an AWS::Config::ConfigurationRecorder resource already running in your account. These two interdependent resources must be present to successfully create both resources.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

Copy
{ "Type" : "AWS::Config::DeliveryChannel", "Properties" : { "ConfigSnapshotDeliveryProperties" : Config snapshot delivery properties, "Name" : String, "S3BucketName" : String, "S3KeyPrefix" : String, "SnsTopicARN" : String } }

YAML

Copy
Type: "AWS::Config::DeliveryChannel" Properties: ConfigSnapshotDeliveryProperties: Config snapshot delivery properties Name: String S3BucketName: String S3KeyPrefix: String SnsTopicARN: String

Properties

ConfigSnapshotDeliveryProperties

Provides options for how AWS Config delivers configuration snapshots to the S3 bucket in your delivery channel.

Required: No

Type: AWS Config DeliveryChannel ConfigSnapshotDeliveryProperties

Update requires: No interruption

Name

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.

Required: No

Type: String

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

S3BucketName

The name of an S3 bucket where you want to store configuration history for the delivery channel.

Required: Yes

Type: String

Update requires: No interruption

S3KeyPrefix

A key prefix (folder) for the specified S3 bucket.

Required: No

Type: String

Update requires: No interruption

SnsTopicARN

The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (Amazon SNS) topic that AWS Config delivers notifications to.

Required: No

Type: String

Update requires: No interruption

Return Values

Ref

When you pass the logical ID of an AWS::Config::DeliveryChannel resource to the intrinsic Ref function, the function returns the delivery channel name, such as default.

For more information about using the Ref function, see Ref.

Example

The following example creates a delivery channel that sends notifications to the specified Amazon SNS topic. The delivery channel also sends configuration changes and snapshots to the specified S3 bucket.

JSON

Copy
"DeliveryChannel": { "Type": "AWS::Config::DeliveryChannel", "Properties": { "ConfigSnapshotDeliveryProperties": { "DeliveryFrequency": "Six_Hours" }, "S3BucketName": {"Ref": "ConfigBucket"}, "SnsTopicARN": {"Ref": "ConfigTopic"} } }

YAML

Copy
DeliveryChannel: Type: "AWS::Config::DeliveryChannel" Properties: ConfigSnapshotDeliveryProperties: DeliveryFrequency: "Six_Hours" S3BucketName: Ref: ConfigBucket SnsTopicARN: Ref: ConfigTopic