Package software.amazon.awscdk.services.ses

Interface CfnConfigurationSetEventDestination.DimensionConfigurationProperty

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnConfigurationSetEventDestination.DimensionConfigurationProperty.Jsii$Proxy
Enclosing class:
CfnConfigurationSetEventDestination
@Stability(Stable) public static interface CfnConfigurationSetEventDestination.DimensionConfigurationProperty extends software.amazon.jsii.JsiiSerializable
Contains the dimension configuration to use when you publish email sending events to Amazon CloudWatch.

For information about publishing email sending events to Amazon CloudWatch, see the Amazon SES Developer Guide .

Example: 

 // 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();

  • Method Details

    • getDefaultDimensionValue

      @Stability(Stable) @NotNull String getDefaultDimensionValue()
      The default value of the dimension that is published to Amazon CloudWatch if you do not provide the value of the dimension when you send an email.

      The default value must meet the following requirements:

      • Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), dashes (-), at signs (@), or periods (.).
      • Contain 256 characters or fewer.

    • getDimensionName

      @Stability(Stable) @NotNull String getDimensionName()
      The name of an Amazon CloudWatch dimension associated with an email sending metric.

      The name must meet the following requirements:

      • Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), dashes (-), or colons (:).
      • Contain 256 characters or fewer.

    • getDimensionValueSource

      @Stability(Stable) @NotNull String getDimensionValueSource()
      The place where Amazon SES finds the value of a dimension to publish to Amazon CloudWatch.

      To use the message tags that you specify using an X-SES-MESSAGE-TAGS header or a parameter to the SendEmail / SendRawEmail API, specify messageTag . To use your own email headers, specify emailHeader . To put a custom tag on any link included in your email, specify linkTag .

    • builder

      @Stability(Stable) static CfnConfigurationSetEventDestination.DimensionConfigurationProperty.Builder builder()
      Returns:
      a CfnConfigurationSetEventDestination.DimensionConfigurationProperty.Builder of CfnConfigurationSetEventDestination.DimensionConfigurationProperty