Class: AWSCDK::EC2::CfnLaunchTemplate::ReferenceProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
ec2/cfn_launch_template.rb

Overview

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(instance_family: nil) ⇒ ReferenceProperty

Returns a new instance of ReferenceProperty.

Parameters:

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

    The instance family to use as a baseline reference.



3582
3583
3584
3585
# File 'ec2/cfn_launch_template.rb', line 3582

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_familyString? (readonly)

The instance family to use as a baseline reference.

Ensure 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 type 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 families 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 enable performance protection by specifying a supported instance family, the returned instance types will exclude the above unsupported instance families.



3606
3607
3608
# File 'ec2/cfn_launch_template.rb', line 3606

def instance_family
  @instance_family
end

Class Method Details

.jsii_propertiesObject



3608
3609
3610
3611
3612
# File 'ec2/cfn_launch_template.rb', line 3608

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

Instance Method Details

#to_jsiiObject



3614
3615
3616
3617
3618
3619
3620
# File 'ec2/cfn_launch_template.rb', line 3614

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