class Aws::PinpointEmail::Types::CloudWatchDimensionConfiguration
An object that defines the dimension configuration to use when you send Amazon Pinpoint email events to Amazon CloudWatch.
@note When making an API call, you may pass CloudWatchDimensionConfiguration
data as a hash: { dimension_name: "DimensionName", # required dimension_value_source: "MESSAGE_TAG", # required, accepts MESSAGE_TAG, EMAIL_HEADER, LINK_TAG default_dimension_value: "DefaultDimensionValue", # required }
@!attribute [rw] dimension_name
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. @return [String]
@!attribute [rw] dimension_value_source
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`. @return [String]
@!attribute [rw] default_dimension_value
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. @return [String]
@see docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/CloudWatchDimensionConfiguration AWS API Documentation
Constants
- SENSITIVE