Class ConfigSnapshotDeliveryProperties
- java.lang.Object
-
- software.amazon.awssdk.services.config.model.ConfigSnapshotDeliveryProperties
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<ConfigSnapshotDeliveryProperties.Builder,ConfigSnapshotDeliveryProperties>
@Generated("software.amazon.awssdk:codegen") public final class ConfigSnapshotDeliveryProperties extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ConfigSnapshotDeliveryProperties.Builder,ConfigSnapshotDeliveryProperties>
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
deliveryFrequencyparameter 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
MaximumExecutionFrequencyparameter, which sets the maximum frequency with which Config invokes evaluations for the rule. For more information, see ConfigRule.
If the
deliveryFrequencyvalue is less frequent than theMaximumExecutionFrequencyvalue for a rule, Config invokes the rule only as often as thedeliveryFrequencyvalue.-
For example, you want your rule to run evaluations when Config delivers the configuration snapshot.
-
You specify the
MaximumExecutionFrequencyvalue forSix_Hours. -
You then specify the delivery channel
deliveryFrequencyvalue forTwentyFour_Hours. -
Because the value for
deliveryFrequencyis less frequent thanMaximumExecutionFrequency, Config invokes evaluations for the rule every 24 hours.
You should set the
MaximumExecutionFrequencyvalue to be at least as frequent as thedeliveryFrequencyvalue. You can view thedeliveryFrequencyvalue by using theDescribeDeliveryChannnelsaction.To update the
deliveryFrequencywith which Config delivers your configuration snapshots, use thePutDeliveryChannelaction.- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceConfigSnapshotDeliveryProperties.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static ConfigSnapshotDeliveryProperties.Builderbuilder()MaximumExecutionFrequencydeliveryFrequency()The frequency with which Config delivers configuration snapshots.StringdeliveryFrequencyAsString()The frequency with which Config delivers configuration snapshots.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()List<SdkField<?>>sdkFields()static Class<? extends ConfigSnapshotDeliveryProperties.Builder>serializableBuilderClass()ConfigSnapshotDeliveryProperties.BuildertoBuilder()StringtoString()Returns a string representation of this object.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
deliveryFrequency
public final MaximumExecutionFrequency deliveryFrequency()
The frequency with which Config delivers configuration snapshots.
If the service returns an enum value that is not available in the current SDK version,
deliveryFrequencywill returnMaximumExecutionFrequency.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromdeliveryFrequencyAsString().- Returns:
- The frequency with which Config delivers configuration snapshots.
- See Also:
MaximumExecutionFrequency
-
deliveryFrequencyAsString
public final String deliveryFrequencyAsString()
The frequency with which Config delivers configuration snapshots.
If the service returns an enum value that is not available in the current SDK version,
deliveryFrequencywill returnMaximumExecutionFrequency.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromdeliveryFrequencyAsString().- Returns:
- The frequency with which Config delivers configuration snapshots.
- See Also:
MaximumExecutionFrequency
-
toBuilder
public ConfigSnapshotDeliveryProperties.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<ConfigSnapshotDeliveryProperties.Builder,ConfigSnapshotDeliveryProperties>
-
builder
public static ConfigSnapshotDeliveryProperties.Builder builder()
-
serializableBuilderClass
public static Class<? extends ConfigSnapshotDeliveryProperties.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
toString
public final String toString()
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
-
-