Class: AWSCDK::SES::CfnReceiptRule::AddHeaderActionProperty

Inherits:

Jsii::Struct

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

Defined in:

ses/cfn_receipt_rule.rb

Overview

When included in a receipt rule, this action adds a header to the received email.

For information about adding a header using a receipt rule, see the Amazon SES Developer Guide .

See Also:

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

Instance Attribute Summary

• #header_name ⇒ String readonly

  The name of the header to add to the incoming message.

• #header_value ⇒ String readonly

  The content to include in the header.

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 the incoming message.

• header_value (String) —

  The content to include in the header.

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

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 the incoming message.

The name must contain at least one character, and can contain up to 50 characters. It consists of alphanumeric ( a–z, A–Z, 0–9 ) characters and dashes.

Returns:

• (String)

See Also:

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

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

def header_name
  @header_name
end

#header_value ⇒ String (readonly)

The content to include in the header.

This value can contain up to 2048 characters. It can't contain newline ( \n ) or carriage return ( \r ) characters.

Returns:

• (String)

See Also:

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

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

def header_value
  @header_value
end

Class Method Details

.jsii_properties ⇒ Object

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

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

Instance Method Details

#to_jsii ⇒ Object

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

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