Class: AWSCDK::SES::CfnMailManagerRuleSet::AddHeaderActionProperty

Inherits:

Jsii::Struct

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

Defined in:

ses/cfn_mail_manager_rule_set.rb

Overview

The action to add a header to a message.

When executed, this action will add the given header to the message.

See Also:

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

Instance Attribute Summary

• #header_name ⇒ String readonly

  The name of the header to add to an email.

• #header_value ⇒ String readonly

  The value of the header to add to the email.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(header_name:, header_value:) ⇒ AddHeaderActionProperty constructor

  A new instance of AddHeaderActionProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(header_name:, header_value:) ⇒ AddHeaderActionProperty

Returns a new instance of AddHeaderActionProperty.

Parameters:

• header_name (String) —

  The name of the header to add to an email.

• header_value (String) —

  The value of the header to add to the email.

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

def initialize(header_name:, header_value:)
  @header_name = header_name
  Jsii::Type.check_type(@header_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "headerName")
  @header_value = header_value
  Jsii::Type.check_type(@header_value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "headerValue")
end

Instance Attribute Details

#header_name ⇒ String (readonly)

The name of the header to add to an email.

The header must be prefixed with "X-". Headers are added regardless of whether the header name pre-existed in the email.

Returns:

• (String)

See Also:

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

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

def header_name
  @header_name
end

#header_value ⇒ String (readonly)

The value of the header to add to the email.

Returns:

• (String)

See Also:

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

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

def header_value
  @header_value
end

Class Method Details

.jsii_properties ⇒ Object

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

def self.jsii_properties
  {
    :header_name => "headerName",
    :header_value => "headerValue",
  }
end

Instance Method Details

#to_jsii ⇒ Object

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

def to_jsii
  result = {}
  result.merge!({
    "headerName" => @header_name,
    "headerValue" => @header_value,
  })
  result.compact
end