software.amazon.awssdk.services.sesv2.model

Class EventDestinationDefinition

java.lang.Object

software.amazon.awssdk.services.sesv2.model.EventDestinationDefinition

All Implemented Interfaces:

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

@Generated(value="software.amazon.awssdk:codegen")
public final class EventDestinationDefinition
extends Object
implements SdkPojo, Serializable, 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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	EventDestinationDefinition.Builder

Method Summary

Modifier and Type	Method and Description
static EventDestinationDefinition.Builder	builder()
CloudWatchDestination	cloudWatchDestination() An object that defines an Amazon CloudWatch destination for email events.
Boolean	enabled() If true, the event destination is enabled.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasMatchingEventTypes() For responses, this returns true if the service returned a value for the MatchingEventTypes property.
KinesisFirehoseDestination	kinesisFirehoseDestination() An object that defines an Amazon Kinesis Data Firehose destination for email events.
List<EventType>	matchingEventTypes() An array that specifies which events the Amazon SES API v2 should send to the destinations in this EventDestinationDefinition.
List<String>	matchingEventTypesAsStrings() An array that specifies which events the Amazon SES API v2 should send to the destinations in this EventDestinationDefinition.
PinpointDestination	pinpointDestination() An object that defines an Amazon Pinpoint project destination for email events.
List<SdkField<?>>	sdkFields()
static Class<? extends EventDestinationDefinition.Builder>	serializableBuilderClass()
SnsDestination	snsDestination() An object that defines an Amazon SNS destination for email events.
EventDestinationDefinition.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

enabled

public final Boolean enabled()

If true, the event destination is enabled. When the event destination is enabled, the specified event types are sent to the destinations in this EventDestinationDefinition.

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 this EventDestinationDefinition.

If false, the event destination is disabled. When the event destination is disabled, events aren't sent to the specified destinations.

matchingEventTypes

public final List<EventType> 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 the isEmpty() 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

public final List<String> 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

public final KinesisFirehoseDestination 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

public final CloudWatchDestination 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

public final SnsDestination 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

public final PinpointDestination 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

public EventDestinationDefinition.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<EventDestinationDefinition.Builder,EventDestinationDefinition>

builder

public static EventDestinationDefinition.Builder builder()

serializableBuilderClass

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