Class: Aws::AutoScaling::Types::EnableMetricsCollectionQuery

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb

Overview

Note:

When making an API call, you may pass EnableMetricsCollectionQuery data as a hash:

{
  auto_scaling_group_name: "XmlStringMaxLen255", # required
  metrics: ["XmlStringMaxLen255"],
  granularity: "XmlStringMaxLen255", # required
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#auto_scaling_group_nameString

The name of the Auto Scaling group.

Returns:

  • (String)


3280
3281
3282
3283
3284
3285
3286
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 3280

class EnableMetricsCollectionQuery < Struct.new(
  :auto_scaling_group_name,
  :metrics,
  :granularity)
  SENSITIVE = []
  include Aws::Structure
end

#granularityString

The frequency at which Amazon EC2 Auto Scaling sends aggregated data to CloudWatch. The only valid value is 1Minute.

Returns:

  • (String)


3280
3281
3282
3283
3284
3285
3286
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 3280

class EnableMetricsCollectionQuery < Struct.new(
  :auto_scaling_group_name,
  :metrics,
  :granularity)
  SENSITIVE = []
  include Aws::Structure
end

#metricsArray<String>

Identifies the metrics to enable.

You can specify one or more of the following metrics:

  • GroupMinSize

  • GroupMaxSize

  • GroupDesiredCapacity

  • GroupInServiceInstances

  • GroupPendingInstances

  • GroupStandbyInstances

  • GroupTerminatingInstances

  • GroupTotalInstances

  • GroupInServiceCapacity

  • GroupPendingCapacity

  • GroupStandbyCapacity

  • GroupTerminatingCapacity

  • GroupTotalCapacity

  • WarmPoolDesiredCapacity

  • WarmPoolWarmedCapacity

  • WarmPoolPendingCapacity

  • WarmPoolTerminatingCapacity

  • WarmPoolTotalCapacity

  • GroupAndWarmPoolDesiredCapacity

  • GroupAndWarmPoolTotalCapacity

If you specify Granularity and don't specify any metrics, all metrics are enabled.

For more information, see Auto Scaling group metrics in the Amazon EC2 Auto Scaling User Guide.

Returns:

  • (Array<String>)


3280
3281
3282
3283
3284
3285
3286
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 3280

class EnableMetricsCollectionQuery < Struct.new(
  :auto_scaling_group_name,
  :metrics,
  :granularity)
  SENSITIVE = []
  include Aws::Structure
end