com.amazonaws.services.autoscaling.model

Class CustomizedMetricSpecification

java.lang.Object

com.amazonaws.services.autoscaling.model.CustomizedMetricSpecification

All Implemented Interfaces:

Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CustomizedMetricSpecification
extends Object
implements Serializable, Cloneable

Represents a CloudWatch metric of your choosing for a target tracking scaling policy to use with Amazon EC2 Auto Scaling.

To create your customized metric specification:

• Add values for each required property 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 more information about the CloudWatch terminology below, see Amazon CloudWatch concepts.

Each individual service provides information about the metrics, namespace, and dimensions they use. For more information, see Amazon Web Services services that publish CloudWatch metrics in the Amazon CloudWatch User Guide.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
CustomizedMetricSpecification()

Method Summary

Modifier and Type	Method and Description
CustomizedMetricSpecification	clone()
boolean	equals(Object obj)
List<MetricDimension>	getDimensions() The dimensions of the metric.
String	getMetricName() The name of the metric.
List<TargetTrackingMetricDataQuery>	getMetrics() The metrics to include in the target tracking scaling policy, as a metric data query.
String	getNamespace() The namespace of the metric.
String	getStatistic() The statistic of the metric.
String	getUnit() The unit of the metric.
int	hashCode()
void	setDimensions(Collection<MetricDimension> dimensions) The dimensions of the metric.
void	setMetricName(String metricName) The name of the metric.
void	setMetrics(Collection<TargetTrackingMetricDataQuery> metrics) The metrics to include in the target tracking scaling policy, as a metric data query.
void	setNamespace(String namespace) The namespace of the metric.
void	setStatistic(MetricStatistic statistic) The statistic 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.
CustomizedMetricSpecification	withDimensions(Collection<MetricDimension> dimensions) The dimensions of the metric.
CustomizedMetricSpecification	withDimensions(MetricDimension... dimensions) The dimensions of the metric.
CustomizedMetricSpecification	withMetricName(String metricName) The name of the metric.
CustomizedMetricSpecification	withMetrics(Collection<TargetTrackingMetricDataQuery> metrics) The metrics to include in the target tracking scaling policy, as a metric data query.
CustomizedMetricSpecification	withMetrics(TargetTrackingMetricDataQuery... metrics) The metrics to include in the target tracking scaling policy, as a metric data query.
CustomizedMetricSpecification	withNamespace(String namespace) The namespace of the metric.
CustomizedMetricSpecification	withStatistic(MetricStatistic statistic) The statistic of the metric.
CustomizedMetricSpecification	withStatistic(String statistic) The statistic of the metric.
CustomizedMetricSpecification	withUnit(String unit) The unit of the metric.

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CustomizedMetricSpecification

public CustomizedMetricSpecification()

Method Detail

setMetricName

public void setMetricName(String metricName)

The name of the metric. To get the exact metric name, namespace, and dimensions, inspect the Metric object that is returned by a call to ListMetrics.

Parameters:

metricName - The name of the metric. To get the exact metric name, namespace, and dimensions, inspect the Metric object that is returned by a call to ListMetrics.

getMetricName

public String getMetricName()

The name of the metric. To get the exact metric name, namespace, and dimensions, inspect the Metric object that is returned by a call to ListMetrics.

Returns:

The name of the metric. To get the exact metric name, namespace, and dimensions, inspect the Metric object that is returned by a call to ListMetrics.

withMetricName

public CustomizedMetricSpecification withMetricName(String metricName)

The name of the metric. To get the exact metric name, namespace, and dimensions, inspect the Metric object that is returned by a call to ListMetrics.

Parameters:

metricName - The name of the metric. To get the exact metric name, namespace, and dimensions, inspect the Metric object that is returned by a call to ListMetrics.

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 CustomizedMetricSpecification 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 scaling policy.

Returns:

The dimensions of the metric.

Conditional: If you published your metric with dimensions, you must specify the same dimensions in your scaling policy.

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 scaling policy.

Parameters:

dimensions - The dimensions of the metric.

Conditional: If you published your metric with dimensions, you must specify the same dimensions in your scaling policy.

withDimensions

public CustomizedMetricSpecification withDimensions(MetricDimension... dimensions)

The dimensions of the metric.

Conditional: If you published your metric with dimensions, you must specify the same dimensions in your scaling policy.

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 scaling policy.

Returns:

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

withDimensions

public CustomizedMetricSpecification 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 scaling policy.

Parameters:

dimensions - The dimensions of the metric.

Conditional: If you published your metric with dimensions, you must specify the same dimensions in your scaling policy.

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 CustomizedMetricSpecification 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

setStatistic

public void setStatistic(MetricStatistic statistic)

The statistic of the metric.

Parameters:

statistic - The statistic of the metric.

See Also:

MetricStatistic

withStatistic

public CustomizedMetricSpecification 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. For a complete list of the units that CloudWatch supports, see the MetricDatum data type in the Amazon CloudWatch API Reference.

Parameters:

unit - The unit of the metric. For a complete list of the units that CloudWatch supports, see the MetricDatum data type in the Amazon CloudWatch API Reference.

getUnit

public String getUnit()

The unit of the metric. For a complete list of the units that CloudWatch supports, see the MetricDatum data type in the Amazon CloudWatch API Reference.

Returns:

The unit of the metric. For a complete list of the units that CloudWatch supports, see the MetricDatum data type in the Amazon CloudWatch API Reference.

withUnit

public CustomizedMetricSpecification withUnit(String unit)

The unit of the metric. For a complete list of the units that CloudWatch supports, see the MetricDatum data type in the Amazon CloudWatch API Reference.

Parameters:

unit - The unit of the metric. For a complete list of the units that CloudWatch supports, see the MetricDatum data type in the Amazon CloudWatch API Reference.

Returns:

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

getMetrics

public List<TargetTrackingMetricDataQuery> getMetrics()

The metrics to include in the target tracking scaling policy, as a metric data query. This can include both raw metric and metric math expressions.

Returns:

The metrics to include in the target tracking scaling policy, as a metric data query. This can include both raw metric and metric math expressions.

setMetrics

public void setMetrics(Collection<TargetTrackingMetricDataQuery> metrics)

The metrics to include in the target tracking scaling policy, as a metric data query. This can include both raw metric and metric math expressions.

Parameters:

metrics - The metrics to include in the target tracking scaling policy, as a metric data query. This can include both raw metric and metric math expressions.

withMetrics

public CustomizedMetricSpecification withMetrics(TargetTrackingMetricDataQuery... metrics)

The metrics to include in the target tracking scaling policy, as a metric data query. This can include both raw metric and metric math expressions.

NOTE: This method appends the values to the existing list (if any). Use setMetrics(java.util.Collection) or withMetrics(java.util.Collection) if you want to override the existing values.

Parameters:

metrics - The metrics to include in the target tracking scaling policy, as a metric data query. This can include both raw metric and metric math expressions.

Returns:

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

withMetrics

public CustomizedMetricSpecification withMetrics(Collection<TargetTrackingMetricDataQuery> metrics)

The metrics to include in the target tracking scaling policy, as a metric data query. This can include both raw metric and metric math expressions.

Parameters:

metrics - The metrics to include in the target tracking scaling policy, as a metric data query. This can include both raw metric and metric math expressions.

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 CustomizedMetricSpecification clone()

Overrides:

clone in class Object