Class: Aws::MailManager::Types::SnsAction

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-mailmanager/types.rb

Overview

The action to publish the email content to an Amazon SNS topic. When executed, this action will send the email as a notification to the specified SNS topic.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#action_failure_policy ⇒ String

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:

  • (String) 


4240
4241
4242
4243
4244
4245
4246
4247
4248
 
# File 'lib/aws-sdk-mailmanager/types.rb', line 4240

class SnsAction < Struct.new(
  :action_failure_policy,
  :topic_arn,
  :role_arn,
  :encoding,
  :payload_type)
  SENSITIVE = []
  include Aws::Structure
end

#encoding ⇒ String

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:

  • (String) 


4240
4241
4242
4243
4244
4245
4246
4247
4248
 
# File 'lib/aws-sdk-mailmanager/types.rb', line 4240

class SnsAction < Struct.new(
  :action_failure_policy,
  :topic_arn,
  :role_arn,
  :encoding,
  :payload_type)
  SENSITIVE = []
  include Aws::Structure
end

#payload_type ⇒ String

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:

  • (String) 


4240
4241
4242
4243
4244
4245
4246
4247
4248
 
# File 'lib/aws-sdk-mailmanager/types.rb', line 4240

class SnsAction < Struct.new(
  :action_failure_policy,
  :topic_arn,
  :role_arn,
  :encoding,
  :payload_type)
  SENSITIVE = []
  include Aws::Structure
end

#role_arn ⇒ String

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:

  • (String) 


4240
4241
4242
4243
4244
4245
4246
4247
4248
 
# File 'lib/aws-sdk-mailmanager/types.rb', line 4240

class SnsAction < Struct.new(
  :action_failure_policy,
  :topic_arn,
  :role_arn,
  :encoding,
  :payload_type)
  SENSITIVE = []
  include Aws::Structure
end

#topic_arn ⇒ String

The Amazon Resource Name (ARN) of the Amazon SNS Topic to which notification for the email received will be published.

Returns:

  • (String) 


4240
4241
4242
4243
4244
4245
4246
4247
4248
 
# File 'lib/aws-sdk-mailmanager/types.rb', line 4240

class SnsAction < Struct.new(
  :action_failure_policy,
  :topic_arn,
  :role_arn,
  :encoding,
  :payload_type)
  SENSITIVE = []
  include Aws::Structure
end