AWS::Config::DeliveryChannel ConfigSnapshotDeliveryProperties - Amazon CloudFormation
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

AWS::Config::DeliveryChannel ConfigSnapshotDeliveryProperties

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

Note

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

The frequency for a rule that triggers evaluations for your resources when Amazon 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 Amazon Config delivers configuration snapshots. This value also sets how often Amazon Config invokes evaluations for Amazon Config rules.

  • The value for the MaximumExecutionFrequency parameter, which sets the maximum frequency with which Amazon 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, Amazon Config invokes the rule only as often as the deliveryFrequency value.

  1. For example, you want your rule to run evaluations when Amazon Config delivers the configuration snapshot.

  2. You specify the MaximumExecutionFrequency value for Six_Hours.

  3. You then specify the delivery channel deliveryFrequency value for TwentyFour_Hours.

  4. Because the value for deliveryFrequency is less frequent than MaximumExecutionFrequency, Amazon 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 Amazon Config delivers your configuration snapshots, use the PutDeliveryChannel action.

Syntax

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

JSON

{ "DeliveryFrequency" : String }

YAML

DeliveryFrequency: String

Properties

DeliveryFrequency

The frequency with which Amazon Config delivers configuration snapshots.

Required: No

Type: String

Allowed values: One_Hour | Three_Hours | Six_Hours | Twelve_Hours | TwentyFour_Hours

Update requires: No interruption