You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::PinpointEmail::Types::CloudWatchDimensionConfiguration
- Inherits:
-
Struct
- Object
- Struct
- Aws::PinpointEmail::Types::CloudWatchDimensionConfiguration
- Defined in:
- (unknown)
Overview
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 Amazon Pinpoint email events to Amazon CloudWatch.
Instance Attribute Summary collapse
-
#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.
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.
#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.
#dimension_value_source ⇒ String
The location where Amazon Pinpoint finds the value of a dimension to
publish to Amazon CloudWatch. 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/SendRawEmail API, choose messageTag
. If you
want Amazon Pinpoint to use your own email headers, choose
emailHeader
. If you want Amazon Pinpoint to use link tags, choose
linkTags
.
Possible values:
- MESSAGE_TAG
- EMAIL_HEADER
- LINK_TAG