CustomizedLoadMetricSpecification (AWS SDK for Java

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

All Implemented Interfaces:

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

For predictive scaling to work with a customized load metric specification, AWS Auto Scaling needs access to the Sum and Average statistics that CloudWatch computes from metric data. Statistics are calculations used to aggregate data over specified time periods.

When you choose a load metric, make sure that the required Sum and Average statistics for your metric are available in CloudWatch and that they provide relevant data for predictive scaling. The Sum statistic must represent the total load on the resource, and the Average statistic must represent the average load per capacity unit of the resource. For example, there is a metric that counts the number of requests processed by your Auto Scaling group. If the Sum statistic represents the total request count processed by the group, then the Average statistic for the specified metric must represent the average request count processed by each instance of the group.

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

CustomizedLoadMetricSpecification()

Constructors
Constructor and Description
`CustomizedLoadMetricSpecification()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CustomizedLoadMetricSpecification`	`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.
`CustomizedLoadMetricSpecification`	`withDimensions(Collection<MetricDimension> dimensions)` The dimensions of the metric.
`CustomizedLoadMetricSpecification`	`withDimensions(MetricDimension... dimensions)` The dimensions of the metric.
`CustomizedLoadMetricSpecification`	`withMetricName(String metricName)` The name of the metric.
`CustomizedLoadMetricSpecification`	`withNamespace(String namespace)` The namespace of the metric.
`CustomizedLoadMetricSpecification`	`withStatistic(MetricStatistic statistic)` The statistic of the metric.
`CustomizedLoadMetricSpecification`	`withStatistic(String statistic)` The statistic of the metric.
`CustomizedLoadMetricSpecification`	`withUnit(String unit)` The unit of the metric.

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

- Constructor Detail
  - CustomizedLoadMetricSpecification
```
public CustomizedLoadMetricSpecification()
```
- 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 CustomizedLoadMetricSpecification 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 CustomizedLoadMetricSpecification 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 load 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 load 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 load 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 load metric specification.
  - withDimensions
```
public CustomizedLoadMetricSpecification 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 load 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 load metric specification.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withDimensions
```
public CustomizedLoadMetricSpecification 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 load 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 load 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. Currently, the value must always be Sum.
    
    Parameters:
    
    statistic - The statistic of the metric. Currently, the value must always be Sum.
    
    See Also:
    
    MetricStatistic
  - getStatistic
```
public String getStatistic()
```
    The statistic of the metric. Currently, the value must always be Sum.
    
    Returns:
    
    The statistic of the metric. Currently, the value must always be Sum.
    
    See Also:
    
    MetricStatistic
  - withStatistic
```
public CustomizedLoadMetricSpecification withStatistic(String statistic)
```
    The statistic of the metric. Currently, the value must always be Sum.
    
    Parameters:
    
    statistic - The statistic of the metric. Currently, the value must always be Sum.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    MetricStatistic
  - withStatistic
```
public CustomizedLoadMetricSpecification withStatistic(MetricStatistic statistic)
```
    The statistic of the metric. Currently, the value must always be Sum.
    
    Parameters:
    
    statistic - The statistic of the metric. Currently, the value must always be Sum.
    
    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 CustomizedLoadMetricSpecification 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 CustomizedLoadMetricSpecification 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 CustomizedLoadMetricSpecification

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CustomizedLoadMetricSpecification

Method Detail

setMetricName

getMetricName

withMetricName

setNamespace

getNamespace

withNamespace

getDimensions

setDimensions

withDimensions

withDimensions

setStatistic

getStatistic

withStatistic

withStatistic

setUnit

getUnit

withUnit

toString

equals

hashCode

clone

marshall