CloudWatchDimensionConfiguration (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.pinpointemail.model.CloudWatchDimensionConfiguration

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CloudWatchDimensionConfiguration
extends Object
implements Serializable, Cloneable, StructuredPojo
```
An object that defines the dimension configuration to use when you send Amazon Pinpoint email events to Amazon CloudWatch.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

CloudWatchDimensionConfiguration()

Constructors
Constructor and Description
`CloudWatchDimensionConfiguration()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CloudWatchDimensionConfiguration`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getDefaultDimensionValue()` The default value of the dimension that is published to Amazon CloudWatch if you don't provide the value of the dimension when you send an email.
`String`	`getDimensionName()` The name of an Amazon CloudWatch dimension associated with an email sending metric.
`String`	`getDimensionValueSource()` The location where Amazon Pinpoint finds the value of a dimension to publish to Amazon CloudWatch.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setDefaultDimensionValue(String defaultDimensionValue)` The default value of the dimension that is published to Amazon CloudWatch if you don't provide the value of the dimension when you send an email.
`void`	`setDimensionName(String dimensionName)` The name of an Amazon CloudWatch dimension associated with an email sending metric.
`void`	`setDimensionValueSource(String dimensionValueSource)` The location where Amazon Pinpoint finds the value of a dimension to publish to Amazon CloudWatch.
`String`	`toString()` Returns a string representation of this object.
`CloudWatchDimensionConfiguration`	`withDefaultDimensionValue(String defaultDimensionValue)` The default value of the dimension that is published to Amazon CloudWatch if you don't provide the value of the dimension when you send an email.
`CloudWatchDimensionConfiguration`	`withDimensionName(String dimensionName)` The name of an Amazon CloudWatch dimension associated with an email sending metric.
`CloudWatchDimensionConfiguration`	`withDimensionValueSource(DimensionValueSource dimensionValueSource)` The location where Amazon Pinpoint finds the value of a dimension to publish to Amazon CloudWatch.
`CloudWatchDimensionConfiguration`	`withDimensionValueSource(String dimensionValueSource)` The location where Amazon Pinpoint 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
  - setDimensionName
```
public void setDimensionName(String dimensionName)
```
    The name of an Amazon CloudWatch dimension associated with an email sending metric. The name has to meet the following criteria:
    - It can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).
    - It can contain no more than 256 characters.
    Parameters:
    dimensionName - The name of an Amazon CloudWatch dimension associated with an email sending metric. The name has to meet the following criteria:
    
    It can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).
    
    It can contain no more than 256 characters.
  - getDimensionName
```
public String getDimensionName()
```
    The name of an Amazon CloudWatch dimension associated with an email sending metric. The name has to meet the following criteria:
    - It can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).
    - It can contain no more than 256 characters.
    Returns:
    The name of an Amazon CloudWatch dimension associated with an email sending metric. The name has to meet the following criteria:
    
    It can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).
    
    It can contain no more than 256 characters.
  - withDimensionName
```
public CloudWatchDimensionConfiguration withDimensionName(String dimensionName)
```
    The name of an Amazon CloudWatch dimension associated with an email sending metric. The name has to meet the following criteria:
    - It can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).
    - It can contain no more than 256 characters.
    Parameters:
    dimensionName - The name of an Amazon CloudWatch dimension associated with an email sending metric. The name has to meet the following criteria:
    
    It can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).
    
    It can contain no more than 256 characters.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDimensionValueSource
```
public void setDimensionValueSource(String dimensionValueSource)
```
    The location where Amazon Pinpoint finds the value of a dimension to publish to Amazon CloudWatch. If you want Amazon Pinpoint 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 Pinpoint to use your own email headers, choose emailHeader. If you want Amazon Pinpoint to use link tags, choose linkTags.
    
    Parameters:
    
    dimensionValueSource - The location where Amazon Pinpoint finds the value of a dimension to publish to Amazon CloudWatch. If you want Amazon Pinpoint 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 Pinpoint to use your own email headers, choose emailHeader. If you want Amazon Pinpoint to use link tags, choose linkTags.
    
    See Also:
    
    DimensionValueSource
  - getDimensionValueSource
```
public String getDimensionValueSource()
```
    The location where Amazon Pinpoint finds the value of a dimension to publish to Amazon CloudWatch. If you want Amazon Pinpoint 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 Pinpoint to use your own email headers, choose emailHeader. If you want Amazon Pinpoint to use link tags, choose linkTags.
    
    Returns:
    
    The location where Amazon Pinpoint finds the value of a dimension to publish to Amazon CloudWatch. If you want Amazon Pinpoint 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 Pinpoint to use your own email headers, choose emailHeader. If you want Amazon Pinpoint to use link tags, choose linkTags.
    
    See Also:
    
    DimensionValueSource
  - withDimensionValueSource
```
public CloudWatchDimensionConfiguration withDimensionValueSource(String dimensionValueSource)
```
    The location where Amazon Pinpoint finds the value of a dimension to publish to Amazon CloudWatch. If you want Amazon Pinpoint 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 Pinpoint to use your own email headers, choose emailHeader. If you want Amazon Pinpoint to use link tags, choose linkTags.
    
    Parameters:
    
    dimensionValueSource - The location where Amazon Pinpoint finds the value of a dimension to publish to Amazon CloudWatch. If you want Amazon Pinpoint 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 Pinpoint to use your own email headers, choose emailHeader. If you want Amazon Pinpoint to use link tags, choose linkTags.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    DimensionValueSource
  - withDimensionValueSource
```
public CloudWatchDimensionConfiguration withDimensionValueSource(DimensionValueSource dimensionValueSource)
```
    The location where Amazon Pinpoint finds the value of a dimension to publish to Amazon CloudWatch. If you want Amazon Pinpoint 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 Pinpoint to use your own email headers, choose emailHeader. If you want Amazon Pinpoint to use link tags, choose linkTags.
    
    Parameters:
    
    dimensionValueSource - The location where Amazon Pinpoint finds the value of a dimension to publish to Amazon CloudWatch. If you want Amazon Pinpoint 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 Pinpoint to use your own email headers, choose emailHeader. If you want Amazon Pinpoint to use link tags, choose linkTags.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    DimensionValueSource
  - setDefaultDimensionValue
```
public void setDefaultDimensionValue(String defaultDimensionValue)
```
    The default value of the dimension that is published to Amazon CloudWatch if you don't provide the value of the dimension when you send an email. This value has to meet the following criteria:
    - It can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).
    - It can contain no more than 256 characters.
    Parameters:
    defaultDimensionValue - The default value of the dimension that is published to Amazon CloudWatch if you don't provide the value of the dimension when you send an email. This value has to meet the following criteria:
    
    It can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).
    
    It can contain no more than 256 characters.
  - getDefaultDimensionValue
```
public String getDefaultDimensionValue()
```
    The default value of the dimension that is published to Amazon CloudWatch if you don't provide the value of the dimension when you send an email. This value has to meet the following criteria:
    - It can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).
    - It can contain no more than 256 characters.
    Returns:
    The default value of the dimension that is published to Amazon CloudWatch if you don't provide the value of the dimension when you send an email. This value has to meet the following criteria:
    
    It can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).
    
    It can contain no more than 256 characters.
  - withDefaultDimensionValue
```
public CloudWatchDimensionConfiguration withDefaultDimensionValue(String defaultDimensionValue)
```
    The default value of the dimension that is published to Amazon CloudWatch if you don't provide the value of the dimension when you send an email. This value has to meet the following criteria:
    - It can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).
    - It can contain no more than 256 characters.
    Parameters:
    defaultDimensionValue - The default value of the dimension that is published to Amazon CloudWatch if you don't provide the value of the dimension when you send an email. This value has to meet the following criteria:
    
    It can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).
    
    It can contain no more than 256 characters.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public CloudWatchDimensionConfiguration clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class CloudWatchDimensionConfiguration

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CloudWatchDimensionConfiguration

Method Detail

setDimensionName

getDimensionName

withDimensionName

setDimensionValueSource

getDimensionValueSource

withDimensionValueSource

withDimensionValueSource

setDefaultDimensionValue

getDefaultDimensionValue

withDefaultDimensionValue

toString

equals

hashCode

clone

marshall