Class: AWSCDK::SES::CfnMailManagerRuleSet::ArchiveActionProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::SES::CfnMailManagerRuleSet::ArchiveActionProperty

Defined in:

ses/cfn_mail_manager_rule_set.rb

Overview

The action to archive the email by delivering the email to an Amazon SES archive.

See Also:

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

Instance Attribute Summary

• #action_failure_policy ⇒ String^? readonly

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

• #target_archive ⇒ String readonly

  The identifier of the archive to send the email to.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(target_archive:, action_failure_policy: nil) ⇒ ArchiveActionProperty constructor

  A new instance of ArchiveActionProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(target_archive:, action_failure_policy: nil) ⇒ ArchiveActionProperty

Returns a new instance of ArchiveActionProperty.

Parameters:

• target_archive (String) —

  The identifier of the archive to send the email to.

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

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

# File 'ses/cfn_mail_manager_rule_set.rb', line 670

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

Returns:

• (String, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-archiveaction.html#cfn-ses-mailmanagerruleset-archiveaction-actionfailurepolicy

# File 'ses/cfn_mail_manager_rule_set.rb', line 688

def action_failure_policy
  @action_failure_policy
end

#target_archive ⇒ String (readonly)

The identifier of the archive to send the email to.

Returns:

• (String)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-archiveaction.html#cfn-ses-mailmanagerruleset-archiveaction-targetarchive

# File 'ses/cfn_mail_manager_rule_set.rb', line 681

def target_archive
  @target_archive
end

Class Method Details

.jsii_properties ⇒ Object

# File 'ses/cfn_mail_manager_rule_set.rb', line 690

def self.jsii_properties
  {
    :target_archive => "targetArchive",
    :action_failure_policy => "actionFailurePolicy",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'ses/cfn_mail_manager_rule_set.rb', line 697

def to_jsii
  result = {}
  result.merge!({
    "targetArchive" => @target_archive,
    "actionFailurePolicy" => @action_failure_policy,
  })
  result.compact
end