interface DimensionConfigurationProperty
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.Mixins.Preview.AWS.PinpointEmail.Mixins.CfnConfigurationSetEventDestinationPropsMixin.DimensionConfigurationProperty |
 Go | github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awspinpointemail/mixins#CfnConfigurationSetEventDestinationPropsMixin_DimensionConfigurationProperty |
 Java | software.amazon.awscdk.mixins.preview.services.pinpointemail.mixins.CfnConfigurationSetEventDestinationPropsMixin.DimensionConfigurationProperty |
 Python | aws_cdk.mixins_preview.aws_pinpointemail.mixins.CfnConfigurationSetEventDestinationPropsMixin.DimensionConfigurationProperty |
 TypeScript | @aws-cdk/mixins-preview » aws_pinpointemail » mixins » CfnConfigurationSetEventDestinationPropsMixin » 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 { mixins as pinpointemail_mixins } from '@aws-cdk/mixins-preview/aws-pinpointemail';
const dimensionConfigurationProperty: pinpointemail_mixins.CfnConfigurationSetEventDestinationPropsMixin.DimensionConfigurationProperty = {
defaultDimensionValue: 'defaultDimensionValue',
dimensionName: 'dimensionName',
dimensionValueSource: 'dimensionValueSource',
};
Properties
| Name | Type | Description |
|---|---|---|
| default | 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 | string | The name of an Amazon CloudWatch dimension associated with an email sending metric. |
| dimension | string | The location where Amazon Pinpoint finds the value of a dimension to publish to Amazon CloudWatch. |
defaultDimensionValue?
Type:
string
(optional)
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
(optional)
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
(optional)
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 .