Package software.amazon.awssdk.services.config.model

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 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 Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ConfigSnapshotDeliveryProperties.Builder

Method Summary

Modifier and Type	Method	Description
static ConfigSnapshotDeliveryProperties.Builder	builder()
final MaximumExecutionFrequency	deliveryFrequency()	The frequency with which Config delivers configuration snapshots.
final String	deliveryFrequencyAsString()	The frequency with which Config delivers configuration snapshots.
final boolean	equals(Object obj)
final boolean	equalsBySdkFields(Object obj)	Indicates whether some other object is "equal to" this one by SDK fields.
final <T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
final int	hashCode()
final List<SdkField<?>>	sdkFields()
static Class<? extends ConfigSnapshotDeliveryProperties.Builder>	serializableBuilderClass()
ConfigSnapshotDeliveryProperties.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
final String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Details

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, deliveryFrequency will return MaximumExecutionFrequency.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from deliveryFrequencyAsString().

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, deliveryFrequency will return MaximumExecutionFrequency.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from deliveryFrequencyAsString().

Returns:

The frequency with which Config delivers configuration snapshots.

See Also:

• MaximumExecutionFrequency

toBuilder

public ConfigSnapshotDeliveryProperties.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<ConfigSnapshotDeliveryProperties.Builder,ConfigSnapshotDeliveryProperties>

Returns:

a builder for type T

builder

public static ConfigSnapshotDeliveryProperties.Builder builder()

serializableBuilderClass

public static Class<? extends ConfigSnapshotDeliveryProperties.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Description copied from interface: SdkPojo

Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

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.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
 Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.