@Generated(value="software.amazon.awssdk:codegen") public final class CloudWatchDimensionConfiguration extends Object implements 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.
Modifier and Type | Class and Description |
---|---|
static interface |
CloudWatchDimensionConfiguration.Builder |
Modifier and Type | Method and 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) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
static Class<? extends CloudWatchDimensionConfiguration.Builder> |
serializableBuilderClass() |
CloudWatchDimensionConfiguration.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
copy
public String dimensionName()
The name of an Amazon CloudWatch dimension associated with an email sending metric. The name must:
Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).
Contain less than 256 characters.
Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).
Contain less than 256 characters.
public DimensionValueSource dimensionValueSource()
The place where Amazon SES finds the value of a dimension to publish to Amazon CloudWatch. If you want Amazon SES
to use the message tags that you specify using an X-SES-MESSAGE-TAGS
header or a parameter to the
SendEmail
/SendRawEmail
API, choose messageTag
. If you want Amazon SES to
use your own email headers, choose emailHeader
.
If the service returns an enum value that is not available in the current SDK version,
dimensionValueSource
will return DimensionValueSource.UNKNOWN_TO_SDK_VERSION
. The raw value
returned by the service is available from dimensionValueSourceAsString()
.
X-SES-MESSAGE-TAGS
header or a
parameter to the SendEmail
/SendRawEmail
API, choose messageTag
. If
you want Amazon SES to use your own email headers, choose emailHeader
.DimensionValueSource
public String dimensionValueSourceAsString()
The place where Amazon SES finds the value of a dimension to publish to Amazon CloudWatch. If you want Amazon SES
to use the message tags that you specify using an X-SES-MESSAGE-TAGS
header or a parameter to the
SendEmail
/SendRawEmail
API, choose messageTag
. If you want Amazon SES to
use your own email headers, choose emailHeader
.
If the service returns an enum value that is not available in the current SDK version,
dimensionValueSource
will return DimensionValueSource.UNKNOWN_TO_SDK_VERSION
. The raw value
returned by the service is available from dimensionValueSourceAsString()
.
X-SES-MESSAGE-TAGS
header or a
parameter to the SendEmail
/SendRawEmail
API, choose messageTag
. If
you want Amazon SES to use your own email headers, choose emailHeader
.DimensionValueSource
public 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:
Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).
Contain less than 256 characters.
Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).
Contain less than 256 characters.
public CloudWatchDimensionConfiguration.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<CloudWatchDimensionConfiguration.Builder,CloudWatchDimensionConfiguration>
public static CloudWatchDimensionConfiguration.Builder builder()
public static Class<? extends CloudWatchDimensionConfiguration.Builder> serializableBuilderClass()
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.