Class: AWSCDK::Autoscaling::CfnLaunchConfiguration

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, Interfaces::AWSAutoscaling::ILaunchConfigurationRef
Defined in:
autoscaling/cfn_launch_configuration.rb

Overview

The AWS::AutoScaling::LaunchConfiguration resource specifies the launch configuration that can be used by an Auto Scaling group to configure Amazon EC2 instances.

When you update the launch configuration for an Auto Scaling group, CloudFormation deletes that resource and creates a new launch configuration with the updated properties and a new name. Existing instances are not affected. To update existing instances when you update the AWS::AutoScaling::LaunchConfiguration resource, you can specify an UpdatePolicy attribute for the group. You can find sample update policies for rolling updates in Configure Amazon EC2 Auto Scaling resources .

Amazon EC2 Auto Scaling configures instances launched as part of an Auto Scaling group using either a launch template or a launch configuration. We strongly recommend that you do not use launch configurations. For more information, see Launch configurations in the Amazon EC2 Auto Scaling User Guide .

For help migrating from launch configurations to launch templates, see Migrate AWS CloudFormation stacks from launch configurations to launch templates in the Amazon EC2 Auto Scaling User Guide .

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnLaunchConfiguration

Create a new AWS::AutoScaling::LaunchConfiguration.

Parameters:



23
24
25
26
27
28
29
 
# File 'autoscaling/cfn_launch_configuration.rb', line 23

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::Autoscaling::CfnLaunchConfigurationProps.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXV0b3NjYWxpbmcuQ2ZuTGF1bmNoQ29uZmlndXJhdGlvblByb3BzIn0=")), "props")
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


193
194
195
 
# File 'autoscaling/cfn_launch_configuration.rb', line 193

def self.CFN_RESOURCE_TYPE_NAME()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_autoscaling.CfnLaunchConfiguration", "CFN_RESOURCE_TYPE_NAME")
end

.is_cfn_launch_configuration(x) ⇒ Boolean

Checks whether the given object is a CfnLaunchConfiguration.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


95
96
97
98
 
# File 'autoscaling/cfn_launch_configuration.rb', line 95

def self.is_cfn_launch_configuration(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_autoscaling.CfnLaunchConfiguration", "isCfnLaunchConfiguration", [x])
end

.jsii_overridable_methods ⇒ Object 



31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'autoscaling/cfn_launch_configuration.rb', line 31

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :creation_stack => { kind: :property, name: "creationStack", is_optional: false },
    :logical_id => { kind: :property, name: "logicalId", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :ref => { kind: :property, name: "ref", is_optional: false },
    :cfn_options => { kind: :property, name: "cfnOptions", is_optional: false },
    :cfn_properties => { kind: :property, name: "cfnProperties", is_optional: false },
    :cfn_property_names => { kind: :property, name: "cfnPropertyNames", is_optional: false },
    :cfn_resource_type => { kind: :property, name: "cfnResourceType", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :updated_properites => { kind: :property, name: "updatedProperites", is_optional: false },
    :updated_properties => { kind: :property, name: "updatedProperties", is_optional: false },
    :launch_configuration_ref => { kind: :property, name: "launchConfigurationRef", is_optional: false },
    :image_id => { kind: :property, name: "imageId", is_optional: false },
    :instance_type => { kind: :property, name: "instanceType", is_optional: false },
    :associate_public_ip_address => { kind: :property, name: "associatePublicIpAddress", is_optional: true },
    :block_device_mappings => { kind: :property, name: "blockDeviceMappings", is_optional: true },
    :classic_link_vpc_id => { kind: :property, name: "classicLinkVpcId", is_optional: true },
    :classic_link_vpc_security_groups => { kind: :property, name: "classicLinkVpcSecurityGroups", is_optional: true },
    :ebs_optimized => { kind: :property, name: "ebsOptimized", is_optional: true },
    :iam_instance_profile => { kind: :property, name: "iamInstanceProfile", is_optional: true },
    :instance_id => { kind: :property, name: "instanceId", is_optional: true },
    :instance_monitoring => { kind: :property, name: "instanceMonitoring", is_optional: true },
    :kernel_id => { kind: :property, name: "kernelId", is_optional: true },
    :key_name => { kind: :property, name: "keyName", is_optional: true },
    :launch_configuration_name => { kind: :property, name: "launchConfigurationName", is_optional: true },
    :metadata_options => { kind: :property, name: "metadataOptions", is_optional: true },
    :placement_tenancy => { kind: :property, name: "placementTenancy", is_optional: true },
    :ram_disk_id => { kind: :property, name: "ramDiskId", is_optional: true },
    :security_groups => { kind: :property, name: "securityGroups", is_optional: true },
    :spot_price => { kind: :property, name: "spotPrice", is_optional: true },
    :user_data => { kind: :property, name: "userData", is_optional: true },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :override_logical_id => { kind: :method, name: "overrideLogicalId", is_optional: false },
    :add_deletion_override => { kind: :method, name: "addDeletionOverride", is_optional: false },
    :add_dependency => { kind: :method, name: "addDependency", is_optional: false },
    :add_depends_on => { kind: :method, name: "addDependsOn", is_optional: false },
    :add_metadata => { kind: :method, name: "addMetadata", is_optional: false },
    :add_override => { kind: :method, name: "addOverride", is_optional: false },
    :add_property_deletion_override => { kind: :method, name: "addPropertyDeletionOverride", is_optional: false },
    :add_property_override => { kind: :method, name: "addPropertyOverride", is_optional: false },
    :apply_cross_stack_reference_strength => { kind: :method, name: "applyCrossStackReferenceStrength", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
    :cfn_property_name => { kind: :method, name: "cfnPropertyName", is_optional: false },
    :get_att => { kind: :method, name: "getAtt", is_optional: false },
    :get_metadata => { kind: :method, name: "getMetadata", is_optional: false },
    :obtain_dependencies => { kind: :method, name: "obtainDependencies", is_optional: false },
    :obtain_resource_dependencies => { kind: :method, name: "obtainResourceDependencies", is_optional: false },
    :remove_dependency => { kind: :method, name: "removeDependency", is_optional: false },
    :render_properties => { kind: :method, name: "renderProperties", is_optional: false },
    :replace_dependency => { kind: :method, name: "replaceDependency", is_optional: false },
    :should_synthesize => { kind: :method, name: "shouldSynthesize", is_optional: false },
    :validate_properties => { kind: :method, name: "validateProperties", is_optional: false },
    :inspect => { kind: :method, name: "inspect", is_optional: false },
  }
end

Instance Method Details

#add_deletion_override(path) ⇒ void

This method returns an undefined value.

Syntactic sugar for addOverride(path, undefined).

Parameters:

  • path (String) —

    The path of the value to delete.



469
470
471
472
 
# File 'autoscaling/cfn_launch_configuration.rb', line 469

def add_deletion_override(path)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  jsii_call_method("addDeletionOverride", [path])
end

#add_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:



481
482
483
484
 
# File 'autoscaling/cfn_launch_configuration.rb', line 481

def add_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependency", [target])
end

#add_depends_on(target) ⇒ void

Deprecated.

use addDependency

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:



491
492
493
494
 
# File 'autoscaling/cfn_launch_configuration.rb', line 491

def add_depends_on(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependsOn", [target])
end

#add_metadata(key, value) ⇒ void

This method returns an undefined value.

Add a value to the CloudFormation Resource Metadata.

Parameters:

  • key (String)
  • value (Object)

See Also:



502
503
504
505
506
 
# File 'autoscaling/cfn_launch_configuration.rb', line 502

def add_metadata(key, value)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addMetadata", [key, value])
end

#add_override(path, value) ⇒ void

This method returns an undefined value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use add_property_override or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

# Example automatically generated from non-compiling source. May contain errors.
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to add_override will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

  • path (String) —
    • The path of the property, you can use dot notation to override values in complex types.
  • value (Object) —
    • The value.


559
560
561
562
563
 
# File 'autoscaling/cfn_launch_configuration.rb', line 559

def add_override(path, value)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addOverride", [path, value])
end

#add_property_deletion_override(property_path) ⇒ void

This method returns an undefined value.

Adds an override that deletes the value of a property from the resource definition.

Parameters:

  • property_path (String) —

    The path to the property.



569
570
571
572
 
# File 'autoscaling/cfn_launch_configuration.rb', line 569

def add_property_deletion_override(property_path)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  jsii_call_method("addPropertyDeletionOverride", [property_path])
end

#add_property_override(property_path, value) ⇒ void

This method returns an undefined value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

  • property_path (String) —

    The path of the property.

  • value (Object) —

    The value.



581
582
583
584
585
 
# File 'autoscaling/cfn_launch_configuration.rb', line 581

def add_property_override(property_path, value)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addPropertyOverride", [property_path, value])
end

#apply_cross_stack_reference_strength(strength) ⇒ void

This method returns an undefined value.

Sets the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack's context.

Parameters:



594
595
596
597
 
# File 'autoscaling/cfn_launch_configuration.rb', line 594

def apply_cross_stack_reference_strength(strength)
  Jsii::Type.check_type(strength, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZWZlcmVuY2VTdHJlbmd0aCJ9")), "strength")
  jsii_call_method("applyCrossStackReferenceStrength", [strength])
end

#apply_removal_policy(policy = nil, options = nil) ⇒ void

This method returns an undefined value.

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

See Also:



616
617
618
619
620
621
 
# File 'autoscaling/cfn_launch_configuration.rb', line 616

def apply_removal_policy(policy = nil, options = nil)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy") unless policy.nil?
  options = options.is_a?(Hash) ? ::AWSCDK::RemovalPolicyOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5T3B0aW9ucyJ9")), "options") unless options.nil?
  jsii_call_method("applyRemovalPolicy", [policy, options])
end

#associate_public_ip_address ⇒ Boolean, ...

Specifies whether to assign a public IPv4 address to the group's instances.

Returns:



231
232
233
 
# File 'autoscaling/cfn_launch_configuration.rb', line 231

def associate_public_ip_address()
  jsii_get_property("associatePublicIpAddress")
end

#associate_public_ip_address=(value) ⇒ Object 



235
236
237
238
 
# File 'autoscaling/cfn_launch_configuration.rb', line 235

def associate_public_ip_address=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "associatePublicIpAddress") unless value.nil?
  jsii_set_property("associatePublicIpAddress", value)
end

#block_device_mappings ⇒ AWSCDK::IResolvable, ...

The block device mapping entries that define the block devices to attach to the instances at launch.

Returns:



243
244
245
 
# File 'autoscaling/cfn_launch_configuration.rb', line 243

def block_device_mappings()
  jsii_get_property("blockDeviceMappings")
end

#block_device_mappings=(value) ⇒ Object 



247
248
249
250
 
# File 'autoscaling/cfn_launch_configuration.rb', line 247

def block_device_mappings=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXV0b3NjYWxpbmcuQ2ZuTGF1bmNoQ29uZmlndXJhdGlvbi5CbG9ja0RldmljZU1hcHBpbmdQcm9wZXJ0eSJ9XX19LCJraW5kIjoiYXJyYXkifX1dfX0=")), "blockDeviceMappings") unless value.nil?
  jsii_set_property("blockDeviceMappings", value)
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

Returns:



146
147
148
 
# File 'autoscaling/cfn_launch_configuration.rb', line 146

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


151
152
153
 
# File 'autoscaling/cfn_launch_configuration.rb', line 151

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


625
626
627
628
 
# File 'autoscaling/cfn_launch_configuration.rb', line 625

def cfn_property_name(cdk_property_name)
  Jsii::Type.check_type(cdk_property_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "cdkPropertyName")
  jsii_call_method("cfnPropertyName", [cdk_property_name])
end

#cfn_property_names ⇒ Hash{String => String}

Returns:

  • (Hash{String => String}) 


156
157
158
 
# File 'autoscaling/cfn_launch_configuration.rb', line 156

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


163
164
165
 
# File 'autoscaling/cfn_launch_configuration.rb', line 163

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#classic_link_vpc_id ⇒ String?

Available for backward compatibility.

Returns:

  • (String, nil) 


255
256
257
 
# File 'autoscaling/cfn_launch_configuration.rb', line 255

def classic_link_vpc_id()
  jsii_get_property("classicLinkVpcId")
end

#classic_link_vpc_id=(value) ⇒ Object 



259
260
261
262
 
# File 'autoscaling/cfn_launch_configuration.rb', line 259

def classic_link_vpc_id=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "classicLinkVpcId") unless value.nil?
  jsii_set_property("classicLinkVpcId", value)
end

#classic_link_vpc_security_groups ⇒ Array<String>?

Available for backward compatibility.

Returns:

  • (Array<String>, nil) 


267
268
269
 
# File 'autoscaling/cfn_launch_configuration.rb', line 267

def classic_link_vpc_security_groups()
  jsii_get_property("classicLinkVpcSecurityGroups")
end

#classic_link_vpc_security_groups=(value) ⇒ Object 



271
272
273
274
 
# File 'autoscaling/cfn_launch_configuration.rb', line 271

def classic_link_vpc_security_groups=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "classicLinkVpcSecurityGroups") unless value.nil?
  jsii_set_property("classicLinkVpcSecurityGroups", value)
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


108
109
110
 
# File 'autoscaling/cfn_launch_configuration.rb', line 108

def creation_stack()
  jsii_get_property("creationStack")
end

#ebs_optimized ⇒ Boolean, ...

Specifies whether the launch configuration is optimized for EBS I/O ( true ) or not ( false ).

Returns:



279
280
281
 
# File 'autoscaling/cfn_launch_configuration.rb', line 279

def ebs_optimized()
  jsii_get_property("ebsOptimized")
end

#ebs_optimized=(value) ⇒ Object 



283
284
285
286
 
# File 'autoscaling/cfn_launch_configuration.rb', line 283

def ebs_optimized=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "ebsOptimized") unless value.nil?
  jsii_set_property("ebsOptimized", value)
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



168
169
170
 
# File 'autoscaling/cfn_launch_configuration.rb', line 168

def env()
  jsii_get_property("env")
end

#get_att(attribute_name, type_hint = nil) ⇒ AWSCDK::Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

Returns:



638
639
640
641
642
 
# File 'autoscaling/cfn_launch_configuration.rb', line 638

def get_att(attribute_name, type_hint = nil)
  Jsii::Type.check_type(attribute_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "attributeName")
  Jsii::Type.check_type(type_hint, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZXNvbHV0aW9uVHlwZUhpbnQifQ==")), "typeHint") unless type_hint.nil?
  jsii_call_method("getAtt", [attribute_name, type_hint])
end

#get_metadata(key) ⇒ Object

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

  • key (String)

Returns:

  • (Object)

See Also:



649
650
651
652
 
# File 'autoscaling/cfn_launch_configuration.rb', line 649

def get_metadata(key)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  jsii_call_method("getMetadata", [key])
end

#iam_instance_profile ⇒ String?

The name or the Amazon Resource Name (ARN) of the instance profile associated with the IAM role for the instance.

Returns:

  • (String, nil) 


291
292
293
 
# File 'autoscaling/cfn_launch_configuration.rb', line 291

def iam_instance_profile()
  jsii_get_property("iamInstanceProfile")
end

#iam_instance_profile=(value) ⇒ Object 



295
296
297
298
 
# File 'autoscaling/cfn_launch_configuration.rb', line 295

def iam_instance_profile=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "iamInstanceProfile") unless value.nil?
  jsii_set_property("iamInstanceProfile", value)
end

#image_id ⇒ String

The ID of the Amazon Machine Image (AMI) that was assigned during registration.

Returns:

  • (String) 


207
208
209
 
# File 'autoscaling/cfn_launch_configuration.rb', line 207

def image_id()
  jsii_get_property("imageId")
end

#image_id=(value) ⇒ Object 



211
212
213
214
 
# File 'autoscaling/cfn_launch_configuration.rb', line 211

def image_id=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "imageId")
  jsii_set_property("imageId", value)
end

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



719
720
721
722
 
# File 'autoscaling/cfn_launch_configuration.rb', line 719

def inspect(inspector)
  Jsii::Type.check_type(inspector, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5UcmVlSW5zcGVjdG9yIn0=")), "inspector")
  jsii_call_method("inspect", [inspector])
end

#instance_id ⇒ String?

The ID of the Amazon EC2 instance to use to create the launch configuration.

Returns:

  • (String, nil) 


303
304
305
 
# File 'autoscaling/cfn_launch_configuration.rb', line 303

def instance_id()
  jsii_get_property("instanceId")
end

#instance_id=(value) ⇒ Object 



307
308
309
310
 
# File 'autoscaling/cfn_launch_configuration.rb', line 307

def instance_id=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "instanceId") unless value.nil?
  jsii_set_property("instanceId", value)
end

#instance_monitoring ⇒ Boolean, ...

Controls whether instances in this group are launched with detailed ( true ) or basic ( false ) monitoring.

Returns:



315
316
317
 
# File 'autoscaling/cfn_launch_configuration.rb', line 315

def instance_monitoring()
  jsii_get_property("instanceMonitoring")
end

#instance_monitoring=(value) ⇒ Object 



319
320
321
322
 
# File 'autoscaling/cfn_launch_configuration.rb', line 319

def instance_monitoring=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "instanceMonitoring") unless value.nil?
  jsii_set_property("instanceMonitoring", value)
end

#instance_type ⇒ String

Specifies the instance type of the EC2 instance.

Returns:

  • (String) 


219
220
221
 
# File 'autoscaling/cfn_launch_configuration.rb', line 219

def instance_type()
  jsii_get_property("instanceType")
end

#instance_type=(value) ⇒ Object 



223
224
225
226
 
# File 'autoscaling/cfn_launch_configuration.rb', line 223

def instance_type=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "instanceType")
  jsii_set_property("instanceType", value)
end

#kernel_id ⇒ String?

The ID of the kernel associated with the AMI.

Returns:

  • (String, nil) 


327
328
329
 
# File 'autoscaling/cfn_launch_configuration.rb', line 327

def kernel_id()
  jsii_get_property("kernelId")
end

#kernel_id=(value) ⇒ Object 



331
332
333
334
 
# File 'autoscaling/cfn_launch_configuration.rb', line 331

def kernel_id=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "kernelId") unless value.nil?
  jsii_set_property("kernelId", value)
end

#key_name ⇒ String?

The name of the key pair.

Returns:

  • (String, nil) 


339
340
341
 
# File 'autoscaling/cfn_launch_configuration.rb', line 339

def key_name()
  jsii_get_property("keyName")
end

#key_name=(value) ⇒ Object 



343
344
345
346
 
# File 'autoscaling/cfn_launch_configuration.rb', line 343

def key_name=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "keyName") unless value.nil?
  jsii_set_property("keyName", value)
end

#launch_configuration_name ⇒ String?

The name of the launch configuration.

Returns:

  • (String, nil) 


351
352
353
 
# File 'autoscaling/cfn_launch_configuration.rb', line 351

def launch_configuration_name()
  jsii_get_property("launchConfigurationName")
end

#launch_configuration_name=(value) ⇒ Object 



355
356
357
358
 
# File 'autoscaling/cfn_launch_configuration.rb', line 355

def launch_configuration_name=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "launchConfigurationName") unless value.nil?
  jsii_set_property("launchConfigurationName", value)
end

#launch_configuration_ref ⇒ AWSCDK::Interfaces::AWSAutoscaling::LaunchConfigurationReference

A reference to a LaunchConfiguration resource.

Returns:



200
201
202
 
# File 'autoscaling/cfn_launch_configuration.rb', line 200

def launch_configuration_ref()
  jsii_get_property("launchConfigurationRef")
end

#logical_id ⇒ String

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use override_logical_id(new_logical_id).

Returns:

  • (String) 


120
121
122
 
# File 'autoscaling/cfn_launch_configuration.rb', line 120

def logical_id()
  jsii_get_property("logicalId")
end

#metadata_options ⇒ AWSCDK::IResolvable, ...

The metadata options for the instances.

Returns:



363
364
365
 
# File 'autoscaling/cfn_launch_configuration.rb', line 363

def metadata_options()
  jsii_get_property("metadataOptions")
end

#metadata_options=(value) ⇒ Object 



367
368
369
370
371
 
# File 'autoscaling/cfn_launch_configuration.rb', line 367

def metadata_options=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Autoscaling::CfnLaunchConfiguration::MetadataOptionsProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19hdXRvc2NhbGluZy5DZm5MYXVuY2hDb25maWd1cmF0aW9uLk1ldGFkYXRhT3B0aW9uc1Byb3BlcnR5In1dfX0=")), "metadataOptions") unless value.nil?
  jsii_set_property("metadataOptions", value)
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


103
104
105
 
# File 'autoscaling/cfn_launch_configuration.rb', line 103

def node()
  jsii_get_property("node")
end

#obtain_dependencies ⇒ Array<AWSCDK::CfnResource, AWSCDK::Stack>

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Returns:



660
661
662
 
# File 'autoscaling/cfn_launch_configuration.rb', line 660

def obtain_dependencies()
  jsii_call_method("obtainDependencies", [])
end

#obtain_resource_dependencies ⇒ Array<AWSCDK::CfnResource>

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Returns:



667
668
669
 
# File 'autoscaling/cfn_launch_configuration.rb', line 667

def obtain_resource_dependencies()
  jsii_call_method("obtainResourceDependencies", [])
end

#override_logical_id(new_logical_id) ⇒ void

This method returns an undefined value.

Overrides the auto-generated logical ID with a specific ID.

Parameters:

  • new_logical_id (String) —

    The new logical ID to use for this stack element.



460
461
462
463
 
# File 'autoscaling/cfn_launch_configuration.rb', line 460

def override_logical_id(new_logical_id)
  Jsii::Type.check_type(new_logical_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "newLogicalId")
  jsii_call_method("overrideLogicalId", [new_logical_id])
end

#placement_tenancy ⇒ String?

The tenancy of the instance, either default or dedicated .

Returns:

  • (String, nil) 


376
377
378
 
# File 'autoscaling/cfn_launch_configuration.rb', line 376

def placement_tenancy()
  jsii_get_property("placementTenancy")
end

#placement_tenancy=(value) ⇒ Object 



380
381
382
383
 
# File 'autoscaling/cfn_launch_configuration.rb', line 380

def placement_tenancy=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "placementTenancy") unless value.nil?
  jsii_set_property("placementTenancy", value)
end

#ram_disk_id ⇒ String?

The ID of the RAM disk to select.

Returns:

  • (String, nil) 


388
389
390
 
# File 'autoscaling/cfn_launch_configuration.rb', line 388

def ram_disk_id()
  jsii_get_property("ramDiskId")
end

#ram_disk_id=(value) ⇒ Object 



392
393
394
395
 
# File 'autoscaling/cfn_launch_configuration.rb', line 392

def ram_disk_id=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "ramDiskId") unless value.nil?
  jsii_set_property("ramDiskId", value)
end

#ref ⇒ String

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

Returns:

  • (String) 


139
140
141
 
# File 'autoscaling/cfn_launch_configuration.rb', line 139

def ref()
  jsii_get_property("ref")
end

#remove_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:



678
679
680
681
 
# File 'autoscaling/cfn_launch_configuration.rb', line 678

def remove_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("removeDependency", [target])
end

#render_properties(props) ⇒ Hash{String => Object}

Parameters:

  • props (Hash{String => Object})

Returns:

  • (Hash{String => Object}) 


685
686
687
688
 
# File 'autoscaling/cfn_launch_configuration.rb', line 685

def render_properties(props)
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6ImFueSJ9LCJraW5kIjoibWFwIn19")), "props")
  jsii_call_method("renderProperties", [props])
end

#replace_dependency(target, new_target) ⇒ void

This method returns an undefined value.

Replaces one dependency with another.

Parameters:



695
696
697
698
699
 
# File 'autoscaling/cfn_launch_configuration.rb', line 695

def replace_dependency(target, new_target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  Jsii::Type.check_type(new_target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "newTarget")
  jsii_call_method("replaceDependency", [target, new_target])
end

#security_groups ⇒ Array<String>?

A list that contains the security groups to assign to the instances in the Auto Scaling group.

Returns:

  • (Array<String>, nil) 


400
401
402
 
# File 'autoscaling/cfn_launch_configuration.rb', line 400

def security_groups()
  jsii_get_property("securityGroups")
end

#security_groups=(value) ⇒ Object 



404
405
406
407
 
# File 'autoscaling/cfn_launch_configuration.rb', line 404

def security_groups=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "securityGroups") unless value.nil?
  jsii_set_property("securityGroups", value)
end

#should_synthesize ⇒ Boolean

Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.

Returns:

  • (Boolean) —

    true if the resource should be included or false is the resource should be omitted.



704
705
706
 
# File 'autoscaling/cfn_launch_configuration.rb', line 704

def should_synthesize()
  jsii_call_method("shouldSynthesize", [])
end

#spot_price ⇒ String?

The maximum hourly price to be paid for any Spot Instance launched to fulfill the request.

Returns:

  • (String, nil) 


412
413
414
 
# File 'autoscaling/cfn_launch_configuration.rb', line 412

def spot_price()
  jsii_get_property("spotPrice")
end

#spot_price=(value) ⇒ Object 



416
417
418
419
 
# File 'autoscaling/cfn_launch_configuration.rb', line 416

def spot_price=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "spotPrice") unless value.nil?
  jsii_set_property("spotPrice", value)
end

#stack ⇒ AWSCDK::Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Returns:



129
130
131
 
# File 'autoscaling/cfn_launch_configuration.rb', line 129

def stack()
  jsii_get_property("stack")
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



436
437
438
 
# File 'autoscaling/cfn_launch_configuration.rb', line 436

def to_string()
  jsii_call_method("toString", [])
end

#updated_properites ⇒ Hash{String => Object}

Deprecated.

use updatedProperties Return properties modified after initiation Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Deprecated.

Returns:

  • (Hash{String => Object}) 


176
177
178
 
# File 'autoscaling/cfn_launch_configuration.rb', line 176

def updated_properites()
  jsii_get_property("updatedProperites")
end

#updated_properties ⇒ Hash{String => Object}

Return properties modified after initiation.

Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Returns:

  • (Hash{String => Object}) 


186
187
188
 
# File 'autoscaling/cfn_launch_configuration.rb', line 186

def updated_properties()
  jsii_get_property("updatedProperties")
end

#user_data ⇒ String?

The Base64-encoded user data to make available to the launched EC2 instances.

Returns:

  • (String, nil) 


424
425
426
 
# File 'autoscaling/cfn_launch_configuration.rb', line 424

def user_data()
  jsii_get_property("userData")
end

#user_data=(value) ⇒ Object 



428
429
430
431
 
# File 'autoscaling/cfn_launch_configuration.rb', line 428

def user_data=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "userData") unless value.nil?
  jsii_set_property("userData", value)
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


710
711
712
713
 
# File 'autoscaling/cfn_launch_configuration.rb', line 710

def validate_properties(_properties)
  Jsii::Type.check_type(_properties, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "_properties")
  jsii_call_method("validateProperties", [_properties])
end

#with(*mixins) ⇒ Constructs::IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

Parameters:

  • mixins (Array<Constructs::IMixin>)

Returns:

  • (Constructs::IConstruct) 


449
450
451
452
453
454
 
# File 'autoscaling/cfn_launch_configuration.rb', line 449

def with(*mixins)
  mixins.each_with_index do |item, index|
    Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLklNaXhpbiJ9")), "mixins[#{index}]")
  end
  jsii_call_method("with", [*mixins])
end