Class: AWSCDK::SES::CfnReceiptRule::WorkmailActionProperty

Inherits:

Jsii::Struct

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

Defined in:

ses/cfn_receipt_rule.rb

Overview

When included in a receipt rule, this action calls Amazon WorkMail and, optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS).

It usually isn't necessary to set this up manually, because Amazon WorkMail adds the rule automatically during its setup procedure.

For information using a receipt rule to call Amazon WorkMail, see the Amazon SES Developer Guide .

See Also:

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

Instance Attribute Summary

• #organization_arn ⇒ String readonly

  The Amazon Resource Name (ARN) of the Amazon WorkMail organization.

• #topic_arn ⇒ String^? readonly

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

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(organization_arn:, topic_arn: nil) ⇒ WorkmailActionProperty constructor

  A new instance of WorkmailActionProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(organization_arn:, topic_arn: nil) ⇒ WorkmailActionProperty

Returns a new instance of WorkmailActionProperty.

Parameters:

• organization_arn (String) —

  The Amazon Resource Name (ARN) of the Amazon WorkMail organization. Amazon WorkMail ARNs use the following format:.

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

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

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

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

#organization_arn ⇒ String (readonly)

The Amazon Resource Name (ARN) of the Amazon WorkMail organization. Amazon WorkMail ARNs use the following format:.

arn:aws:workmail:<region>:<awsAccountId>:organization/<workmailOrganizationId>

You can find the ID of your organization by using the ListOrganizations operation in Amazon WorkMail. Amazon WorkMail organization IDs begin with " m- ", followed by a string of alphanumeric characters.

For information about Amazon WorkMail organizations, see the Amazon WorkMail Administrator Guide .

Returns:

• (String)

See Also:

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

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

def organization_arn
  @organization_arn
end

#topic_arn ⇒ String^? (readonly)

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

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

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-workmailaction.html#cfn-ses-receiptrule-workmailaction-topicarn

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

def topic_arn
  @topic_arn
end

Class Method Details

.jsii_properties ⇒ Object

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

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

Instance Method Details

#to_jsii ⇒ Object

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

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