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

eventSource

public final EventSource eventSource()

The source of the event, such as an Amazon Web Services service, that triggers Config to evaluate your Amazon Web Services 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 Amazon Web Services service, that triggers Config to evaluate your Amazon Web Services resources.

See Also:

EventSource

eventSourceAsString

public final String eventSourceAsString()

The source of the event, such as an Amazon Web Services service, that triggers Config to evaluate your Amazon Web Services 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 Amazon Web Services service, that triggers Config to evaluate your Amazon Web Services resources.

See Also:

EventSource

messageType

public final MessageType messageType()

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

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

• OversizedConfigurationItemChangeNotification - Triggers an evaluation when Config delivers an oversized configuration item. 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 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 Config to run an evaluation for a rule. You can specify the following notification types:

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

• OversizedConfigurationItemChangeNotification - Triggers an evaluation when Config delivers an oversized configuration item. 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 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 final String messageTypeAsString()

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

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

• OversizedConfigurationItemChangeNotification - Triggers an evaluation when Config delivers an oversized configuration item. 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 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 Config to run an evaluation for a rule. You can specify the following notification types:

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

• OversizedConfigurationItemChangeNotification - Triggers an evaluation when Config delivers an oversized configuration item. 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 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 final MaximumExecutionFrequency maximumExecutionFrequency()

The frequency at which you want 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, Config runs evaluations once for each valid value. For example, if you choose Three_Hours, 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 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, Config runs evaluations once for each valid value. For example, if you choose Three_Hours, Config runs evaluations once every three hours. In this case, Three_Hours is the frequency of this rule.

See Also:

MaximumExecutionFrequency

maximumExecutionFrequencyAsString

public final String maximumExecutionFrequencyAsString()

The frequency at which you want 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, Config runs evaluations once for each valid value. For example, if you choose Three_Hours, 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 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, Config runs evaluations once for each valid value. For example, if you choose Three_Hours, 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()

Specified by:

toBuilder in interface ToCopyableBuilder<SourceDetail.Builder,SourceDetail>

builder

public static SourceDetail.Builder builder()

serializableBuilderClass

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

Specified by:

equalsBySdkFields in interface SdkPojo

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