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(value="software.amazon.awssdk:codegen")
public final class ConfigSnapshotDeliveryProperties
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ConfigSnapshotDeliveryProperties.Builder,ConfigSnapshotDeliveryProperties>

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 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.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ConfigSnapshotDeliveryProperties.Builder

Method Summary

Modifier and Type	Method and Description
static ConfigSnapshotDeliveryProperties.Builder	builder()
MaximumExecutionFrequency	deliveryFrequency() The frequency with which AWS Config delivers configuration snapshots.
String	deliveryFrequencyAsString() The frequency with which AWS Config delivers configuration snapshots.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
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.
String	toString()

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 Detail

deliveryFrequency

public MaximumExecutionFrequency deliveryFrequency()

The frequency with which AWS 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 AWS Config delivers configuration snapshots.

See Also:

MaximumExecutionFrequency

deliveryFrequencyAsString

public String deliveryFrequencyAsString()

The frequency with which AWS 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 AWS 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 int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

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

sdkFields

public 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.