CfnDeliveryChannelPropsMixin

class aws_cdk.mixins_preview.aws_config.mixins.CfnDeliveryChannelPropsMixin(props, *, strategy=None)

Bases: Mixin

Specifies a delivery channel object to deliver configuration information to an Amazon S3 bucket and Amazon 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 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. .. epigraph:

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 . .. epigraph:

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 <https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lock-overview.html>`_ .

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. .. epigraph:

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 <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-configurationrecorder.html>`_ .

For more information, see Managing the Delivery Channel in the AWS Config Developer Guide.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-deliverychannel.html
CloudformationResource:: AWS::Config::DeliveryChannel
Mixin:: true
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_config import mixins as config_mixins

cfn_delivery_channel_props_mixin = config_mixins.CfnDeliveryChannelPropsMixin(config_mixins.CfnDeliveryChannelMixinProps(
    config_snapshot_delivery_properties=config_mixins.CfnDeliveryChannelPropsMixin.ConfigSnapshotDeliveryPropertiesProperty(
        delivery_frequency="deliveryFrequency"
    ),
    name="name",
    s3_bucket_name="s3BucketName",
    s3_key_prefix="s3KeyPrefix",
    s3_kms_key_arn="s3KmsKeyArn",
    sns_topic_arn="snsTopicArn"
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::Config::DeliveryChannel.

Parameters:

props (Union[CfnDeliveryChannelMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['configSnapshotDeliveryProperties', 'name', 's3BucketName', 's3KeyPrefix', 's3KmsKeyArn', 'snsTopicArn']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

ConfigSnapshotDeliveryPropertiesProperty

class CfnDeliveryChannelPropsMixin.ConfigSnapshotDeliveryPropertiesProperty(*, delivery_frequency=None)

Bases: object

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

If you want to create a rule that triggers evaluations for your resources when AWS Config delivers the configuration snapshot, see the following:

The frequency for a rule that triggers evaluations for your resources when AWS Config delivers the configuration snapshot is set by one of two values, depending on which is less frequent:

The value for the deliveryFrequency parameter within the delivery channel configuration, which sets how often AWS Config delivers configuration snapshots. This value also sets how often AWS Config invokes evaluations for AWS Config rules.
The value for the MaximumExecutionFrequency parameter, which sets the maximum frequency with which AWS Config invokes evaluations for the rule. For more information, see ConfigRule .

If the deliveryFrequency value is less frequent than the MaximumExecutionFrequency value for a rule, AWS Config invokes the rule only as often as the deliveryFrequency value.

For example, you want your rule to run evaluations when AWS Config delivers the configuration snapshot.
You specify the MaximumExecutionFrequency value for Six_Hours .
You then specify the delivery channel deliveryFrequency value for TwentyFour_Hours .
Because the value for deliveryFrequency is less frequent than MaximumExecutionFrequency , AWS Config invokes evaluations for the rule every 24 hours.

You should set the MaximumExecutionFrequency value to be at least as frequent as the deliveryFrequency value. You can view the deliveryFrequency value by using the DescribeDeliveryChannnels action.

To update the deliveryFrequency with which AWS Config delivers your configuration snapshots, use the PutDeliveryChannel action.

Parameters:: delivery_frequency (Optional[str]) – The frequency with which AWS Config delivers configuration snapshots.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-deliverychannel-configsnapshotdeliveryproperties.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_config import mixins as config_mixins

config_snapshot_delivery_properties_property = config_mixins.CfnDeliveryChannelPropsMixin.ConfigSnapshotDeliveryPropertiesProperty(
    delivery_frequency="deliveryFrequency"
)

Attributes

delivery_frequency

The frequency with which AWS Config delivers configuration snapshots.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-deliverychannel-configsnapshotdeliveryproperties.html#cfn-config-deliverychannel-configsnapshotdeliveryproperties-deliveryfrequency