Class: AWSCDK::SES::CfnMailManagerRuleSet::RelayActionProperty

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

Overview

The action relays the email via SMTP to another specific SMTP server.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(relay:, action_failure_policy: nil, mail_from: nil) ⇒ RelayActionProperty

Returns a new instance of RelayActionProperty.

Parameters:

  • relay (String) —

    The identifier of the relay resource to be used when relaying an email.

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

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

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

    This action specifies whether to preserve or replace original mail from address while relaying received emails to a destination server.



978
979
980
981
982
983
984
985
 
# File 'ses/cfn_mail_manager_rule_set.rb', line 978

def initialize(relay:, action_failure_policy: nil, mail_from: nil)
  @relay = relay
  Jsii::Type.check_type(@relay, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "relay")
  @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?
  @mail_from = mail_from
  Jsii::Type.check_type(@mail_from, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "mailFrom") unless @mail_from.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 specified relay has been deleted.

Returns:

  • (String, nil)

See Also:



998
999
1000
 
# File 'ses/cfn_mail_manager_rule_set.rb', line 998

def action_failure_policy
  @action_failure_policy
end

#mail_from ⇒ String? (readonly)

This action specifies whether to preserve or replace original mail from address while relaying received emails to a destination server.

Returns:

  • (String, nil)

See Also:



1003
1004
1005
 
# File 'ses/cfn_mail_manager_rule_set.rb', line 1003

def mail_from
  @mail_from
end

#relay ⇒ String (readonly)

The identifier of the relay resource to be used when relaying an email.

Returns:

  • (String)

See Also:



991
992
993
 
# File 'ses/cfn_mail_manager_rule_set.rb', line 991

def relay
  @relay
end

Class Method Details

.jsii_properties ⇒ Object 



1005
1006
1007
1008
1009
1010
1011
 
# File 'ses/cfn_mail_manager_rule_set.rb', line 1005

def self.jsii_properties
  {
    :relay => "relay",
    :action_failure_policy => "actionFailurePolicy",
    :mail_from => "mailFrom",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



1013
1014
1015
1016
1017
1018
1019
1020
1021
 
# File 'ses/cfn_mail_manager_rule_set.rb', line 1013

def to_jsii
  result = {}
  result.merge!({
    "relay" => @relay,
    "actionFailurePolicy" => @action_failure_policy,
    "mailFrom" => @mail_from,
  })
  result.compact
end