Class: AWSCDK::SES::CfnReceiptRule::SNSActionProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::SES::CfnReceiptRule::SNSActionProperty

Defined in:

ses/cfn_receipt_rule.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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-snsaction.html

Instance Attribute Summary

• #encoding ⇒ String^? readonly

  The encoding to use for the email within the Amazon SNS notification.

• #topic_arn ⇒ String^? readonly

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

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(encoding: nil, topic_arn: nil) ⇒ SNSActionProperty constructor

  A new instance of SNSActionProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(encoding: nil, topic_arn: nil) ⇒ SNSActionProperty

Returns a new instance of SNSActionProperty.

Parameters:

• encoding (String, nil) (defaults to: nil) —

  The encoding to use for the email within the Amazon SNS notification.

• topic_arn (String, nil) (defaults to: nil) —

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

# File 'ses/cfn_receipt_rule.rb', line 1086

def initialize(encoding: nil, topic_arn: nil)
  @encoding = encoding
  Jsii::Type.check_type(@encoding, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "encoding") unless @encoding.nil?
  @topic_arn = topic_arn
  Jsii::Type.check_type(@topic_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "topicArn") unless @topic_arn.nil?
end

Instance Attribute Details

#encoding ⇒ String^? (readonly)

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, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-snsaction.html#cfn-ses-receiptrule-snsaction-encoding

# File 'ses/cfn_receipt_rule.rb', line 1099

def encoding
  @encoding
end

#topic_arn ⇒ String^? (readonly)

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

Returns:

• (String, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-snsaction.html#cfn-ses-receiptrule-snsaction-topicarn

# File 'ses/cfn_receipt_rule.rb', line 1104

def topic_arn
  @topic_arn
end

Class Method Details

.jsii_properties ⇒ Object

# File 'ses/cfn_receipt_rule.rb', line 1106

def self.jsii_properties
  {
    :encoding => "encoding",
    :topic_arn => "topicArn",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'ses/cfn_receipt_rule.rb', line 1113

def to_jsii
  result = {}
  result.merge!({
    "encoding" => @encoding,
    "topicArn" => @topic_arn,
  })
  result.compact
end