Class: AWSCDK::Autoscaling::CfnAutoScalingGroup::MetricsCollectionProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::Autoscaling::CfnAutoScalingGroup::MetricsCollectionProperty

Defined in:

autoscaling/cfn_auto_scaling_group.rb

Overview

MetricsCollection is a property of the AWS::AutoScaling::AutoScalingGroup resource that describes the group metrics that an Amazon EC2 Auto Scaling group sends to Amazon CloudWatch. These metrics describe the group rather than any of its instances.

For more information, see Monitor CloudWatch metrics for your Auto Scaling groups and instances in the Amazon EC2 Auto Scaling User Guide . You can find a sample template snippet in the Examples section of the AWS::AutoScaling::AutoScalingGroup resource.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-metricscollection.html

Instance Attribute Summary

• #granularity ⇒ String readonly

  The frequency at which Amazon EC2 Auto Scaling sends aggregated data to CloudWatch.

• #metrics ⇒ Array<String>^? readonly

  Identifies the metrics to enable.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(granularity:, metrics: nil) ⇒ MetricsCollectionProperty constructor

  A new instance of MetricsCollectionProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(granularity:, metrics: nil) ⇒ MetricsCollectionProperty

Returns a new instance of MetricsCollectionProperty.

Parameters:

• granularity (String) —

  The frequency at which Amazon EC2 Auto Scaling sends aggregated data to CloudWatch.

• metrics (Array<String>, nil) (defaults to: nil) —

  Identifies the metrics to enable.

# File 'autoscaling/cfn_auto_scaling_group.rb', line 2438

def initialize(granularity:, metrics: nil)
  @granularity = granularity
  Jsii::Type.check_type(@granularity, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "granularity")
  @metrics = metrics
  Jsii::Type.check_type(@metrics, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "metrics") unless @metrics.nil?
end

Instance Attribute Details

#granularity ⇒ String (readonly)

The frequency at which Amazon EC2 Auto Scaling sends aggregated data to CloudWatch.

The only valid value is 1Minute .

Returns:

• (String)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-metricscollection.html#cfn-autoscaling-autoscalinggroup-metricscollection-granularity

# File 'autoscaling/cfn_auto_scaling_group.rb', line 2451

def granularity
  @granularity
end

#metrics ⇒ Array<String>^? (readonly)

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 Amazon CloudWatch metrics for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide .

Returns:

• (Array<String>, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-metricscollection.html#cfn-autoscaling-autoscalinggroup-metricscollection-metrics

# File 'autoscaling/cfn_auto_scaling_group.rb', line 2483

def metrics
  @metrics
end

Class Method Details

.jsii_properties ⇒ Object

# File 'autoscaling/cfn_auto_scaling_group.rb', line 2485

def self.jsii_properties
  {
    :granularity => "granularity",
    :metrics => "metrics",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'autoscaling/cfn_auto_scaling_group.rb', line 2492

def to_jsii
  result = {}
  result.merge!({
    "granularity" => @granularity,
    "metrics" => @metrics,
  })
  result.compact
end