Class EventDestinationDefinition
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<EventDestinationDefinition.Builder,
EventDestinationDefinition>
An object that defines the event destination. Specifically, it defines which services receive events from emails sent using the configuration set that the event destination is associated with. Also defines the types of events that are sent to the event destination.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final CloudWatchDestination
An object that defines an Amazon CloudWatch destination for email events.final Boolean
enabled()
Iftrue
, the event destination is enabled.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the MatchingEventTypes property.An object that defines an Amazon Kinesis Data Firehose destination for email events.An array that specifies which events the Amazon SES API v2 should send to the destinations in thisEventDestinationDefinition
.An array that specifies which events the Amazon SES API v2 should send to the destinations in thisEventDestinationDefinition
.final PinpointDestination
An object that defines an Amazon Pinpoint project destination for email events.static Class
<? extends EventDestinationDefinition.Builder> final SnsDestination
An object that defines an Amazon SNS destination for email events.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
-
enabled
If
true
, the event destination is enabled. When the event destination is enabled, the specified event types are sent to the destinations in thisEventDestinationDefinition
.If
false
, the event destination is disabled. When the event destination is disabled, events aren't sent to the specified destinations.- Returns:
- If
true
, the event destination is enabled. When the event destination is enabled, the specified event types are sent to the destinations in thisEventDestinationDefinition
.If
false
, the event destination is disabled. When the event destination is disabled, events aren't sent to the specified destinations.
-
matchingEventTypes
An array that specifies which events the Amazon SES API v2 should send to the destinations in this
EventDestinationDefinition
.Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasMatchingEventTypes()
method.- Returns:
- An array that specifies which events the Amazon SES API v2 should send to the destinations in this
EventDestinationDefinition
.
-
hasMatchingEventTypes
public final boolean hasMatchingEventTypes()For responses, this returns true if the service returned a value for the MatchingEventTypes property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
matchingEventTypesAsStrings
An array that specifies which events the Amazon SES API v2 should send to the destinations in this
EventDestinationDefinition
.Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasMatchingEventTypes()
method.- Returns:
- An array that specifies which events the Amazon SES API v2 should send to the destinations in this
EventDestinationDefinition
.
-
kinesisFirehoseDestination
An object that defines an Amazon Kinesis Data Firehose destination for email events. You can use Amazon Kinesis Data Firehose to stream data to other services, such as Amazon S3 and Amazon Redshift.
- Returns:
- An object that defines an Amazon Kinesis Data Firehose destination for email events. You can use Amazon Kinesis Data Firehose to stream data to other services, such as Amazon S3 and Amazon Redshift.
-
cloudWatchDestination
An object that defines an Amazon CloudWatch destination for email events. You can use Amazon CloudWatch to monitor and gain insights on your email sending metrics.
- Returns:
- An object that defines an Amazon CloudWatch destination for email events. You can use Amazon CloudWatch to monitor and gain insights on your email sending metrics.
-
snsDestination
An object that defines an Amazon SNS destination for email events. You can use Amazon SNS to send notification when certain email events occur.
- Returns:
- An object that defines an Amazon SNS destination for email events. You can use Amazon SNS to send notification when certain email events occur.
-
pinpointDestination
An object that defines an Amazon Pinpoint project destination for email events. You can send email event data to a Amazon Pinpoint project to view metrics using the Transactional Messaging dashboards that are built in to Amazon Pinpoint. For more information, see Transactional Messaging Charts in the Amazon Pinpoint User Guide.
- Returns:
- An object that defines an Amazon Pinpoint project destination for email events. You can send email event data to a Amazon Pinpoint project to view metrics using the Transactional Messaging dashboards that are built in to Amazon Pinpoint. For more information, see Transactional Messaging Charts in the Amazon Pinpoint User Guide.
-
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<EventDestinationDefinition.Builder,
EventDestinationDefinition> - 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
-