com.amazonaws.services.simpleemail.model

Class EventDestination

java.lang.Object

com.amazonaws.services.simpleemail.model.EventDestination

All Implemented Interfaces:

Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class EventDestination
extends Object
implements Serializable, Cloneable

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:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
EventDestination()

Method Summary

Modifier and Type	Method and Description
EventDestination	clone()
boolean	equals(Object obj)
CloudWatchDestination	getCloudWatchDestination() An object that contains the names, default values, and sources of the dimensions associated with an Amazon CloudWatch event destination.
Boolean	getEnabled() Sets whether Amazon SES publishes events to this destination when you send an email with the associated configuration set.
KinesisFirehoseDestination	getKinesisFirehoseDestination() An object that contains the delivery stream ARN and the IAM role ARN associated with an Amazon Kinesis Firehose event destination.
List<String>	getMatchingEventTypes() The type of email sending events to publish to the event destination.
String	getName() The name of the event destination.
SNSDestination	getSNSDestination() An object that contains the topic ARN associated with an Amazon Simple Notification Service (Amazon SNS) event destination.
int	hashCode()
Boolean	isEnabled() Sets whether Amazon SES publishes events to this destination when you send an email with the associated configuration set.
void	setCloudWatchDestination(CloudWatchDestination cloudWatchDestination) An object that contains the names, default values, and sources of the dimensions associated with an Amazon CloudWatch event destination.
void	setEnabled(Boolean enabled) Sets whether Amazon SES publishes events to this destination when you send an email with the associated configuration set.
void	setKinesisFirehoseDestination(KinesisFirehoseDestination kinesisFirehoseDestination) An object that contains the delivery stream ARN and the IAM role ARN associated with an Amazon Kinesis Firehose event destination.
void	setMatchingEventTypes(Collection<String> matchingEventTypes) The type of email sending events to publish to the event destination.
void	setName(String name) The name of the event destination.
void	setSNSDestination(SNSDestination sNSDestination) An object that contains the topic ARN associated with an Amazon Simple Notification Service (Amazon SNS) event destination.
String	toString() Returns a string representation of this object.
EventDestination	withCloudWatchDestination(CloudWatchDestination cloudWatchDestination) An object that contains the names, default values, and sources of the dimensions associated with an Amazon CloudWatch event destination.
EventDestination	withEnabled(Boolean enabled) Sets whether Amazon SES publishes events to this destination when you send an email with the associated configuration set.
EventDestination	withKinesisFirehoseDestination(KinesisFirehoseDestination kinesisFirehoseDestination) An object that contains the delivery stream ARN and the IAM role ARN associated with an Amazon Kinesis Firehose event destination.
EventDestination	withMatchingEventTypes(Collection<String> matchingEventTypes) The type of email sending events to publish to the event destination.
EventDestination	withMatchingEventTypes(EventType... matchingEventTypes) The type of email sending events to publish to the event destination.
EventDestination	withMatchingEventTypes(String... matchingEventTypes) The type of email sending events to publish to the event destination.
EventDestination	withName(String name) The name of the event destination.
EventDestination	withSNSDestination(SNSDestination sNSDestination) An object that contains the topic ARN associated with an Amazon Simple Notification Service (Amazon SNS) event destination.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

EventDestination

public EventDestination()

Method Detail

setName

public void setName(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.

getName

public String getName()

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.

withName

public EventDestination withName(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.

setEnabled

public void setEnabled(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.

getEnabled

public Boolean getEnabled()

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.

withEnabled

public EventDestination withEnabled(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.

isEnabled

public Boolean isEnabled()

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.

getMatchingEventTypes

public List<String> getMatchingEventTypes()

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:

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.

See Also:

EventType

setMatchingEventTypes

public void setMatchingEventTypes(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.

See Also:

EventType

withMatchingEventTypes

public EventDestination withMatchingEventTypes(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.

NOTE: This method appends the values to the existing list (if any). Use setMatchingEventTypes(java.util.Collection) or withMatchingEventTypes(java.util.Collection) if you want to override the existing values.

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.

See Also:

EventType

withMatchingEventTypes

public EventDestination withMatchingEventTypes(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.

See Also:

EventType

withMatchingEventTypes

public EventDestination withMatchingEventTypes(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.

See Also:

EventType

setKinesisFirehoseDestination

public void setKinesisFirehoseDestination(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.

getKinesisFirehoseDestination

public KinesisFirehoseDestination getKinesisFirehoseDestination()

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.

withKinesisFirehoseDestination

public EventDestination withKinesisFirehoseDestination(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.

setCloudWatchDestination

public void setCloudWatchDestination(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.

getCloudWatchDestination

public CloudWatchDestination getCloudWatchDestination()

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.

withCloudWatchDestination

public EventDestination withCloudWatchDestination(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.

setSNSDestination

public void setSNSDestination(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.

getSNSDestination

public SNSDestination getSNSDestination()

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.

withSNSDestination

public EventDestination withSNSDestination(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.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public EventDestination clone()

Overrides:

clone in class Object