software.amazon.awssdk.services.config.model

Class SourceDetail

java.lang.Object

software.amazon.awssdk.services.config.model.SourceDetail

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<SourceDetail.Builder,SourceDetail>

@Generated(value="software.amazon.awssdk:codegen")
public final class SourceDetail
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<SourceDetail.Builder,SourceDetail>

Provides the source and the message types that trigger AWS Config to evaluate your AWS resources against a rule. It also provides the frequency with which you want AWS Config to run evaluations for the rule if the trigger type is periodic. You can specify the parameter values for SourceDetail only for custom rules.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SourceDetail.Builder

Method Summary

Modifier and Type	Method and Description
static SourceDetail.Builder	builder()
boolean	equals(Object obj)
EventSource	eventSource() The source of the event, such as an AWS service, that triggers AWS Config to evaluate your AWS resources.
String	eventSourceAsString() The source of the event, such as an AWS service, that triggers AWS Config to evaluate your AWS resources.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
MaximumExecutionFrequency	maximumExecutionFrequency() The frequency at which you want AWS Config to run evaluations for a custom rule with a periodic trigger.
String	maximumExecutionFrequencyAsString() The frequency at which you want AWS Config to run evaluations for a custom rule with a periodic trigger.
MessageType	messageType() The type of notification that triggers AWS Config to run an evaluation for a rule.
String	messageTypeAsString() The type of notification that triggers AWS Config to run an evaluation for a rule.
List<SdkField<?>>	sdkFields()
static Class<? extends SourceDetail.Builder>	serializableBuilderClass()
SourceDetail.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

eventSource

public EventSource eventSource()

The source of the event, such as an AWS service, that triggers AWS Config to evaluate your AWS resources.

If the service returns an enum value that is not available in the current SDK version, eventSource will return EventSource.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from eventSourceAsString().

Returns:

The source of the event, such as an AWS service, that triggers AWS Config to evaluate your AWS resources.

See Also:

EventSource

eventSourceAsString

public String eventSourceAsString()

The source of the event, such as an AWS service, that triggers AWS Config to evaluate your AWS resources.

If the service returns an enum value that is not available in the current SDK version, eventSource will return EventSource.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from eventSourceAsString().

Returns:

The source of the event, such as an AWS service, that triggers AWS Config to evaluate your AWS resources.

See Also:

EventSource

messageType

public MessageType messageType()

The type of notification that triggers AWS Config to run an evaluation for a rule. You can specify the following notification types:

• ConfigurationItemChangeNotification - Triggers an evaluation when AWS Config delivers a configuration item as a result of a resource change.

• OversizedConfigurationItemChangeNotification - Triggers an evaluation when AWS Config delivers an oversized configuration item. AWS Config may generate this notification type when a resource changes and the notification exceeds the maximum size allowed by Amazon SNS.

• ScheduledNotification - Triggers a periodic evaluation at the frequency specified for MaximumExecutionFrequency.

• ConfigurationSnapshotDeliveryCompleted - Triggers a periodic evaluation when AWS Config delivers a configuration snapshot.

If you want your custom rule to be triggered by configuration changes, specify two SourceDetail objects, one for ConfigurationItemChangeNotification and one for OversizedConfigurationItemChangeNotification.

If the service returns an enum value that is not available in the current SDK version, messageType will return MessageType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from messageTypeAsString().

Returns:

The type of notification that triggers AWS Config to run an evaluation for a rule. You can specify the following notification types:

• ConfigurationItemChangeNotification - Triggers an evaluation when AWS Config delivers a configuration item as a result of a resource change.

• OversizedConfigurationItemChangeNotification - Triggers an evaluation when AWS Config delivers an oversized configuration item. AWS Config may generate this notification type when a resource changes and the notification exceeds the maximum size allowed by Amazon SNS.

• ScheduledNotification - Triggers a periodic evaluation at the frequency specified for MaximumExecutionFrequency.

• ConfigurationSnapshotDeliveryCompleted - Triggers a periodic evaluation when AWS Config delivers a configuration snapshot.

If you want your custom rule to be triggered by configuration changes, specify two SourceDetail objects, one for ConfigurationItemChangeNotification and one for OversizedConfigurationItemChangeNotification.

See Also:

MessageType

messageTypeAsString

public String messageTypeAsString()

The type of notification that triggers AWS Config to run an evaluation for a rule. You can specify the following notification types:

• ConfigurationItemChangeNotification - Triggers an evaluation when AWS Config delivers a configuration item as a result of a resource change.

• OversizedConfigurationItemChangeNotification - Triggers an evaluation when AWS Config delivers an oversized configuration item. AWS Config may generate this notification type when a resource changes and the notification exceeds the maximum size allowed by Amazon SNS.

• ScheduledNotification - Triggers a periodic evaluation at the frequency specified for MaximumExecutionFrequency.

• ConfigurationSnapshotDeliveryCompleted - Triggers a periodic evaluation when AWS Config delivers a configuration snapshot.

If you want your custom rule to be triggered by configuration changes, specify two SourceDetail objects, one for ConfigurationItemChangeNotification and one for OversizedConfigurationItemChangeNotification.

If the service returns an enum value that is not available in the current SDK version, messageType will return MessageType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from messageTypeAsString().

Returns:

The type of notification that triggers AWS Config to run an evaluation for a rule. You can specify the following notification types:

• ConfigurationItemChangeNotification - Triggers an evaluation when AWS Config delivers a configuration item as a result of a resource change.

• OversizedConfigurationItemChangeNotification - Triggers an evaluation when AWS Config delivers an oversized configuration item. AWS Config may generate this notification type when a resource changes and the notification exceeds the maximum size allowed by Amazon SNS.

• ScheduledNotification - Triggers a periodic evaluation at the frequency specified for MaximumExecutionFrequency.

• ConfigurationSnapshotDeliveryCompleted - Triggers a periodic evaluation when AWS Config delivers a configuration snapshot.

If you want your custom rule to be triggered by configuration changes, specify two SourceDetail objects, one for ConfigurationItemChangeNotification and one for OversizedConfigurationItemChangeNotification.

See Also:

MessageType

maximumExecutionFrequency

public MaximumExecutionFrequency maximumExecutionFrequency()

The frequency at which you want AWS Config to run evaluations for a custom rule with a periodic trigger. If you specify a value for MaximumExecutionFrequency, then MessageType must use the ScheduledNotification value.

By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a valid value for the MaximumExecutionFrequency parameter.

Based on the valid value you choose, AWS Config runs evaluations once for each valid value. For example, if you choose Three_Hours, AWS Config runs evaluations once every three hours. In this case, Three_Hours is the frequency of this rule.

If the service returns an enum value that is not available in the current SDK version, maximumExecutionFrequency will return MaximumExecutionFrequency.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from maximumExecutionFrequencyAsString().

Returns:

The frequency at which you want AWS Config to run evaluations for a custom rule with a periodic trigger. If you specify a value for MaximumExecutionFrequency, then MessageType must use the ScheduledNotification value.

By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a valid value for the MaximumExecutionFrequency parameter.

Based on the valid value you choose, AWS Config runs evaluations once for each valid value. For example, if you choose Three_Hours, AWS Config runs evaluations once every three hours. In this case, Three_Hours is the frequency of this rule.

See Also:

MaximumExecutionFrequency

maximumExecutionFrequencyAsString

public String maximumExecutionFrequencyAsString()

The frequency at which you want AWS Config to run evaluations for a custom rule with a periodic trigger. If you specify a value for MaximumExecutionFrequency, then MessageType must use the ScheduledNotification value.

By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a valid value for the MaximumExecutionFrequency parameter.

Based on the valid value you choose, AWS Config runs evaluations once for each valid value. For example, if you choose Three_Hours, AWS Config runs evaluations once every three hours. In this case, Three_Hours is the frequency of this rule.

If the service returns an enum value that is not available in the current SDK version, maximumExecutionFrequency will return MaximumExecutionFrequency.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from maximumExecutionFrequencyAsString().

Returns:

The frequency at which you want AWS Config to run evaluations for a custom rule with a periodic trigger. If you specify a value for MaximumExecutionFrequency, then MessageType must use the ScheduledNotification value.

By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a valid value for the MaximumExecutionFrequency parameter.

Based on the valid value you choose, AWS Config runs evaluations once for each valid value. For example, if you choose Three_Hours, AWS Config runs evaluations once every three hours. In this case, Three_Hours is the frequency of this rule.

See Also:

MaximumExecutionFrequency

toBuilder

public SourceDetail.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<SourceDetail.Builder,SourceDetail>

Returns:

a builder for type T

builder

public static SourceDetail.Builder builder()

serializableBuilderClass

public static Class<? extends SourceDetail.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.