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)


3234
3235
3236
3237
3238
3239
3240
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 3234

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

#granularityString

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

Returns:

  • (String)


3234
3235
3236
3237
3238
3239
3240
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 3234

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

#metricsArray<String>

Specifies which group-level metrics to start collecting. You can specify one or more of the following metrics:

  • GroupMinSize

  • GroupMaxSize

  • GroupDesiredCapacity

  • GroupInServiceInstances

  • GroupPendingInstances

  • GroupStandbyInstances

  • GroupTerminatingInstances

  • GroupTotalInstances

The instance weighting feature supports the following additional metrics:

  • GroupInServiceCapacity

  • GroupPendingCapacity

  • GroupStandbyCapacity

  • GroupTerminatingCapacity

  • GroupTotalCapacity

The warm pools feature supports the following additional metrics:

  • WarmPoolDesiredCapacity

  • WarmPoolWarmedCapacity

  • WarmPoolPendingCapacity

  • WarmPoolTerminatingCapacity

  • WarmPoolTotalCapacity

  • GroupAndWarmPoolDesiredCapacity

  • GroupAndWarmPoolTotalCapacity

If you omit this parameter, all metrics are enabled.

Returns:

  • (Array<String>)


3234
3235
3236
3237
3238
3239
3240
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 3234

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