Class: AWSCDK::SES::CfnConfigurationSetEventDestination::DimensionConfigurationProperty

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

Overview

An object that defines the dimension configuration 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 the Amazon SES API v2 finds the value of a dimension to publish to Amazon CloudWatch.



553
554
555
556
557
558
559
560
 
# File 'ses/cfn_configuration_set_event_destination.rb', line 553

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:

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

Returns:

  • (String)

See Also:



571
572
573
 
# File 'ses/cfn_configuration_set_event_destination.rb', line 571

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:



581
582
583
 
# File 'ses/cfn_configuration_set_event_destination.rb', line 581

def dimension_name
  @dimension_name
end

#dimension_value_source ⇒ String (readonly)

The location where the Amazon SES API v2 finds the value of a dimension to publish to Amazon CloudWatch.

To use the message tags that you specify using an X-SES-MESSAGE-TAGS header or a parameter to the SendEmail or SendRawEmail API, choose message_tag . To use your own email headers, choose email_header . To use link tags, choose link_tag .

Returns:

  • (String)

See Also:



588
589
590
 
# File 'ses/cfn_configuration_set_event_destination.rb', line 588

def dimension_value_source
  @dimension_value_source
end

Class Method Details

.jsii_properties ⇒ Object 



590
591
592
593
594
595
596
 
# File 'ses/cfn_configuration_set_event_destination.rb', line 590

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

Instance Method Details

#to_jsii ⇒ Object 



598
599
600
601
602
603
604
605
606
 
# File 'ses/cfn_configuration_set_event_destination.rb', line 598

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