Interface SnsAction.Builder

All Superinterfaces:
Buildable, CopyableBuilder<SnsAction.Builder,SnsAction>, SdkBuilder<SnsAction.Builder,SnsAction>, SdkPojo
Enclosing class:
SnsAction
@Mutable @NotThreadSafe public static interface SnsAction.Builder extends SdkPojo, CopyableBuilder<SnsAction.Builder,SnsAction>

  • Method Details

    • actionFailurePolicy

      SnsAction.Builder actionFailurePolicy(String 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:Publish API.

      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 the sns:Publish API.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • actionFailurePolicy

      SnsAction.Builder actionFailurePolicy(ActionFailurePolicy 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:Publish API.

      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 the sns:Publish API.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • encoding

      SnsAction.Builder encoding(String encoding)

      The encoding to use for the email within the Amazon SNS notification. The default value is UTF-8 . Use BASE64 if 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 is UTF-8. Use BASE64 if 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

      SnsAction.Builder encoding(SnsNotificationEncoding encoding)

      The encoding to use for the email within the Amazon SNS notification. The default value is UTF-8 . Use BASE64 if 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 is UTF-8. Use BASE64 if 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

      SnsAction.Builder payloadType(String payloadType)

      The expected payload type within the Amazon SNS notification. CONTENT attempts to publish the full email content with 20KB of headers content. HEADERS extracts up to 100KB of header content to include in the notification, email content will not be included to the notification. The default value is CONTENT.

      Parameters:
      payloadType - The expected payload type within the Amazon SNS notification. CONTENT attempts to publish the full email content with 20KB of headers content. HEADERS extracts up to 100KB of header content to include in the notification, email content will not be included to the notification. The default value is CONTENT.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • payloadType

      SnsAction.Builder payloadType(SnsNotificationPayloadType payloadType)

      The expected payload type within the Amazon SNS notification. CONTENT attempts to publish the full email content with 20KB of headers content. HEADERS extracts up to 100KB of header content to include in the notification, email content will not be included to the notification. The default value is CONTENT.

      Parameters:
      payloadType - The expected payload type within the Amazon SNS notification. CONTENT attempts to publish the full email content with 20KB of headers content. HEADERS extracts up to 100KB of header content to include in the notification, email content will not be included to the notification. The default value is CONTENT.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • roleArn

      SnsAction.Builder roleArn(String 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:Publish API 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 the sns:Publish API for the given topic.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • topicArn

      SnsAction.Builder topicArn(String 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.