Class CloudWatchDimensionConfiguration
- java.lang.Object
-
- software.amazon.awssdk.services.ses.model.CloudWatchDimensionConfiguration
-
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<CloudWatchDimensionConfiguration.Builder,CloudWatchDimensionConfiguration>
@Generated("software.amazon.awssdk:codegen") public final class CloudWatchDimensionConfiguration extends Object implements SdkPojo, Serializable, ToCopyableBuilder<CloudWatchDimensionConfiguration.Builder,CloudWatchDimensionConfiguration>
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.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
CloudWatchDimensionConfiguration.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static CloudWatchDimensionConfiguration.Builder
builder()
String
defaultDimensionValue()
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.String
dimensionName()
The name of an Amazon CloudWatch dimension associated with an email sending metric.DimensionValueSource
dimensionValueSource()
The place where Amazon SES finds the value of a dimension to publish to Amazon CloudWatch.String
dimensionValueSourceAsString()
The place where Amazon SES finds the value of a dimension to publish to Amazon CloudWatch.boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
int
hashCode()
List<SdkField<?>>
sdkFields()
static Class<? extends CloudWatchDimensionConfiguration.Builder>
serializableBuilderClass()
CloudWatchDimensionConfiguration.Builder
toBuilder()
String
toString()
Returns a string representation of this object.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
dimensionName
public final String dimensionName()
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.
- Returns:
- 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.
-
-
-
dimensionValueSource
public final DimensionValueSource dimensionValueSource()
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 theSendEmail
/SendRawEmail
API, specifymessageTag
. To use your own email headers, specifyemailHeader
. To put a custom tag on any link included in your email, specifylinkTag
.If the service returns an enum value that is not available in the current SDK version,
dimensionValueSource
will returnDimensionValueSource.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromdimensionValueSourceAsString()
.- Returns:
- 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 theSendEmail
/SendRawEmail
API, specifymessageTag
. To use your own email headers, specifyemailHeader
. To put a custom tag on any link included in your email, specifylinkTag
. - See Also:
DimensionValueSource
-
dimensionValueSourceAsString
public final String dimensionValueSourceAsString()
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 theSendEmail
/SendRawEmail
API, specifymessageTag
. To use your own email headers, specifyemailHeader
. To put a custom tag on any link included in your email, specifylinkTag
.If the service returns an enum value that is not available in the current SDK version,
dimensionValueSource
will returnDimensionValueSource.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromdimensionValueSourceAsString()
.- Returns:
- 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 theSendEmail
/SendRawEmail
API, specifymessageTag
. To use your own email headers, specifyemailHeader
. To put a custom tag on any link included in your email, specifylinkTag
. - See Also:
DimensionValueSource
-
defaultDimensionValue
public final String defaultDimensionValue()
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.
- Returns:
- 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.
-
-
-
toBuilder
public CloudWatchDimensionConfiguration.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<CloudWatchDimensionConfiguration.Builder,CloudWatchDimensionConfiguration>
-
builder
public static CloudWatchDimensionConfiguration.Builder builder()
-
serializableBuilderClass
public static Class<? extends CloudWatchDimensionConfiguration.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
toString
public final String toString()
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
-
-