@Generated(value="software.amazon.awssdk:codegen") public class SNSAction extends Object implements ToCopyableBuilder<SNSAction.Builder,SNSAction>
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.
You can only publish emails that are 150 KB or less (including the header) to Amazon SNS. Larger emails will bounce. If you anticipate emails larger than 150 KB, use the S3 action instead.
For information about using a receipt rule to publish an Amazon SNS notification, see the Amazon SES Developer Guide.
Modifier and Type | Class and Description |
---|---|
static interface |
SNSAction.Builder |
Modifier and Type | Method and Description |
---|---|
static SNSAction.Builder |
builder() |
SNSActionEncoding |
encoding()
The encoding to use for the email within the Amazon SNS notification.
|
String |
encodingString()
The encoding to use for the email within the Amazon SNS notification.
|
boolean |
equals(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
static Class<? extends SNSAction.Builder> |
serializableBuilderClass() |
SNSAction.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
topicArn()
The Amazon Resource Name (ARN) of the Amazon SNS topic to notify.
|
String |
toString() |
copy
public 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.
arn:aws:sns:us-west-2:123456789012:MyTopic
. For more information about Amazon SNS topics,
see the Amazon SNS Developer
Guide.public 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.
If the service returns an enum value that is not available in the current SDK version, encoding
will
return SNSActionEncoding.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
encodingString()
.
SNSActionEncoding
public String encodingString()
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.
If the service returns an enum value that is not available in the current SDK version, encoding
will
return SNSActionEncoding.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
encodingString()
.
SNSActionEncoding
public SNSAction.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<SNSAction.Builder,SNSAction>
public static SNSAction.Builder builder()
public static Class<? extends SNSAction.Builder> serializableBuilderClass()
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.