Class EventDestination

java.lang.Object
software.amazon.awssdk.services.ses.model.EventDestination
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<EventDestination.Builder,EventDestination>
@Generated("software.amazon.awssdk:codegen") public final class EventDestination extends Object implements SdkPojo, Serializable, ToCopyableBuilder<EventDestination.Builder,EventDestination>

Contains information about an event destination.

When you create or update an event destination, you must provide one, and only one, destination. The destination can be Amazon CloudWatch, Amazon Kinesis Firehose or Amazon Simple Notification Service (Amazon SNS).

Event destinations are associated with configuration sets, which enable you to publish email sending events to Amazon CloudWatch, Amazon Kinesis Firehose, or Amazon Simple Notification Service (Amazon SNS). For information about using configuration sets, see the Amazon SES Developer Guide.

See Also:

  • Method Details

    • name

      public final String name()

      The name of the event destination. The name must meet the following requirements:

      • Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).

      • Contain 64 characters or fewer.

      Returns:
      The name of the event destination. The name must meet the following requirements:

      • Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).

      • Contain 64 characters or fewer.

    • enabled

      public final Boolean enabled()

      Sets whether Amazon SES publishes events to this destination when you send an email with the associated configuration set. Set to true to enable publishing to this destination; set to false to prevent publishing to this destination. The default value is false.

      Returns:
      Sets whether Amazon SES publishes events to this destination when you send an email with the associated configuration set. Set to true to enable publishing to this destination; set to false to prevent publishing to this destination. The default value is false.

    • matchingEventTypes

      public final List<EventType> matchingEventTypes()

      The type of email sending events to publish to the event destination.

      • send - The call was successful and Amazon SES is attempting to deliver the email.

      • reject - Amazon SES determined that the email contained a virus and rejected it.

      • bounce - The recipient's mail server permanently rejected the email. This corresponds to a hard bounce.

      • complaint - The recipient marked the email as spam.

      • delivery - Amazon SES successfully delivered the email to the recipient's mail server.

      • open - The recipient received the email and opened it in their email client.

      • click - The recipient clicked one or more links in the email.

      • renderingFailure - Amazon SES did not send the email because of a template rendering issue.

      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:
      The type of email sending events to publish to the event destination.

      • send - The call was successful and Amazon SES is attempting to deliver the email.

      • reject - Amazon SES determined that the email contained a virus and rejected it.

      • bounce - The recipient's mail server permanently rejected the email. This corresponds to a hard bounce.

      • complaint - The recipient marked the email as spam.

      • delivery - Amazon SES successfully delivered the email to the recipient's mail server.

      • open - The recipient received the email and opened it in their email client.

      • click - The recipient clicked one or more links in the email.

      • renderingFailure - Amazon SES did not send the email because of a template rendering issue.

    • 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()

      The type of email sending events to publish to the event destination.

      • send - The call was successful and Amazon SES is attempting to deliver the email.

      • reject - Amazon SES determined that the email contained a virus and rejected it.

      • bounce - The recipient's mail server permanently rejected the email. This corresponds to a hard bounce.

      • complaint - The recipient marked the email as spam.

      • delivery - Amazon SES successfully delivered the email to the recipient's mail server.

      • open - The recipient received the email and opened it in their email client.

      • click - The recipient clicked one or more links in the email.

      • renderingFailure - Amazon SES did not send the email because of a template rendering issue.

      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:
      The type of email sending events to publish to the event destination.

      • send - The call was successful and Amazon SES is attempting to deliver the email.

      • reject - Amazon SES determined that the email contained a virus and rejected it.

      • bounce - The recipient's mail server permanently rejected the email. This corresponds to a hard bounce.

      • complaint - The recipient marked the email as spam.

      • delivery - Amazon SES successfully delivered the email to the recipient's mail server.

      • open - The recipient received the email and opened it in their email client.

      • click - The recipient clicked one or more links in the email.

      • renderingFailure - Amazon SES did not send the email because of a template rendering issue.

    • kinesisFirehoseDestination

      public final KinesisFirehoseDestination kinesisFirehoseDestination()

      An object that contains the delivery stream ARN and the IAM role ARN associated with an Amazon Kinesis Firehose event destination.

      Returns:
      An object that contains the delivery stream ARN and the IAM role ARN associated with an Amazon Kinesis Firehose event destination.

    • cloudWatchDestination

      public final CloudWatchDestination cloudWatchDestination()

      An object that contains the names, default values, and sources of the dimensions associated with an Amazon CloudWatch event destination.

      Returns:
      An object that contains the names, default values, and sources of the dimensions associated with an Amazon CloudWatch event destination.

    • snsDestination

      public final SNSDestination snsDestination()

      An object that contains the topic ARN associated with an Amazon Simple Notification Service (Amazon SNS) event destination.

      Returns:
      An object that contains the topic ARN associated with an Amazon Simple Notification Service (Amazon SNS) event destination.

    • toBuilder

      public EventDestination.Builder 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 interface ToCopyableBuilder<EventDestination.Builder,EventDestination>
      Returns:
      a builder for type T

    • builder

      public static EventDestination.Builder builder()

    • serializableBuilderClass

      public static Class<? extends EventDestination.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)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.