com.amazonaws.services.autoscaling.model

Class EnableMetricsCollectionRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.autoscaling.model.EnableMetricsCollectionRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class EnableMetricsCollectionRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the EnableMetricsCollection operation.

Enables monitoring of the specified metrics for the specified Auto Scaling group.

You can only enable metrics collection if InstanceMonitoring in the launch configuration for the group is set to True .

See Also:

AmazonAutoScaling.enableMetricsCollection(EnableMetricsCollectionRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
EnableMetricsCollectionRequest()

Method Summary

Methods

Modifier and Type	Method and Description
EnableMetricsCollectionRequest	clone()
boolean	equals(Object obj)
String	getAutoScalingGroupName() The name or ARN of the Auto Scaling group.
String	getGranularity() The granularity to associate with the metrics to collect.
List<String>	getMetrics() One or more metrics.
int	hashCode()
void	setAutoScalingGroupName(String autoScalingGroupName) The name or ARN of the Auto Scaling group.
void	setGranularity(String granularity) The granularity to associate with the metrics to collect.
void	setMetrics(Collection<String> metrics) One or more metrics.
String	toString() Returns a string representation of this object; useful for testing and debugging.
EnableMetricsCollectionRequest	withAutoScalingGroupName(String autoScalingGroupName) The name or ARN of the Auto Scaling group.
EnableMetricsCollectionRequest	withGranularity(String granularity) The granularity to associate with the metrics to collect.
EnableMetricsCollectionRequest	withMetrics(Collection<String> metrics) One or more metrics.
EnableMetricsCollectionRequest	withMetrics(String... metrics) One or more metrics.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

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

Constructor Detail

EnableMetricsCollectionRequest

public EnableMetricsCollectionRequest()

Method Detail

getAutoScalingGroupName

public String getAutoScalingGroupName()

The name or ARN of the Auto Scaling group.

Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Returns:

The name or ARN of the Auto Scaling group.

setAutoScalingGroupName

public void setAutoScalingGroupName(String autoScalingGroupName)

The name or ARN of the Auto Scaling group.

Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Parameters:

autoScalingGroupName - The name or ARN of the Auto Scaling group.

withAutoScalingGroupName

public EnableMetricsCollectionRequest withAutoScalingGroupName(String autoScalingGroupName)

The name or ARN of the Auto Scaling group.

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

Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Parameters:

autoScalingGroupName - The name or ARN of the Auto Scaling group.

Returns:

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

getMetrics

public List<String> getMetrics()

One or more metrics. If you omit this parameter, all metrics are enabled.

• GroupMinSize

• GroupMaxSize

• GroupDesiredCapacity

• GroupInServiceInstances

• GroupPendingInstances

• GroupStandbyInstances

• GroupTerminatingInstances

• GroupTotalInstances

Note that the GroupStandbyInstances metric is not enabled by default. You must explicitly request this metric.

Returns:

One or more metrics. If you omit this parameter, all metrics are enabled.

• GroupMinSize

• GroupMaxSize

• GroupDesiredCapacity

• GroupInServiceInstances

• GroupPendingInstances

• GroupStandbyInstances

• GroupTerminatingInstances

• GroupTotalInstances

Note that the GroupStandbyInstances metric is not enabled by default. You must explicitly request this metric.

setMetrics

public void setMetrics(Collection<String> metrics)

One or more metrics. If you omit this parameter, all metrics are enabled.

• GroupMinSize

• GroupMaxSize

• GroupDesiredCapacity

• GroupInServiceInstances

• GroupPendingInstances

• GroupStandbyInstances

• GroupTerminatingInstances

• GroupTotalInstances

Note that the GroupStandbyInstances metric is not enabled by default. You must explicitly request this metric.

Parameters:

metrics - One or more metrics. If you omit this parameter, all metrics are enabled.

• GroupMinSize

• GroupMaxSize

• GroupDesiredCapacity

• GroupInServiceInstances

• GroupPendingInstances

• GroupStandbyInstances

• GroupTerminatingInstances

• GroupTotalInstances

Note that the GroupStandbyInstances metric is not enabled by default. You must explicitly request this metric.

withMetrics

public EnableMetricsCollectionRequest withMetrics(String... metrics)

One or more metrics. If you omit this parameter, all metrics are enabled.

• GroupMinSize

• GroupMaxSize

• GroupDesiredCapacity

• GroupInServiceInstances

• GroupPendingInstances

• GroupStandbyInstances

• GroupTerminatingInstances

• GroupTotalInstances

Note that the GroupStandbyInstances metric is not enabled by default. You must explicitly request this metric.

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.

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

Parameters:

metrics - One or more metrics. If you omit this parameter, all metrics are enabled.

• GroupMinSize

• GroupMaxSize

• GroupDesiredCapacity

• GroupInServiceInstances

• GroupPendingInstances

• GroupStandbyInstances

• GroupTerminatingInstances

• GroupTotalInstances

Note that the GroupStandbyInstances metric is not enabled by default. You must explicitly request this metric.

Returns:

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

withMetrics

public EnableMetricsCollectionRequest withMetrics(Collection<String> metrics)

One or more metrics. If you omit this parameter, all metrics are enabled.

• GroupMinSize

• GroupMaxSize

• GroupDesiredCapacity

• GroupInServiceInstances

• GroupPendingInstances

• GroupStandbyInstances

• GroupTerminatingInstances

• GroupTotalInstances

Note that the GroupStandbyInstances metric is not enabled by default. You must explicitly request this metric.

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

Parameters:

metrics - One or more metrics. If you omit this parameter, all metrics are enabled.

• GroupMinSize

• GroupMaxSize

• GroupDesiredCapacity

• GroupInServiceInstances

• GroupPendingInstances

• GroupStandbyInstances

• GroupTerminatingInstances

• GroupTotalInstances

Note that the GroupStandbyInstances metric is not enabled by default. You must explicitly request this metric.

Returns:

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

getGranularity

public String getGranularity()

The granularity to associate with the metrics to collect. The only valid value is 1Minute.

Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Returns:

The granularity to associate with the metrics to collect. The only valid value is 1Minute.

setGranularity

public void setGranularity(String granularity)

The granularity to associate with the metrics to collect. The only valid value is 1Minute.

Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Parameters:

granularity - The granularity to associate with the metrics to collect. The only valid value is 1Minute.

withGranularity

public EnableMetricsCollectionRequest withGranularity(String granularity)

The granularity to associate with the metrics to collect. The only valid value is 1Minute.

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

Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Parameters:

granularity - The granularity to associate with the metrics to collect. The only valid value is 1Minute.

Returns:

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

toString

public String toString()

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

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

clone

public EnableMetricsCollectionRequest clone()

Overrides:

clone in class AmazonWebServiceRequest