com.amazonaws.services.simpleemail.model

Class CloudWatchDimensionConfiguration

java.lang.Object

com.amazonaws.services.simpleemail.model.CloudWatchDimensionConfiguration

All Implemented Interfaces:

java.io.Serializable

public class CloudWatchDimensionConfiguration
extends java.lang.Object
implements java.io.Serializable

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

Constructor Summary

Constructors

Constructor and Description
CloudWatchDimensionConfiguration()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.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.
java.lang.String	getDimensionName() The name of an Amazon CloudWatch dimension associated with an email sending metric.
java.lang.String	getDimensionValueSource() The place where Amazon SES finds the value of a dimension to publish to Amazon CloudWatch.
int	hashCode()
void	setDefaultDimensionValue(java.lang.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.
void	setDimensionName(java.lang.String dimensionName) The name of an Amazon CloudWatch dimension associated with an email sending metric.
void	setDimensionValueSource(DimensionValueSource dimensionValueSource) The place where Amazon SES finds the value of a dimension to publish to Amazon CloudWatch.
void	setDimensionValueSource(java.lang.String dimensionValueSource) The place where Amazon SES finds the value of a dimension to publish to Amazon CloudWatch.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
CloudWatchDimensionConfiguration	withDefaultDimensionValue(java.lang.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.
CloudWatchDimensionConfiguration	withDimensionName(java.lang.String dimensionName) The name of an Amazon CloudWatch dimension associated with an email sending metric.
CloudWatchDimensionConfiguration	withDimensionValueSource(DimensionValueSource dimensionValueSource) The place where Amazon SES finds the value of a dimension to publish to Amazon CloudWatch.
CloudWatchDimensionConfiguration	withDimensionValueSource(java.lang.String dimensionValueSource) The place where Amazon SES finds the value of a dimension to publish to Amazon CloudWatch.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CloudWatchDimensionConfiguration

public CloudWatchDimensionConfiguration()

Method Detail

getDimensionName

public java.lang.String getDimensionName()

The name of an Amazon CloudWatch dimension associated with an email sending metric. The name must:

• This value can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).

• Contain less than 256 characters.

Returns:

The name of an Amazon CloudWatch dimension associated with an email sending metric. The name must:

• This value can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).

• Contain less than 256 characters.

setDimensionName

public void setDimensionName(java.lang.String dimensionName)

The name of an Amazon CloudWatch dimension associated with an email sending metric. The name must:

• This value can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).

• Contain less than 256 characters.

Parameters:

dimensionName -

The name of an Amazon CloudWatch dimension associated with an email sending metric. The name must:

• This value can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).

• Contain less than 256 characters.

withDimensionName

public CloudWatchDimensionConfiguration withDimensionName(java.lang.String dimensionName)

The name of an Amazon CloudWatch dimension associated with an email sending metric. The name must:

• This value can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).

• Contain less than 256 characters.

Returns a reference to this object so that method calls can be chained together.

Parameters:

dimensionName -

The name of an Amazon CloudWatch dimension associated with an email sending metric. The name must:

• This value can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).

• Contain less than 256 characters.

Returns:

A reference to this updated object so that method calls can be chained together.

getDimensionValueSource

public java.lang.String getDimensionValueSource()

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.

Constraints:
Allowed Values: messageTag, emailHeader, linkTag

Returns:

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.

See Also:

DimensionValueSource

setDimensionValueSource

public void setDimensionValueSource(java.lang.String 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.

Constraints:
Allowed Values: messageTag, emailHeader, linkTag

Parameters:

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.

See Also:

DimensionValueSource

withDimensionValueSource

public CloudWatchDimensionConfiguration withDimensionValueSource(java.lang.String 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.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: messageTag, emailHeader, linkTag

Parameters:

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.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

DimensionValueSource

setDimensionValueSource

public void setDimensionValueSource(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.

Constraints:
Allowed Values: messageTag, emailHeader, linkTag

Parameters:

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.

See Also:

DimensionValueSource

withDimensionValueSource

public CloudWatchDimensionConfiguration withDimensionValueSource(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.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: messageTag, emailHeader, linkTag

Parameters:

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.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

DimensionValueSource

getDefaultDimensionValue

public java.lang.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:

• This value can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).

• Contain less than 256 characters.

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:

• This value can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).

• Contain less than 256 characters.

setDefaultDimensionValue

public void setDefaultDimensionValue(java.lang.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:

• This value can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).

• Contain less than 256 characters.

Parameters:

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:

• This value can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).

• Contain less than 256 characters.

withDefaultDimensionValue

public CloudWatchDimensionConfiguration withDefaultDimensionValue(java.lang.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:

• This value can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).

• Contain less than 256 characters.

Returns a reference to this object so that method calls can be chained together.

Parameters:

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:

• This value can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).

• Contain less than 256 characters.

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public java.lang.String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object