@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.
Constructor and Description |
---|
EventDestination() |
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.
|
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.
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.
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.
Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).
Contain 64 characters or fewer.
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.
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.
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
.
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
.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
.
true
to enable publishing to this destination; set to
false
to prevent publishing to this destination. The default value is false
.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
.
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
.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
.
true
to enable publishing to this destination; set to
false
to prevent publishing to this destination. The default value is false
.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.
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.
EventType
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.
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.
EventType
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.
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.
EventType
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.
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.
EventType
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.
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.
EventType
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.
kinesisFirehoseDestination
- An object that contains the delivery stream ARN and the IAM role ARN associated with an Amazon Kinesis
Firehose event destination.public KinesisFirehoseDestination getKinesisFirehoseDestination()
An object that contains the delivery stream ARN and the IAM role ARN associated with an Amazon Kinesis Firehose event destination.
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.
kinesisFirehoseDestination
- An object that contains the delivery stream ARN and the IAM role ARN associated with an Amazon Kinesis
Firehose event destination.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.
cloudWatchDestination
- An object that contains the names, default values, and sources of the dimensions associated with an Amazon
CloudWatch event destination.public CloudWatchDestination getCloudWatchDestination()
An object that contains the names, default values, and sources of the dimensions associated with an Amazon CloudWatch event destination.
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.
cloudWatchDestination
- An object that contains the names, default values, and sources of the dimensions associated with an Amazon
CloudWatch event destination.public void setSNSDestination(SNSDestination sNSDestination)
An object that contains the topic ARN associated with an Amazon Simple Notification Service (Amazon SNS) event destination.
sNSDestination
- An object that contains the topic ARN associated with an Amazon Simple Notification Service (Amazon SNS)
event destination.public SNSDestination getSNSDestination()
An object that contains the topic ARN associated with an Amazon Simple Notification Service (Amazon SNS) event destination.
public EventDestination withSNSDestination(SNSDestination sNSDestination)
An object that contains the topic ARN associated with an Amazon Simple Notification Service (Amazon SNS) event destination.
sNSDestination
- An object that contains the topic ARN associated with an Amazon Simple Notification Service (Amazon SNS)
event destination.public String toString()
toString
in class Object
Object.toString()
public EventDestination clone()