Class CfnDeliveryChannelPropsMixin
Specifies a delivery channel object to deliver configuration information to an Amazon S3 bucket and Amazon topic.
Implements
Inherited Members
Namespace: Amazon.CDK.CfnPropertyMixins.AWS.Config
Assembly: Amazon.CDK.CfnPropertyMixins.dll
Syntax (csharp)
public class CfnDeliveryChannelPropsMixin : Mixin, IMixin
Syntax (vb)
Public Class CfnDeliveryChannelPropsMixin Inherits Mixin Implements IMixin
Remarks
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 <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lock-overview.html">How S3 Object Lock works</a> .
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 <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-configurationrecorder.html">AWS::Config::ConfigurationRecorder</a> .
For more information, see Managing the Delivery Channel in the AWS Config Developer Guide.
CloudformationResource: AWS::Config::DeliveryChannel
Mixin: true
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.CfnPropertyMixins.AWS.Config;
using Amazon.CDK;
IMergeStrategy mergeStrategy;
var cfnDeliveryChannelPropsMixin = new CfnDeliveryChannelPropsMixin(new CfnDeliveryChannelMixinProps {
ConfigSnapshotDeliveryProperties = new ConfigSnapshotDeliveryPropertiesProperty {
DeliveryFrequency = "deliveryFrequency"
},
Name = "name",
S3BucketName = "s3BucketName",
S3KeyPrefix = "s3KeyPrefix",
S3KmsKeyArn = "s3KmsKeyArn",
SnsTopicArn = "snsTopicArn"
}, new CfnPropertyMixinOptions {
Strategy = mergeStrategy
});
Synopsis
Constructors
| CfnDeliveryChannelPropsMixin(ICfnDeliveryChannelMixinProps, ICfnPropertyMixinOptions?) | Create a mixin to apply properties to |
Properties
| CFN_PROPERTY_KEYS | Specifies a delivery channel object to deliver configuration information to an Amazon S3 bucket and Amazon topic. |
| Props | Specifies a delivery channel object to deliver configuration information to an Amazon S3 bucket and Amazon topic. |
| Strategy | Specifies a delivery channel object to deliver configuration information to an Amazon S3 bucket and Amazon topic. |
Methods
| ApplyTo(IConstruct) | Apply the mixin properties to the construct. |
| Supports(IConstruct) | Check if this mixin supports the given construct. |
Constructors
CfnDeliveryChannelPropsMixin(ICfnDeliveryChannelMixinProps, ICfnPropertyMixinOptions?)
Create a mixin to apply properties to AWS::Config::DeliveryChannel.
public CfnDeliveryChannelPropsMixin(ICfnDeliveryChannelMixinProps props, ICfnPropertyMixinOptions? options = null)
Parameters
- props ICfnDeliveryChannelMixinProps
L1 properties to apply.
- options ICfnPropertyMixinOptions
Mixin options.
Remarks
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 <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lock-overview.html">How S3 Object Lock works</a> .
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 <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-configurationrecorder.html">AWS::Config::ConfigurationRecorder</a> .
For more information, see Managing the Delivery Channel in the AWS Config Developer Guide.
CloudformationResource: AWS::Config::DeliveryChannel
Mixin: true
ExampleMetadata: fixture=_generated
Properties
CFN_PROPERTY_KEYS
Specifies a delivery channel object to deliver configuration information to an Amazon S3 bucket and Amazon topic.
protected static string[] CFN_PROPERTY_KEYS { get; }
Property Value
string[]
Remarks
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 <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lock-overview.html">How S3 Object Lock works</a> .
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 <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-configurationrecorder.html">AWS::Config::ConfigurationRecorder</a> .
For more information, see Managing the Delivery Channel in the AWS Config Developer Guide.
CloudformationResource: AWS::Config::DeliveryChannel
Mixin: true
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.CfnPropertyMixins.AWS.Config;
using Amazon.CDK;
IMergeStrategy mergeStrategy;
var cfnDeliveryChannelPropsMixin = new CfnDeliveryChannelPropsMixin(new CfnDeliveryChannelMixinProps {
ConfigSnapshotDeliveryProperties = new ConfigSnapshotDeliveryPropertiesProperty {
DeliveryFrequency = "deliveryFrequency"
},
Name = "name",
S3BucketName = "s3BucketName",
S3KeyPrefix = "s3KeyPrefix",
S3KmsKeyArn = "s3KmsKeyArn",
SnsTopicArn = "snsTopicArn"
}, new CfnPropertyMixinOptions {
Strategy = mergeStrategy
});
Props
Specifies a delivery channel object to deliver configuration information to an Amazon S3 bucket and Amazon topic.
protected virtual ICfnDeliveryChannelMixinProps Props { get; }
Property Value
Remarks
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 <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lock-overview.html">How S3 Object Lock works</a> .
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 <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-configurationrecorder.html">AWS::Config::ConfigurationRecorder</a> .
For more information, see Managing the Delivery Channel in the AWS Config Developer Guide.
CloudformationResource: AWS::Config::DeliveryChannel
Mixin: true
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.CfnPropertyMixins.AWS.Config;
using Amazon.CDK;
IMergeStrategy mergeStrategy;
var cfnDeliveryChannelPropsMixin = new CfnDeliveryChannelPropsMixin(new CfnDeliveryChannelMixinProps {
ConfigSnapshotDeliveryProperties = new ConfigSnapshotDeliveryPropertiesProperty {
DeliveryFrequency = "deliveryFrequency"
},
Name = "name",
S3BucketName = "s3BucketName",
S3KeyPrefix = "s3KeyPrefix",
S3KmsKeyArn = "s3KmsKeyArn",
SnsTopicArn = "snsTopicArn"
}, new CfnPropertyMixinOptions {
Strategy = mergeStrategy
});
Strategy
Specifies a delivery channel object to deliver configuration information to an Amazon S3 bucket and Amazon topic.
protected virtual IMergeStrategy Strategy { get; }
Property Value
Remarks
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 <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lock-overview.html">How S3 Object Lock works</a> .
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 <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-configurationrecorder.html">AWS::Config::ConfigurationRecorder</a> .
For more information, see Managing the Delivery Channel in the AWS Config Developer Guide.
CloudformationResource: AWS::Config::DeliveryChannel
Mixin: true
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.CfnPropertyMixins.AWS.Config;
using Amazon.CDK;
IMergeStrategy mergeStrategy;
var cfnDeliveryChannelPropsMixin = new CfnDeliveryChannelPropsMixin(new CfnDeliveryChannelMixinProps {
ConfigSnapshotDeliveryProperties = new ConfigSnapshotDeliveryPropertiesProperty {
DeliveryFrequency = "deliveryFrequency"
},
Name = "name",
S3BucketName = "s3BucketName",
S3KeyPrefix = "s3KeyPrefix",
S3KmsKeyArn = "s3KmsKeyArn",
SnsTopicArn = "snsTopicArn"
}, new CfnPropertyMixinOptions {
Strategy = mergeStrategy
});
Methods
ApplyTo(IConstruct)
Apply the mixin properties to the construct.
public override void ApplyTo(IConstruct construct)
Parameters
- construct IConstruct
Overrides
Remarks
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 <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lock-overview.html">How S3 Object Lock works</a> .
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 <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-configurationrecorder.html">AWS::Config::ConfigurationRecorder</a> .
For more information, see Managing the Delivery Channel in the AWS Config Developer Guide.
CloudformationResource: AWS::Config::DeliveryChannel
Mixin: true
ExampleMetadata: fixture=_generated
Supports(IConstruct)
Check if this mixin supports the given construct.
public override bool Supports(IConstruct construct)
Parameters
- construct IConstruct
Returns
Overrides
Remarks
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 <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lock-overview.html">How S3 Object Lock works</a> .
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 <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-configurationrecorder.html">AWS::Config::ConfigurationRecorder</a> .
For more information, see Managing the Delivery Channel in the AWS Config Developer Guide.
CloudformationResource: AWS::Config::DeliveryChannel
Mixin: true
ExampleMetadata: fixture=_generated