Class: AWSCDK::Config::CfnDeliveryChannel::ConfigSnapshotDeliveryPropertiesProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
config/cfn_delivery_channel.rb

Overview

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 delivery_frequency 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 delivery_frequency value is less frequent than the MaximumExecutionFrequency value for a rule, AWS Config invokes the rule only as often as the delivery_frequency 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 delivery_frequency value for TwentyFour_Hours .
  • Because the value for delivery_frequency 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 delivery_frequency value. You can view the delivery_frequency value by using the DescribeDeliveryChannnels action.

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

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(delivery_frequency: nil) ⇒ ConfigSnapshotDeliveryPropertiesProperty

Returns a new instance of ConfigSnapshotDeliveryPropertiesProperty.

Parameters:

  • delivery_frequency (String, nil) (defaults to: nil) —

    The frequency with which AWS Config delivers configuration snapshots.



596
597
598
599
 
# File 'config/cfn_delivery_channel.rb', line 596

def initialize(delivery_frequency: nil)
  @delivery_frequency = delivery_frequency
  Jsii::Type.check_type(@delivery_frequency, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "deliveryFrequency") unless @delivery_frequency.nil?
end

Instance Attribute Details

#delivery_frequency ⇒ String? (readonly)

The frequency with which AWS Config delivers configuration snapshots.

Returns:

  • (String, nil)

See Also:



605
606
607
 
# File 'config/cfn_delivery_channel.rb', line 605

def delivery_frequency
  @delivery_frequency
end

Class Method Details

.jsii_properties ⇒ Object 



607
608
609
610
611
 
# File 'config/cfn_delivery_channel.rb', line 607

def self.jsii_properties
  {
    :delivery_frequency => "deliveryFrequency",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



613
614
615
616
617
618
619
 
# File 'config/cfn_delivery_channel.rb', line 613

def to_jsii
  result = {}
  result.merge!({
    "deliveryFrequency" => @delivery_frequency,
  })
  result.compact
end