Class: Aws::ConfigService::Types::ConfigSnapshotDeliveryProperties

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-configservice/types.rb

Overview

Note:

When making an API call, you may pass ConfigSnapshotDeliveryProperties data as a hash:

{
  delivery_frequency: "One_Hour", # accepts One_Hour, Three_Hours, Six_Hours, Twelve_Hours, TwentyFour_Hours
}

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

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.

  1. For example, you want your rule to run evaluations when AWS 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`, 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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#delivery_frequencyString

The frequency with which AWS Config delivers configuration snapshots.

Returns:

  • (String)


1239
1240
1241
1242
1243
# File 'lib/aws-sdk-configservice/types.rb', line 1239

class ConfigSnapshotDeliveryProperties < Struct.new(
  :delivery_frequency)
  SENSITIVE = []
  include Aws::Structure
end