Class: AWSCDK::SES::CfnConfigurationSet::TrackingOptionsProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::SES::CfnConfigurationSet::TrackingOptionsProperty

Defined in:

ses/cfn_configuration_set.rb

Overview

An object that defines the tracking options for a configuration set.

When you use the Amazon SES API v2 to send an email, it contains an invisible image that's used to track when recipients open your email. If your email contains links, those links are changed slightly in order to track when recipients click them.

You can optionally configure a custom subdomain that is used to redirect email recipients to an Amazon SES-operated domain. This domain captures open and click events generated by Amazon SES emails.

For more information, see Configuring Custom Domains to Handle Open and Click Tracking in the Amazon SES Developer Guide .

See Also:

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

Instance Attribute Summary

• #custom_redirect_domain ⇒ String^? readonly

  The custom subdomain that is used to redirect email recipients to the Amazon SES event tracking domain.

• #https_policy ⇒ String^? readonly

  The name of the configuration set used when sent through a configuration set with archiving enabled.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(custom_redirect_domain: nil, https_policy: nil) ⇒ TrackingOptionsProperty constructor

  A new instance of TrackingOptionsProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(custom_redirect_domain: nil, https_policy: nil) ⇒ TrackingOptionsProperty

Returns a new instance of TrackingOptionsProperty.

Parameters:

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

  The custom subdomain that is used to redirect email recipients to the Amazon SES event tracking domain.

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

  The name of the configuration set used when sent through a configuration set with archiving enabled.

# File 'ses/cfn_configuration_set.rb', line 1012

def initialize(custom_redirect_domain: nil, https_policy: nil)
  @custom_redirect_domain = custom_redirect_domain
  Jsii::Type.check_type(@custom_redirect_domain, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "customRedirectDomain") unless @custom_redirect_domain.nil?
  @https_policy = https_policy
  Jsii::Type.check_type(@https_policy, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "httpsPolicy") unless @https_policy.nil?
end

Instance Attribute Details

#custom_redirect_domain ⇒ String^? (readonly)

The custom subdomain that is used to redirect email recipients to the Amazon SES event tracking domain.

Returns:

• (String, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationset-trackingoptions.html#cfn-ses-configurationset-trackingoptions-customredirectdomain

# File 'ses/cfn_configuration_set.rb', line 1023

def custom_redirect_domain
  @custom_redirect_domain
end

#https_policy ⇒ String^? (readonly)

The name of the configuration set used when sent through a configuration set with archiving enabled.

Returns:

• (String, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationset-trackingoptions.html#cfn-ses-configurationset-trackingoptions-httpspolicy

# File 'ses/cfn_configuration_set.rb', line 1028

def https_policy
  @https_policy
end

Class Method Details

.jsii_properties ⇒ Object

# File 'ses/cfn_configuration_set.rb', line 1030

def self.jsii_properties
  {
    :custom_redirect_domain => "customRedirectDomain",
    :https_policy => "httpsPolicy",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'ses/cfn_configuration_set.rb', line 1037

def to_jsii
  result = {}
  result.merge!({
    "customRedirectDomain" => @custom_redirect_domain,
    "httpsPolicy" => @https_policy,
  })
  result.compact
end