Class CfnDeliveryChannel
A CloudFormation AWS::Config::DeliveryChannel
.
Inherited Members
Namespace: Amazon.CDK.AWS.Config
Assembly: Amazon.CDK.AWS.Config.dll
Syntax (csharp)
public class CfnDeliveryChannel : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnDeliveryChannel
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
Specifies a delivery channel object to deliver configuration information to an Amazon S3 bucket and Amazon SNS 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 SNS topic of the existing delivery channel. To change the Amazon S3 bucket or an Amazon SNS 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 SNS 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.
CloudformationResource: AWS::Config::DeliveryChannel
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Config;
var cfnDeliveryChannel = new CfnDeliveryChannel(this, "MyCfnDeliveryChannel", new CfnDeliveryChannelProps {
S3BucketName = "s3BucketName",
// the properties below are optional
ConfigSnapshotDeliveryProperties = new ConfigSnapshotDeliveryPropertiesProperty {
DeliveryFrequency = "deliveryFrequency"
},
Name = "name",
S3KeyPrefix = "s3KeyPrefix",
S3KmsKeyArn = "s3KmsKeyArn",
SnsTopicArn = "snsTopicArn"
});
Synopsis
Constructors
CfnDeliveryChannel(Construct, String, ICfnDeliveryChannelProps) | Create a new |
CfnDeliveryChannel(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnDeliveryChannel(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
ConfigSnapshotDeliveryProperties | The options for how often AWS Config delivers configuration snapshots to the Amazon S3 bucket. |
Name | A name for the delivery channel. |
S3BucketName | The name of the Amazon S3 bucket to which AWS Config delivers configuration snapshots and configuration history files. |
S3KeyPrefix | The prefix for the specified Amazon S3 bucket. |
S3KmsKeyArn | 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 . |
SnsTopicArn | The Amazon Resource Name (ARN) of the Amazon SNS topic to which AWS Config sends notifications about configuration changes. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnDeliveryChannel(Construct, String, ICfnDeliveryChannelProps)
Create a new AWS::Config::DeliveryChannel
.
public CfnDeliveryChannel(Construct scope, string id, ICfnDeliveryChannelProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnDeliveryChannelProps
- resource properties.
CfnDeliveryChannel(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnDeliveryChannel(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnDeliveryChannel(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnDeliveryChannel(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
ConfigSnapshotDeliveryProperties
The options for how often AWS Config delivers configuration snapshots to the Amazon S3 bucket.
public virtual object ConfigSnapshotDeliveryProperties { get; set; }
Property Value
System.Object
Remarks
Name
A name for the delivery channel.
public virtual string Name { get; set; }
Property Value
System.String
Remarks
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.
S3BucketName
The name of the Amazon S3 bucket to which AWS Config delivers configuration snapshots and configuration history files.
public virtual string S3BucketName { get; set; }
Property Value
System.String
Remarks
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 .
S3KeyPrefix
The prefix for the specified Amazon S3 bucket.
public virtual string S3KeyPrefix { get; set; }
Property Value
System.String
Remarks
S3KmsKeyArn
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 .
public virtual string S3KmsKeyArn { get; set; }
Property Value
System.String
Remarks
Must belong to the same Region as the destination S3 bucket.
SnsTopicArn
The Amazon Resource Name (ARN) of the Amazon SNS topic to which AWS Config sends notifications about configuration changes.
public virtual string SnsTopicArn { get; set; }
Property Value
System.String
Remarks
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 .
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
- tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>