Class: AWSCDK::PinpointEmail::CfnConfigurationSetEventDestination::DimensionConfigurationProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
pinpoint_email/cfn_configuration_set_event_destination.rb

Overview

An array of objects that define the dimensions to use when you send email events to Amazon CloudWatch.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(default_dimension_value:, dimension_name:, dimension_value_source:) ⇒ DimensionConfigurationProperty

Returns a new instance of DimensionConfigurationProperty.

Parameters:

  • default_dimension_value (String) —

    The default value of the dimension that is published to Amazon CloudWatch if you don't provide the value of the dimension when you send an email.

  • dimension_name (String) —

    The name of an Amazon CloudWatch dimension associated with an email sending metric.

  • dimension_value_source (String) —

    The location where Amazon Pinpoint finds the value of a dimension to publish to Amazon CloudWatch.



566
567
568
569
570
571
572
573
 
# File 'pinpoint_email/cfn_configuration_set_event_destination.rb', line 566

def initialize(default_dimension_value:, dimension_name:, dimension_value_source:)
  @default_dimension_value = default_dimension_value
  Jsii::Type.check_type(@default_dimension_value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "defaultDimensionValue")
  @dimension_name = dimension_name
  Jsii::Type.check_type(@dimension_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "dimensionName")
  @dimension_value_source = dimension_value_source
  Jsii::Type.check_type(@dimension_value_source, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "dimensionValueSource")
end

Instance Attribute Details

#default_dimension_value ⇒ String (readonly)

The default value of the dimension that is published to Amazon CloudWatch if you don't provide the value of the dimension when you send an email.

This value has to meet the following criteria:

  • It can only contain ASCII letters (a–z, A–Z), numbers (0–9), underscores (_), or dashes (-).
  • It can contain no more than 256 characters.

Returns:

  • (String)

See Also:



584
585
586
 
# File 'pinpoint_email/cfn_configuration_set_event_destination.rb', line 584

def default_dimension_value
  @default_dimension_value
end

#dimension_name ⇒ String (readonly)

The name of an Amazon CloudWatch dimension associated with an email sending metric.

The name has to meet the following criteria:

  • It can only contain ASCII letters (a–z, A–Z), numbers (0–9), underscores (_), or dashes (-).
  • It can contain no more than 256 characters.

Returns:

  • (String)

See Also:



594
595
596
 
# File 'pinpoint_email/cfn_configuration_set_event_destination.rb', line 594

def dimension_name
  @dimension_name
end

#dimension_value_source ⇒ String (readonly)

The location where Amazon Pinpoint finds the value of a dimension to publish to Amazon CloudWatch.

Acceptable values: MESSAGE_TAG , EMAIL_HEADER , and LINK_TAG .

If you want Amazon Pinpoint to use the message tags that you specify using an X-SES-MESSAGE-TAGS header or a parameter to the SendEmail API, choose MESSAGE_TAG . If you want Amazon Pinpoint to use your own email headers, choose EMAIL_HEADER . If you want Amazon Pinpoint to use tags that are specified in your links, choose LINK_TAG .

Returns:

  • (String)

See Also:



603
604
605
 
# File 'pinpoint_email/cfn_configuration_set_event_destination.rb', line 603

def dimension_value_source
  @dimension_value_source
end

Class Method Details

.jsii_properties ⇒ Object 



605
606
607
608
609
610
611
 
# File 'pinpoint_email/cfn_configuration_set_event_destination.rb', line 605

def self.jsii_properties
  {
    :default_dimension_value => "defaultDimensionValue",
    :dimension_name => "dimensionName",
    :dimension_value_source => "dimensionValueSource",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



613
614
615
616
617
618
619
620
621
 
# File 'pinpoint_email/cfn_configuration_set_event_destination.rb', line 613

def to_jsii
  result = {}
  result.merge!({
    "defaultDimensionValue" => @default_dimension_value,
    "dimensionName" => @dimension_name,
    "dimensionValueSource" => @dimension_value_source,
  })
  result.compact
end