public class SNSAction
extends java.lang.Object
implements java.io.Serializable, java.lang.Cloneable
When included in a receipt rule, this action publishes a notification to Amazon Simple Notification Service (Amazon SNS). This action includes a complete copy of the email content in the Amazon SNS notifications. Amazon SNS notifications for all other actions simply provide information about the email. They do not include the email content itself.
If you own the Amazon SNS topic, you don't need to do anything to give Amazon SES permission to publish emails to it. However, if you don't own the Amazon SNS topic, you need to attach a policy to the topic to give Amazon SES permissions to access it. For information about giving permissions, see the Amazon SES Developer Guide.
For information about using a receipt rule to publish an Amazon SNS notification, see the Amazon SES Developer Guide.
Modifier and Type | Field and Description |
---|---|
private java.lang.String |
encoding
The encoding to use for the email within the Amazon SNS notification.
|
private java.lang.String |
topicArn
The Amazon Resource Name (ARN) of the Amazon SNS topic to notify.
|
Constructor and Description |
---|
SNSAction() |
Modifier and Type | Method and Description |
---|---|
SNSAction |
clone() |
boolean |
equals(java.lang.Object obj) |
java.lang.String |
getEncoding()
The encoding to use for the email within the Amazon SNS notification.
|
java.lang.String |
getTopicArn()
The Amazon Resource Name (ARN) of the Amazon SNS topic to notify.
|
int |
hashCode() |
void |
setEncoding(SNSActionEncoding encoding)
The encoding to use for the email within the Amazon SNS notification.
|
void |
setEncoding(java.lang.String encoding)
The encoding to use for the email within the Amazon SNS notification.
|
void |
setTopicArn(java.lang.String topicArn)
The Amazon Resource Name (ARN) of the Amazon SNS topic to notify.
|
java.lang.String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
SNSAction |
withEncoding(SNSActionEncoding encoding)
The encoding to use for the email within the Amazon SNS notification.
|
SNSAction |
withEncoding(java.lang.String encoding)
The encoding to use for the email within the Amazon SNS notification.
|
SNSAction |
withTopicArn(java.lang.String topicArn)
The Amazon Resource Name (ARN) of the Amazon SNS topic to notify.
|
private java.lang.String topicArn
The Amazon Resource Name (ARN) of the Amazon SNS topic to notify. An
example of an Amazon SNS topic ARN is
arn:aws:sns:us-west-2:123456789012:MyTopic
. For more
information about Amazon SNS topics, see the Amazon
SNS Developer Guide.
private java.lang.String encoding
The encoding to use for the email within the Amazon SNS notification. UTF-8 is easier to use, but may not preserve all special characters when a message was encoded with a different encoding format. Base64 preserves all special characters. The default value is UTF-8.
public void setTopicArn(java.lang.String topicArn)
The Amazon Resource Name (ARN) of the Amazon SNS topic to notify. An
example of an Amazon SNS topic ARN is
arn:aws:sns:us-west-2:123456789012:MyTopic
. For more
information about Amazon SNS topics, see the Amazon
SNS Developer Guide.
topicArn
- The Amazon Resource Name (ARN) of the Amazon SNS topic to notify.
An example of an Amazon SNS topic ARN is
arn:aws:sns:us-west-2:123456789012:MyTopic
. For more
information about Amazon SNS topics, see the Amazon SNS Developer Guide.public java.lang.String getTopicArn()
The Amazon Resource Name (ARN) of the Amazon SNS topic to notify. An
example of an Amazon SNS topic ARN is
arn:aws:sns:us-west-2:123456789012:MyTopic
. For more
information about Amazon SNS topics, see the Amazon
SNS Developer Guide.
arn:aws:sns:us-west-2:123456789012:MyTopic
. For more
information about Amazon SNS topics, see the Amazon SNS Developer Guide.public SNSAction withTopicArn(java.lang.String topicArn)
The Amazon Resource Name (ARN) of the Amazon SNS topic to notify. An
example of an Amazon SNS topic ARN is
arn:aws:sns:us-west-2:123456789012:MyTopic
. For more
information about Amazon SNS topics, see the Amazon
SNS Developer Guide.
topicArn
- The Amazon Resource Name (ARN) of the Amazon SNS topic to notify.
An example of an Amazon SNS topic ARN is
arn:aws:sns:us-west-2:123456789012:MyTopic
. For more
information about Amazon SNS topics, see the Amazon SNS Developer Guide.public void setEncoding(java.lang.String encoding)
The encoding to use for the email within the Amazon SNS notification. UTF-8 is easier to use, but may not preserve all special characters when a message was encoded with a different encoding format. Base64 preserves all special characters. The default value is UTF-8.
encoding
- The encoding to use for the email within the Amazon SNS
notification. UTF-8 is easier to use, but may not preserve all
special characters when a message was encoded with a different
encoding format. Base64 preserves all special characters. The
default value is UTF-8.SNSActionEncoding
public java.lang.String getEncoding()
The encoding to use for the email within the Amazon SNS notification. UTF-8 is easier to use, but may not preserve all special characters when a message was encoded with a different encoding format. Base64 preserves all special characters. The default value is UTF-8.
SNSActionEncoding
public SNSAction withEncoding(java.lang.String encoding)
The encoding to use for the email within the Amazon SNS notification. UTF-8 is easier to use, but may not preserve all special characters when a message was encoded with a different encoding format. Base64 preserves all special characters. The default value is UTF-8.
encoding
- The encoding to use for the email within the Amazon SNS
notification. UTF-8 is easier to use, but may not preserve all
special characters when a message was encoded with a different
encoding format. Base64 preserves all special characters. The
default value is UTF-8.SNSActionEncoding
public void setEncoding(SNSActionEncoding encoding)
The encoding to use for the email within the Amazon SNS notification. UTF-8 is easier to use, but may not preserve all special characters when a message was encoded with a different encoding format. Base64 preserves all special characters. The default value is UTF-8.
encoding
- The encoding to use for the email within the Amazon SNS
notification. UTF-8 is easier to use, but may not preserve all
special characters when a message was encoded with a different
encoding format. Base64 preserves all special characters. The
default value is UTF-8.SNSActionEncoding
public SNSAction withEncoding(SNSActionEncoding encoding)
The encoding to use for the email within the Amazon SNS notification. UTF-8 is easier to use, but may not preserve all special characters when a message was encoded with a different encoding format. Base64 preserves all special characters. The default value is UTF-8.
encoding
- The encoding to use for the email within the Amazon SNS
notification. UTF-8 is easier to use, but may not preserve all
special characters when a message was encoded with a different
encoding format. Base64 preserves all special characters. The
default value is UTF-8.SNSActionEncoding
public java.lang.String toString()
toString
in class java.lang.Object
Object.toString()
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public SNSAction clone()
clone
in class java.lang.Object