libZSservicesZSamazonka-configZSamazonka-config
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.Config.Types.ConfigSnapshotDeliveryProperties

Description

 
Synopsis

Documentation

data ConfigSnapshotDeliveryProperties Source #

Provides options for how often 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 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 Config delivers configuration snapshots. This value also sets how often Config invokes evaluations for Config rules.
  • The value for the MaximumExecutionFrequency parameter, which sets the maximum frequency with which 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, Config invokes the rule only as often as the deliveryFrequency value.

  1. For example, you want your rule to run evaluations when 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, 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 Config delivers your configuration snapshots, use the PutDeliveryChannel action.

See: newConfigSnapshotDeliveryProperties smart constructor.

Constructors

ConfigSnapshotDeliveryProperties' 

Fields

Instances

Instances details
Eq ConfigSnapshotDeliveryProperties Source # 
Instance details

Defined in Amazonka.Config.Types.ConfigSnapshotDeliveryProperties

Read ConfigSnapshotDeliveryProperties Source # 
Instance details

Defined in Amazonka.Config.Types.ConfigSnapshotDeliveryProperties

Show ConfigSnapshotDeliveryProperties Source # 
Instance details

Defined in Amazonka.Config.Types.ConfigSnapshotDeliveryProperties

Generic ConfigSnapshotDeliveryProperties Source # 
Instance details

Defined in Amazonka.Config.Types.ConfigSnapshotDeliveryProperties

Associated Types

type Rep ConfigSnapshotDeliveryProperties :: Type -> Type #

NFData ConfigSnapshotDeliveryProperties Source # 
Instance details

Defined in Amazonka.Config.Types.ConfigSnapshotDeliveryProperties

Hashable ConfigSnapshotDeliveryProperties Source # 
Instance details

Defined in Amazonka.Config.Types.ConfigSnapshotDeliveryProperties

ToJSON ConfigSnapshotDeliveryProperties Source # 
Instance details

Defined in Amazonka.Config.Types.ConfigSnapshotDeliveryProperties

FromJSON ConfigSnapshotDeliveryProperties Source # 
Instance details

Defined in Amazonka.Config.Types.ConfigSnapshotDeliveryProperties

type Rep ConfigSnapshotDeliveryProperties Source # 
Instance details

Defined in Amazonka.Config.Types.ConfigSnapshotDeliveryProperties

type Rep ConfigSnapshotDeliveryProperties = D1 ('MetaData "ConfigSnapshotDeliveryProperties" "Amazonka.Config.Types.ConfigSnapshotDeliveryProperties" "libZSservicesZSamazonka-configZSamazonka-config" 'False) (C1 ('MetaCons "ConfigSnapshotDeliveryProperties'" 'PrefixI 'True) (S1 ('MetaSel ('Just "deliveryFrequency") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MaximumExecutionFrequency))))

newConfigSnapshotDeliveryProperties :: ConfigSnapshotDeliveryProperties Source #

Create a value of ConfigSnapshotDeliveryProperties with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:deliveryFrequency:ConfigSnapshotDeliveryProperties', configSnapshotDeliveryProperties_deliveryFrequency - The frequency with which Config delivers configuration snapshots.