Class SourceDetail
- java.lang.Object
-
- software.amazon.awssdk.services.config.model.SourceDetail
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<SourceDetail.Builder,SourceDetail>
@Generated("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
SourceDetailonly for custom rules.- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceSourceDetail.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static SourceDetail.Builderbuilder()booleanequals(Object obj)booleanequalsBySdkFields(Object obj)EventSourceeventSource()The source of the event, such as an Amazon Web Services service, that triggers Config to evaluate your Amazon Web Services resources.StringeventSourceAsString()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)inthashCode()MaximumExecutionFrequencymaximumExecutionFrequency()The frequency at which you want Config to run evaluations for a custom rule with a periodic trigger.StringmaximumExecutionFrequencyAsString()The frequency at which you want Config to run evaluations for a custom rule with a periodic trigger.MessageTypemessageType()The type of notification that triggers Config to run an evaluation for a rule.StringmessageTypeAsString()The type of notification that triggers Config to run an evaluation for a rule.List<SdkField<?>>sdkFields()static Class<? extends SourceDetail.Builder>serializableBuilderClass()SourceDetail.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
-
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,
eventSourcewill returnEventSource.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromeventSourceAsString().- 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,
eventSourcewill returnEventSource.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromeventSourceAsString().- 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 forMaximumExecutionFrequency. -
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
ConfigurationItemChangeNotificationand one forOversizedConfigurationItemChangeNotification.If the service returns an enum value that is not available in the current SDK version,
messageTypewill returnMessageType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available frommessageTypeAsString().- 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 forMaximumExecutionFrequency. -
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
ConfigurationItemChangeNotificationand one forOversizedConfigurationItemChangeNotification. -
- 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 forMaximumExecutionFrequency. -
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
ConfigurationItemChangeNotificationand one forOversizedConfigurationItemChangeNotification.If the service returns an enum value that is not available in the current SDK version,
messageTypewill returnMessageType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available frommessageTypeAsString().- 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 forMaximumExecutionFrequency. -
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
ConfigurationItemChangeNotificationand one forOversizedConfigurationItemChangeNotification. -
- 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, thenMessageTypemust use theScheduledNotificationvalue.By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a valid value for the
MaximumExecutionFrequencyparameter.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_Hoursis the frequency of this rule.If the service returns an enum value that is not available in the current SDK version,
maximumExecutionFrequencywill returnMaximumExecutionFrequency.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available frommaximumExecutionFrequencyAsString().- 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, thenMessageTypemust use theScheduledNotificationvalue.By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a valid value for the
MaximumExecutionFrequencyparameter.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_Hoursis 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, thenMessageTypemust use theScheduledNotificationvalue.By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a valid value for the
MaximumExecutionFrequencyparameter.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_Hoursis the frequency of this rule.If the service returns an enum value that is not available in the current SDK version,
maximumExecutionFrequencywill returnMaximumExecutionFrequency.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available frommaximumExecutionFrequencyAsString().- 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, thenMessageTypemust use theScheduledNotificationvalue.By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a valid value for the
MaximumExecutionFrequencyparameter.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_Hoursis the frequency of this rule. - See Also:
MaximumExecutionFrequency
-
toBuilder
public SourceDetail.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<SourceDetail.Builder,SourceDetail>
-
builder
public static SourceDetail.Builder builder()
-
serializableBuilderClass
public static Class<? extends SourceDetail.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.
-
-