Class: AWSCDK::Autoscaling::CfnAutoScalingGroup::PerformanceFactorReferenceRequestProperty

Inherits:

Jsii::Struct

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

Defined in:

autoscaling/cfn_auto_scaling_group.rb

Overview

Specify an instance family to use as the baseline reference for CPU performance.

All instance types that All instance types that match your specified attributes will be compared against the CPU performance of the referenced instance family, regardless of CPU manufacturer or architecture differences.

Currently only one instance family can be specified in the list.

See Also:

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

Instance Attribute Summary

• #instance_family ⇒ String^? readonly

  The instance family to use as a baseline reference.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(instance_family: nil) ⇒ PerformanceFactorReferenceRequestProperty constructor

  A new instance of PerformanceFactorReferenceRequestProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(instance_family: nil) ⇒ PerformanceFactorReferenceRequestProperty

Returns a new instance of PerformanceFactorReferenceRequestProperty.

Parameters:

• instance_family (String, nil) (defaults to: nil) —

  The instance family to use as a baseline reference.

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

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

Instance Attribute Details

#instance_family ⇒ String^? (readonly)

The instance family to use as a baseline reference.

Make sure that you specify the correct value for the instance family. The instance family is everything before the period (.) in the instance type name. For example, in the instance c6i.large , the instance family is c6i , not c6 . For more information, see Amazon EC2 instance type naming conventions in Amazon EC2 Instance Types .

The following instance types are not supported for performance protection.

• c1
• g3| g3s
• hpc7g
• m1| m2
• mac1 | mac2 | mac2-m1ultra | mac2-m2 | mac2-m2pro
• p3dn | p4d | p5
• t1
• u-12tb1 | u-18tb1 | u-24tb1 | u-3tb1 | u-6tb1 | u-9tb1 | u7i-12tb | u7in-16tb | u7in-24tb | u7in-32tb

If you performance protection by specifying a supported instance family, the returned instance types will exclude the preceding unsupported instance families.

If you specify an unsupported instance family as a value for baseline performance, the API returns an empty response.

Returns:

• (String, nil)

See Also:

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

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

def instance_family
  @instance_family
end

Class Method Details

.jsii_properties ⇒ Object

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

def self.jsii_properties
  {
    :instance_family => "instanceFamily",
  }
end

Instance Method Details

#to_jsii ⇒ Object

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

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