CustomizedScalingMetricSpecification (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.autoscalingplans.model.CustomizedScalingMetricSpecification

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CustomizedScalingMetricSpecification
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Represents a CloudWatch metric of your choosing that can be used for dynamic scaling as part of a target tracking scaling policy.

To create your customized scaling metric specification:
- Add values for each required parameter from CloudWatch. You can use an existing metric, or a new metric that you create. To use your own metric, you must first publish the metric to CloudWatch. For more information, see Publish Custom Metrics in the Amazon CloudWatch User Guide.
- Choose a metric that changes proportionally with capacity. The value of the metric should increase or decrease in inverse proportion to the number of capacity units. That is, the value of the metric should decrease when capacity increases.
For information about terminology, available metrics, or how to publish new metrics, see Amazon CloudWatch Concepts in the Amazon CloudWatch User Guide.
See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

CustomizedScalingMetricSpecification()

Constructors
Constructor and Description
`CustomizedScalingMetricSpecification()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CustomizedScalingMetricSpecification`	`clone()`
`boolean`	`equals(Object obj)`
`List<MetricDimension>`	`getDimensions()` The dimensions of the metric.
`String`	`getMetricName()` The name of the metric.
`String`	`getNamespace()` The namespace of the metric.
`String`	`getStatistic()` The statistic of the metric.
`String`	`getUnit()` The unit of the metric.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setDimensions(Collection<MetricDimension> dimensions)` The dimensions of the metric.
`void`	`setMetricName(String metricName)` The name of the metric.
`void`	`setNamespace(String namespace)` The namespace of the metric.
`void`	`setStatistic(String statistic)` The statistic of the metric.
`void`	`setUnit(String unit)` The unit of the metric.
`String`	`toString()` Returns a string representation of this object.
`CustomizedScalingMetricSpecification`	`withDimensions(Collection<MetricDimension> dimensions)` The dimensions of the metric.
`CustomizedScalingMetricSpecification`	`withDimensions(MetricDimension... dimensions)` The dimensions of the metric.
`CustomizedScalingMetricSpecification`	`withMetricName(String metricName)` The name of the metric.
`CustomizedScalingMetricSpecification`	`withNamespace(String namespace)` The namespace of the metric.
`CustomizedScalingMetricSpecification`	`withStatistic(MetricStatistic statistic)` The statistic of the metric.
`CustomizedScalingMetricSpecification`	`withStatistic(String statistic)` The statistic of the metric.
`CustomizedScalingMetricSpecification`	`withUnit(String unit)` The unit of the metric.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - CustomizedScalingMetricSpecification
```
public CustomizedScalingMetricSpecification()
```
- Method Detail
  - setMetricName
```
public void setMetricName(String metricName)
```
    The name of the metric.
    
    Parameters:
    
    metricName - The name of the metric.
  - getMetricName
```
public String getMetricName()
```
    The name of the metric.
    
    Returns:
    
    The name of the metric.
  - withMetricName
```
public CustomizedScalingMetricSpecification withMetricName(String metricName)
```
    The name of the metric.
    
    Parameters:
    
    metricName - The name of the metric.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setNamespace
```
public void setNamespace(String namespace)
```
    The namespace of the metric.
    
    Parameters:
    
    namespace - The namespace of the metric.
  - getNamespace
```
public String getNamespace()
```
    The namespace of the metric.
    
    Returns:
    
    The namespace of the metric.
  - withNamespace
```
public CustomizedScalingMetricSpecification withNamespace(String namespace)
```
    The namespace of the metric.
    
    Parameters:
    
    namespace - The namespace of the metric.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getDimensions
```
public List<MetricDimension> getDimensions()
```
    The dimensions of the metric.
    
    Conditional: If you published your metric with dimensions, you must specify the same dimensions in your customized scaling metric specification.
    
    Returns:
    
    The dimensions of the metric.
    
    Conditional: If you published your metric with dimensions, you must specify the same dimensions in your customized scaling metric specification.
  - setDimensions
```
public void setDimensions(Collection<MetricDimension> dimensions)
```
    The dimensions of the metric.
    
    Conditional: If you published your metric with dimensions, you must specify the same dimensions in your customized scaling metric specification.
    
    Parameters:
    
    dimensions - The dimensions of the metric.
    
    Conditional: If you published your metric with dimensions, you must specify the same dimensions in your customized scaling metric specification.
  - withDimensions
```
public CustomizedScalingMetricSpecification withDimensions(MetricDimension... dimensions)
```
    The dimensions of the metric.
    
    Conditional: If you published your metric with dimensions, you must specify the same dimensions in your customized scaling metric specification.
    
    NOTE: This method appends the values to the existing list (if any). Use setDimensions(java.util.Collection) or withDimensions(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    dimensions - The dimensions of the metric.
    
    Conditional: If you published your metric with dimensions, you must specify the same dimensions in your customized scaling metric specification.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withDimensions
```
public CustomizedScalingMetricSpecification withDimensions(Collection<MetricDimension> dimensions)
```
    The dimensions of the metric.
    
    Conditional: If you published your metric with dimensions, you must specify the same dimensions in your customized scaling metric specification.
    
    Parameters:
    
    dimensions - The dimensions of the metric.
    
    Conditional: If you published your metric with dimensions, you must specify the same dimensions in your customized scaling metric specification.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStatistic
```
public void setStatistic(String statistic)
```
    The statistic of the metric.
    
    Parameters:
    
    statistic - The statistic of the metric.
    
    See Also:
    
    MetricStatistic
  - getStatistic
```
public String getStatistic()
```
    The statistic of the metric.
    
    Returns:
    
    The statistic of the metric.
    
    See Also:
    
    MetricStatistic
  - withStatistic
```
public CustomizedScalingMetricSpecification withStatistic(String statistic)
```
    The statistic of the metric.
    
    Parameters:
    
    statistic - The statistic of the metric.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    MetricStatistic
  - withStatistic
```
public CustomizedScalingMetricSpecification withStatistic(MetricStatistic statistic)
```
    The statistic of the metric.
    
    Parameters:
    
    statistic - The statistic of the metric.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    MetricStatistic
  - setUnit
```
public void setUnit(String unit)
```
    The unit of the metric.
    
    Parameters:
    
    unit - The unit of the metric.
  - getUnit
```
public String getUnit()
```
    The unit of the metric.
    
    Returns:
    
    The unit of the metric.
  - withUnit
```
public CustomizedScalingMetricSpecification withUnit(String unit)
```
    The unit of the metric.
    
    Parameters:
    
    unit - The unit of the metric.
    
    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 CustomizedScalingMetricSpecification 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.

AWS SDK for Java 1.x API Reference - 1.12.779

Class CustomizedScalingMetricSpecification

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CustomizedScalingMetricSpecification

Method Detail

setMetricName

getMetricName

withMetricName

setNamespace

getNamespace

withNamespace

getDimensions

setDimensions

withDimensions

withDimensions

setStatistic

getStatistic

withStatistic

withStatistic

setUnit

getUnit

withUnit

toString

equals

hashCode

clone

marshall