Class: AWSCDK::SES::CfnReceiptRule::StopActionProperty

Inherits:

Jsii::Struct

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

Defined in:

ses/cfn_receipt_rule.rb

Overview

When included in a receipt rule, this action terminates the evaluation of the receipt rule set and, optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS).

For information about setting a stop action in a receipt rule, see the Amazon SES Developer Guide .

See Also:

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

Instance Attribute Summary

• #scope ⇒ String readonly

  The scope of the StopAction.

• #topic_arn ⇒ String^? readonly

  The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the stop action is taken.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(scope:, topic_arn: nil) ⇒ StopActionProperty constructor

  A new instance of StopActionProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(scope:, topic_arn: nil) ⇒ StopActionProperty

Returns a new instance of StopActionProperty.

Parameters:

• scope (String) —

  The scope of the StopAction.

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

  The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the stop action is taken.

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

def initialize(scope:, topic_arn: nil)
  @scope = scope
  Jsii::Type.check_type(@scope, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "scope")
  @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

#scope ⇒ String (readonly)

The scope of the StopAction.

The only acceptable value is RuleSet .

Returns:

• (String)

See Also:

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

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

def scope
  @scope
end

#topic_arn ⇒ String^? (readonly)

The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the stop action is taken.

You can find the ARN of a topic by using the ListTopics Amazon SNS operation.

For more information about Amazon SNS topics, see the Amazon SNS Developer Guide .

Returns:

• (String, nil)

See Also:

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

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

def topic_arn
  @topic_arn
end

Class Method Details

.jsii_properties ⇒ Object

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

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

Instance Method Details

#to_jsii ⇒ Object

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

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