Package software.amazon.awscdk.services.ses

Enum CloudWatchDimensionSource

java.lang.Object

java.lang.Enum<CloudWatchDimensionSource>

software.amazon.awscdk.services.ses.CloudWatchDimensionSource

All Implemented Interfaces:

Serializable, Comparable<CloudWatchDimensionSource>, java.lang.constant.Constable

@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)",
           date="2024-10-11T15:56:06.312Z")
@Stability(Stable)
public enum CloudWatchDimensionSource
extends Enum<CloudWatchDimensionSource>

Source for CloudWatch dimension.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
EMAIL_HEADER	Amazon SES retrieves the dimension name and value from a header in the email.
LINK_TAG	Amazon SES retrieves the dimension name and value from a tag that you specified in a link.
MESSAGE_TAG	Amazon SES retrieves the dimension name and value from a tag that you specify by using the X-SES-MESSAGE-TAGS header or the Tags API parameter.

Method Summary

Modifier and Type	Method	Description
static CloudWatchDimensionSource	valueOf(String name)	Returns the enum constant of this type with the specified name.
static CloudWatchDimensionSource[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

EMAIL_HEADER

@Stability(Stable)
public static final CloudWatchDimensionSource EMAIL_HEADER

Amazon SES retrieves the dimension name and value from a header in the email.

Note: You can't use any of the following email headers as the Dimension Name: Received, To, From, DKIM-Signature, CC, message-id, or Return-Path.

LINK_TAG

@Stability(Stable)
public static final CloudWatchDimensionSource LINK_TAG

Amazon SES retrieves the dimension name and value from a tag that you specified in a link.

See Also:

• https://docs.aws.amazon.com/ses/latest/dg/faqs-metrics.html#sending-metric-faqs-clicks-q5

MESSAGE_TAG

@Stability(Stable)
public static final CloudWatchDimensionSource MESSAGE_TAG

Amazon SES retrieves the dimension name and value from a tag that you specify by using the X-SES-MESSAGE-TAGS header or the Tags API parameter.

You can also use the Message Tag value source to create dimensions based on Amazon SES auto-tags. To use an auto-tag, type the complete name of the auto-tag as the Dimension Name. For example, to create a dimension based on the configuration set auto-tag, use ses:configuration-set for the Dimension Name, and the name of the configuration set for the Default Value.

See Also:

• https://docs.aws.amazon.com/ses/latest/dg/monitor-using-event-publishing.html#event-publishing-how-works

Method Details

values

public static CloudWatchDimensionSource[] values()

Returns an array containing the constants of this enum type, in the order they are declared.

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static CloudWatchDimensionSource valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null