Package software.amazon.awssdk.services.ses.model

Interface EventDestination.Builder

All Superinterfaces:
Buildable, CopyableBuilder<EventDestination.Builder,EventDestination>, SdkBuilder<EventDestination.Builder,EventDestination>, SdkPojo
Enclosing class:
EventDestination
public static interface EventDestination.Builder extends SdkPojo, CopyableBuilder<EventDestination.Builder,EventDestination>

  • Method Details

    • name

      EventDestination.Builder name(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • enabled

      EventDestination.Builder enabled(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • matchingEventTypesWithStrings

      EventDestination.Builder matchingEventTypesWithStrings(Collection<String> 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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • matchingEventTypesWithStrings

      EventDestination.Builder matchingEventTypesWithStrings(String... 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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • matchingEventTypes

      EventDestination.Builder matchingEventTypes(Collection<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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • matchingEventTypes

      EventDestination.Builder matchingEventTypes(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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • kinesisFirehoseDestination

      EventDestination.Builder kinesisFirehoseDestination(KinesisFirehoseDestination kinesisFirehoseDestination)

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

      Parameters:
      kinesisFirehoseDestination - An object that contains the delivery stream ARN and the IAM role ARN associated with an Amazon Kinesis Firehose event destination.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • kinesisFirehoseDestination

      default EventDestination.Builder kinesisFirehoseDestination(Consumer<KinesisFirehoseDestination.Builder> kinesisFirehoseDestination)

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

      This is a convenience method that creates an instance of the KinesisFirehoseDestination.Builder avoiding the need to create one manually via KinesisFirehoseDestination.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to kinesisFirehoseDestination(KinesisFirehoseDestination).

      Parameters:
      kinesisFirehoseDestination - a consumer that will call methods on KinesisFirehoseDestination.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • cloudWatchDestination

      EventDestination.Builder cloudWatchDestination(CloudWatchDestination cloudWatchDestination)

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

      Parameters:
      cloudWatchDestination - An object that contains the names, default values, and sources of the dimensions associated with an Amazon CloudWatch event destination.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • cloudWatchDestination

      default EventDestination.Builder cloudWatchDestination(Consumer<CloudWatchDestination.Builder> cloudWatchDestination)

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

      This is a convenience method that creates an instance of the CloudWatchDestination.Builder avoiding the need to create one manually via CloudWatchDestination.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to cloudWatchDestination(CloudWatchDestination).

      Parameters:
      cloudWatchDestination - a consumer that will call methods on CloudWatchDestination.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • snsDestination

      EventDestination.Builder snsDestination(SNSDestination snsDestination)

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

      Parameters:
      snsDestination - An object that contains the topic ARN associated with an Amazon Simple Notification Service (Amazon SNS) event destination.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • snsDestination

      default EventDestination.Builder snsDestination(Consumer<SNSDestination.Builder> snsDestination)

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

      This is a convenience method that creates an instance of the SNSDestination.Builder avoiding the need to create one manually via SNSDestination.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to snsDestination(SNSDestination).

      Parameters:
      snsDestination - a consumer that will call methods on SNSDestination.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: