Class: AWSCDK::SES::StopActionConfig

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
ses/stop_action_config.rb

Overview

StopAction configuration.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of StopActionConfig.

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.



9
10
11
12
13
14
 
# File 'ses/stop_action_config.rb', line 9

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) 


21
22
23
 
# File 'ses/stop_action_config.rb', line 21

def scope
  @scope
end

#topic_arn ⇒ String? (readonly)

Note:

Default: - No notification is sent to SNS.

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

Returns:

  • (String, nil) 


26
27
28
 
# File 'ses/stop_action_config.rb', line 26

def topic_arn
  @topic_arn
end

Class Method Details

.jsii_properties ⇒ Object 



28
29
30
31
32
33
 
# File 'ses/stop_action_config.rb', line 28

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

Instance Method Details

#to_jsii ⇒ Object 



35
36
37
38
39
40
41
42
 
# File 'ses/stop_action_config.rb', line 35

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