Interface SnsAction.Builder
- All Superinterfaces:
Buildable,CopyableBuilder<SnsAction.Builder,,SnsAction> SdkBuilder<SnsAction.Builder,,SnsAction> SdkPojo
- Enclosing class:
SnsAction
-
Method Summary
Modifier and TypeMethodDescriptionactionFailurePolicy(String actionFailurePolicy) A policy that states what to do in the case of failure.actionFailurePolicy(ActionFailurePolicy actionFailurePolicy) A policy that states what to do in the case of failure.The encoding to use for the email within the Amazon SNS notification.encoding(SnsNotificationEncoding encoding) The encoding to use for the email within the Amazon SNS notification.payloadType(String payloadType) The expected payload type within the Amazon SNS notification.payloadType(SnsNotificationPayloadType payloadType) The expected payload type within the Amazon SNS notification.The Amazon Resource Name (ARN) of the IAM Role to use while writing to Amazon SNS.The Amazon Resource Name (ARN) of the Amazon SNS Topic to which notification for the email received will be published.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copyMethods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, buildMethods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
-
Method Details
-
actionFailurePolicy
A policy that states what to do in the case of failure. The action will fail if there are configuration errors. For example, specified SNS topic has been deleted or the role lacks necessary permissions to call the
sns:PublishAPI.- Parameters:
actionFailurePolicy- A policy that states what to do in the case of failure. The action will fail if there are configuration errors. For example, specified SNS topic has been deleted or the role lacks necessary permissions to call thesns:PublishAPI.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
actionFailurePolicy
A policy that states what to do in the case of failure. The action will fail if there are configuration errors. For example, specified SNS topic has been deleted or the role lacks necessary permissions to call the
sns:PublishAPI.- Parameters:
actionFailurePolicy- A policy that states what to do in the case of failure. The action will fail if there are configuration errors. For example, specified SNS topic has been deleted or the role lacks necessary permissions to call thesns:PublishAPI.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
topicArn
The Amazon Resource Name (ARN) of the Amazon SNS Topic to which notification for the email received will be published.
- Parameters:
topicArn- The Amazon Resource Name (ARN) of the Amazon SNS Topic to which notification for the email received will be published.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
roleArn
The Amazon Resource Name (ARN) of the IAM Role to use while writing to Amazon SNS. This role must have access to the
sns:PublishAPI for the given topic.- Parameters:
roleArn- The Amazon Resource Name (ARN) of the IAM Role to use while writing to Amazon SNS. This role must have access to thesns:PublishAPI for the given topic.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
encoding
The encoding to use for the email within the Amazon SNS notification. The default value is
UTF-8. UseBASE64if you need to preserve all special characters, especially when the original message uses a different encoding format.- Parameters:
encoding- The encoding to use for the email within the Amazon SNS notification. The default value isUTF-8. UseBASE64if you need to preserve all special characters, especially when the original message uses a different encoding format.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
encoding
The encoding to use for the email within the Amazon SNS notification. The default value is
UTF-8. UseBASE64if you need to preserve all special characters, especially when the original message uses a different encoding format.- Parameters:
encoding- The encoding to use for the email within the Amazon SNS notification. The default value isUTF-8. UseBASE64if you need to preserve all special characters, especially when the original message uses a different encoding format.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
payloadType
The expected payload type within the Amazon SNS notification.
CONTENTattempts to publish the full email content with 20KB of headers content.HEADERSextracts up to 100KB of header content to include in the notification, email content will not be included to the notification. The default value isCONTENT.- Parameters:
payloadType- The expected payload type within the Amazon SNS notification.CONTENTattempts to publish the full email content with 20KB of headers content.HEADERSextracts up to 100KB of header content to include in the notification, email content will not be included to the notification. The default value isCONTENT.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
payloadType
The expected payload type within the Amazon SNS notification.
CONTENTattempts to publish the full email content with 20KB of headers content.HEADERSextracts up to 100KB of header content to include in the notification, email content will not be included to the notification. The default value isCONTENT.- Parameters:
payloadType- The expected payload type within the Amazon SNS notification.CONTENTattempts to publish the full email content with 20KB of headers content.HEADERSextracts up to 100KB of header content to include in the notification, email content will not be included to the notification. The default value isCONTENT.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-