Class: AWSCDK::SESActions::WorkMailProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
ses_actions/work_mail_props.rb

Overview

Construction properties for a WorkMail action.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(organization_arn:, topic: nil) ⇒ WorkMailProps

Returns a new instance of WorkMailProps.

Parameters:

  • organization_arn (String)

    The WorkMail organization ARN.

  • topic (AWSCDK::SNS::ITopic, nil) (defaults to: nil)

    The SNS topic to notify when the WorkMail action is taken.



9
10
11
12
13
14
# File 'ses_actions/work_mail_props.rb', line 9

def initialize(organization_arn:, topic: nil)
  @organization_arn = organization_arn
  Jsii::Type.check_type(@organization_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "organizationArn")
  @topic = topic
  Jsii::Type.check_type(@topic, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc25zLklUb3BpYyJ9")), "topic") unless @topic.nil?
end

Instance Attribute Details

#organization_arnString (readonly)

The WorkMail organization ARN.

Amazon WorkMail organization ARNs are in the form arn:aws:workmail:region:account_ID:organization/organization_ID

Examples:

"arn:aws:workmail:us-east-1:123456789012:organization/m-68755160c4cb4e29a2b2f8fb58f359d7"

Returns:

  • (String)


24
25
26
# File 'ses_actions/work_mail_props.rb', line 24

def organization_arn
  @organization_arn
end

#topicAWSCDK::SNS::ITopic? (readonly)

Note:

Default: - no topic will be attached to the action

The SNS topic to notify when the WorkMail action is taken.

Returns:



29
30
31
# File 'ses_actions/work_mail_props.rb', line 29

def topic
  @topic
end

Class Method Details

.jsii_propertiesObject



31
32
33
34
35
36
# File 'ses_actions/work_mail_props.rb', line 31

def self.jsii_properties
  {
    :organization_arn => "organizationArn",
    :topic => "topic",
  }
end

Instance Method Details

#to_jsiiObject



38
39
40
41
42
43
44
45
# File 'ses_actions/work_mail_props.rb', line 38

def to_jsii
  result = {}
  result.merge!({
    "organizationArn" => @organization_arn,
    "topic" => @topic,
  })
  result.compact
end