com.amazonaws.services.autoscaling.model

Class EnableMetricsCollectionRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.autoscaling.model.EnableMetricsCollectionRequest

All Implemented Interfaces:

Serializable

public class EnableMetricsCollectionRequest
extends AmazonWebServiceRequest
implements Serializable

Container for the parameters to the EnableMetricsCollection operation.

Enables monitoring of group metrics for the Auto Scaling group specified in AutoScalingGroupName . You can specify the list of enabled metrics with the Metrics parameter.

Auto Scaling metrics collection can be turned on only if the InstanceMonitoring flag, in the Auto Scaling group's launch configuration, 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
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() The list of metrics to collect.
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) The list of metrics to collect.
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) The list of metrics to collect.
EnableMetricsCollectionRequest	withMetrics(String... metrics) The list of metrics to collect.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyPrivateRequestParameters, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

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

The list of metrics to collect. If no metrics are specified, all metrics are enabled. The following metrics are supported:

• GroupMinSize

• GroupMaxSize

• GroupDesiredCapacity

• GroupInServiceInstances

• GroupPendingInstances

• GroupStandbyInstances

• GroupTerminatingInstances

• GroupTotalInstances

The GroupStandbyInstances metric is not returned by default. You must explicitly request it when calling EnableMetricsCollection.

Returns:

The list of metrics to collect. If no metrics are specified, all metrics are enabled. The following metrics are supported:

• GroupMinSize

• GroupMaxSize

• GroupDesiredCapacity

• GroupInServiceInstances

• GroupPendingInstances

• GroupStandbyInstances

• GroupTerminatingInstances

• GroupTotalInstances

The GroupStandbyInstances metric is not returned by default. You must explicitly request it when calling EnableMetricsCollection.

setMetrics

public void setMetrics(Collection<String> metrics)

The list of metrics to collect. If no metrics are specified, all metrics are enabled. The following metrics are supported:

• GroupMinSize

• GroupMaxSize

• GroupDesiredCapacity

• GroupInServiceInstances

• GroupPendingInstances

• GroupStandbyInstances

• GroupTerminatingInstances

• GroupTotalInstances

The GroupStandbyInstances metric is not returned by default. You must explicitly request it when calling EnableMetricsCollection.

Parameters:

metrics - The list of metrics to collect. If no metrics are specified, all metrics are enabled. The following metrics are supported:

• GroupMinSize

• GroupMaxSize

• GroupDesiredCapacity

• GroupInServiceInstances

• GroupPendingInstances

• GroupStandbyInstances

• GroupTerminatingInstances

• GroupTotalInstances

The GroupStandbyInstances metric is not returned by default. You must explicitly request it when calling EnableMetricsCollection.

withMetrics

public EnableMetricsCollectionRequest withMetrics(String... metrics)

The list of metrics to collect. If no metrics are specified, all metrics are enabled. The following metrics are supported:

• GroupMinSize

• GroupMaxSize

• GroupDesiredCapacity

• GroupInServiceInstances

• GroupPendingInstances

• GroupStandbyInstances

• GroupTerminatingInstances

• GroupTotalInstances

The GroupStandbyInstances metric is not returned by default. You must explicitly request it when calling EnableMetricsCollection.

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

Parameters:

metrics - The list of metrics to collect. If no metrics are specified, all metrics are enabled. The following metrics are supported:

• GroupMinSize

• GroupMaxSize

• GroupDesiredCapacity

• GroupInServiceInstances

• GroupPendingInstances

• GroupStandbyInstances

• GroupTerminatingInstances

• GroupTotalInstances

The GroupStandbyInstances metric is not returned by default. You must explicitly request it when calling EnableMetricsCollection.

Returns:

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

withMetrics

public EnableMetricsCollectionRequest withMetrics(Collection<String> metrics)

The list of metrics to collect. If no metrics are specified, all metrics are enabled. The following metrics are supported:

• GroupMinSize

• GroupMaxSize

• GroupDesiredCapacity

• GroupInServiceInstances

• GroupPendingInstances

• GroupStandbyInstances

• GroupTerminatingInstances

• GroupTotalInstances

The GroupStandbyInstances metric is not returned by default. You must explicitly request it when calling EnableMetricsCollection.

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

Parameters:

metrics - The list of metrics to collect. If no metrics are specified, all metrics are enabled. The following metrics are supported:

• GroupMinSize

• GroupMaxSize

• GroupDesiredCapacity

• GroupInServiceInstances

• GroupPendingInstances

• GroupStandbyInstances

• GroupTerminatingInstances

• GroupTotalInstances

The GroupStandbyInstances metric is not returned by default. You must explicitly request it when calling EnableMetricsCollection.

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. Currently, the only legal granularity 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. Currently, the only legal granularity is "1Minute".

setGranularity

public void setGranularity(String granularity)

The granularity to associate with the metrics to collect. Currently, the only legal granularity 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. Currently, the only legal granularity is "1Minute".

withGranularity

public EnableMetricsCollectionRequest withGranularity(String granularity)

The granularity to associate with the metrics to collect. Currently, the only legal granularity 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. Currently, the only legal granularity 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