Class: AWSCDK::PinpointEmail::CfnConfigurationSet::TrackingOptionsProperty

Inherits:

Jsii::Struct

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

Defined in:

pinpoint_email/cfn_configuration_set.rb

Overview

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

When you use Amazon Pinpoint 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.

These images and links include references to a domain operated by AWS . You can optionally configure Amazon Pinpoint to use a domain that you operate for these images and links.

See Also:

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

Instance Attribute Summary

• #custom_redirect_domain ⇒ String^? readonly

  The domain that you want to use for tracking open and click events.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(custom_redirect_domain: nil) ⇒ TrackingOptionsProperty constructor

  A new instance of TrackingOptionsProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(custom_redirect_domain: nil) ⇒ TrackingOptionsProperty

Returns a new instance of TrackingOptionsProperty.

Parameters:

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

  The domain that you want to use for tracking open and click events.

# File 'pinpoint_email/cfn_configuration_set.rb', line 686

def initialize(custom_redirect_domain: 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?
end

Instance Attribute Details

#custom_redirect_domain ⇒ String^? (readonly)

The domain that you want to use for tracking open and click events.

Returns:

• (String, nil)

See Also:

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

# File 'pinpoint_email/cfn_configuration_set.rb', line 695

def custom_redirect_domain
  @custom_redirect_domain
end

Class Method Details

.jsii_properties ⇒ Object

# File 'pinpoint_email/cfn_configuration_set.rb', line 697

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

Instance Method Details

#to_jsii ⇒ Object

# File 'pinpoint_email/cfn_configuration_set.rb', line 703

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