You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::SESV2::Types::CloudWatchDimensionConfiguration

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing CloudWatchDimensionConfiguration as input to an Aws::Client method, you can use a vanilla Hash:

{
  dimension_name: "DimensionName", # required
  dimension_value_source: "MESSAGE_TAG", # required, accepts MESSAGE_TAG, EMAIL_HEADER, LINK_TAG
  default_dimension_value: "DefaultDimensionValue", # required
}

An object that defines the dimension configuration to use when you send email events to Amazon CloudWatch.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#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. 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) —

    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. 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) —

    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. If you want 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 messageTag. If you want to use your own email headers, choose emailHeader. If you want to use link tags, choose linkTags.

Possible values:

  • MESSAGE_TAG
  • EMAIL_HEADER
  • LINK_TAG

Returns:

  • (String) —

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