DimensionConfigurationProperty Struct
An object that defines the dimension configuration to use when you send email events to Amazon CloudWatch.
| Source | |
|---|---|
| Type last changed |
Example
ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_ses as ses } from 'aws-cdk-lib';
const dimensionConfigurationProperty: ses.CfnConfigurationSetEventDestination.DimensionConfigurationProperty = {
defaultDimensionValue: 'defaultDimensionValue',
dimensionName: 'dimensionName',
dimensionValueSource: 'dimensionValueSource',
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_ses as ses
dimension_configuration_property = ses.CfnConfigurationSetEventDestination.DimensionConfigurationProperty(
default_dimension_value="defaultDimensionValue",
dimension_name="dimensionName",
dimension_value_source="dimensionValueSource"
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.ses.*;
DimensionConfigurationProperty dimensionConfigurationProperty = DimensionConfigurationProperty.builder()
.defaultDimensionValue("defaultDimensionValue")
.dimensionName("dimensionName")
.dimensionValueSource("dimensionValueSource")
.build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.SES;
var dimensionConfigurationProperty = new DimensionConfigurationProperty {
DefaultDimensionValue = "defaultDimensionValue",
DimensionName = "dimensionName",
DimensionValueSource = "dimensionValueSource"
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
dimensionConfigurationProperty := &DimensionConfigurationProperty{
DefaultDimensionValue: jsii.String("defaultDimensionValue"),
DimensionName: jsii.String("dimensionName"),
DimensionValueSource: jsii.String("dimensionValueSource"),
}
Properties
defaultDimensionValuestringdefault_dimension_valuestrdefaultDimensionValueStringDefaultDimensionValuestringDefaultDimensionValue*string required #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:
- Can only contain ASCII letters (a–z, A–Z), numbers (0–9), underscores (_), or dashes (-), at signs (@), and periods (.).
- It can contain no more than 256 characters.
dimensionNamestringdimension_namestrdimensionNameStringDimensionNamestringDimensionName*string required #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.
dimensionValueSourcestringdimension_value_sourcestrdimensionValueSourceStringDimensionValueSourcestringDimensionValueSource*string required #The location where the Amazon SES API v2 finds the value of a dimension to publish to Amazon CloudWatch.
notes
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 . To use your own email headers, choose emailHeader . To use link tags, choose linkTag .