Class SourceDetail
- All Implemented Interfaces:
Serializable
,SdkPojo
,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:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic SourceDetail.Builder
builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final EventSource
The source of the event, such as an Amazon Web Services service, that triggers Config to evaluate your Amazon Web Services resources.final String
The source of the event, such as an Amazon Web Services service, that triggers Config to evaluate your Amazon Web Services resources.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
The frequency at which you want Config to run evaluations for a custom rule with a periodic trigger.final String
The frequency at which you want Config to run evaluations for a custom rule with a periodic trigger.final MessageType
The type of notification that triggers Config to run an evaluation for a rule.final String
The type of notification that triggers Config to run an evaluation for a rule.static Class
<? extends SourceDetail.Builder> 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 interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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 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:
-
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 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:
-
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
ConfigurationItemChangeNotification
and one forOversizedConfigurationItemChangeNotification
.If the service returns an enum value that is not available in the current SDK version,
messageType
will 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
ConfigurationItemChangeNotification
and one forOversizedConfigurationItemChangeNotification
. -
- See Also:
-
-
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
ConfigurationItemChangeNotification
and one forOversizedConfigurationItemChangeNotification
.If the service returns an enum value that is not available in the current SDK version,
messageType
will 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
ConfigurationItemChangeNotification
and one forOversizedConfigurationItemChangeNotification
. -
- See Also:
-
-
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
, thenMessageType
must use theScheduledNotification
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 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
, thenMessageType
must use theScheduledNotification
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:
-
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
, thenMessageType
must use theScheduledNotification
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 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
, thenMessageType
must use theScheduledNotification
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:
-
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 interfaceToCopyableBuilder<SourceDetail.Builder,
SourceDetail> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-