Class: AWSCDK::SES::CfnMailManagerRuleSet::DeliverToMailboxActionProperty

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

Overview

This action to delivers an email to a mailbox.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(mailbox_arn:, role_arn:, action_failure_policy: nil) ⇒ DeliverToMailboxActionProperty

Returns a new instance of DeliverToMailboxActionProperty.

Parameters:

  • mailbox_arn (String) —

    The Amazon Resource Name (ARN) of a WorkMail organization to deliver the email to.

  • role_arn (String) —

    The Amazon Resource Name (ARN) of an IAM role to use to execute this action.

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

    A policy that states what to do in the case of failure.



793
794
795
796
797
798
799
800
 
# File 'ses/cfn_mail_manager_rule_set.rb', line 793

def initialize(mailbox_arn:, role_arn:, action_failure_policy: nil)
  @mailbox_arn = mailbox_arn
  Jsii::Type.check_type(@mailbox_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "mailboxArn")
  @role_arn = role_arn
  Jsii::Type.check_type(@role_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "roleArn")
  @action_failure_policy = action_failure_policy
  Jsii::Type.check_type(@action_failure_policy, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "actionFailurePolicy") unless @action_failure_policy.nil?
end

Instance Attribute Details

#action_failure_policy ⇒ String? (readonly)

A policy that states what to do in the case of failure.

The action will fail if there are configuration errors. For example, the mailbox ARN is no longer valid.

Returns:

  • (String, nil)

See Also:



820
821
822
 
# File 'ses/cfn_mail_manager_rule_set.rb', line 820

def action_failure_policy
  @action_failure_policy
end

#mailbox_arn ⇒ String (readonly)

The Amazon Resource Name (ARN) of a WorkMail organization to deliver the email to.

Returns:

  • (String)

See Also:



806
807
808
 
# File 'ses/cfn_mail_manager_rule_set.rb', line 806

def mailbox_arn
  @mailbox_arn
end

#role_arn ⇒ String (readonly)

The Amazon Resource Name (ARN) of an IAM role to use to execute this action.

The role must have access to the workmail:DeliverToMailbox API.

Returns:

  • (String)

See Also:



813
814
815
 
# File 'ses/cfn_mail_manager_rule_set.rb', line 813

def role_arn
  @role_arn
end

Class Method Details

.jsii_properties ⇒ Object 



822
823
824
825
826
827
828
 
# File 'ses/cfn_mail_manager_rule_set.rb', line 822

def self.jsii_properties
  {
    :mailbox_arn => "mailboxArn",
    :role_arn => "roleArn",
    :action_failure_policy => "actionFailurePolicy",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



830
831
832
833
834
835
836
837
838
 
# File 'ses/cfn_mail_manager_rule_set.rb', line 830

def to_jsii
  result = {}
  result.merge!({
    "mailboxArn" => @mailbox_arn,
    "roleArn" => @role_arn,
    "actionFailurePolicy" => @action_failure_policy,
  })
  result.compact
end