1.204.0

interface DimensionConfigurationProperty

LanguageType name
.NETAmazon.CDK.AWS.PinpointEmail.CfnConfigurationSetEventDestination.DimensionConfigurationProperty
Javasoftware.amazon.awscdk.services.pinpointemail.CfnConfigurationSetEventDestination.DimensionConfigurationProperty
Pythonaws_cdk.aws_pinpointemail.CfnConfigurationSetEventDestination.DimensionConfigurationProperty
TypeScript @aws-cdk/aws-pinpointemail » CfnConfigurationSetEventDestination » DimensionConfigurationProperty

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as pinpointemail from '@aws-cdk/aws-pinpointemail';
const dimensionConfigurationProperty: pinpointemail.CfnConfigurationSetEventDestination.DimensionConfigurationProperty = {
  defaultDimensionValue: 'defaultDimensionValue',
  dimensionName: 'dimensionName',
  dimensionValueSource: 'dimensionValueSource',
};

Properties

NameTypeDescription
defaultDimensionValuestringThe 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.
dimensionNamestringThe name of an Amazon CloudWatch dimension associated with an email sending metric.
dimensionValueSourcestringThe location where Amazon Pinpoint finds the value of a dimension to publish to Amazon CloudWatch.

defaultDimensionValue

Type: 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.

dimensionName

Type: 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.

dimensionValueSource

Type: string

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 .

← PreviousNext →