Class: AWSCDK::EC2::LaunchTemplate

Inherits:
Resource
  • Object
show all
Includes:
IConnectable, ILaunchTemplate, IAM::IGrantable
Defined in:
ec2/launch_template.rb

Overview

This represents an EC2 LaunchTemplate.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props = nil) ⇒ LaunchTemplate

Returns a new instance of LaunchTemplate.

Parameters:



16
17
18
19
20
21
22
 
# File 'ec2/launch_template.rb', line 16

def initialize(scope, id, props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::EC2::LaunchTemplateProps.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("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWMyLkxhdW5jaFRlbXBsYXRlUHJvcHMifQ==")), "props") unless props.nil?
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.from_launch_template_attributes(scope, id, attrs) ⇒ AWSCDK::EC2::ILaunchTemplate

Import an existing LaunchTemplate.

Parameters:

Returns:



61
62
63
64
65
66
67
 
# File 'ec2/launch_template.rb', line 61

def self.from_launch_template_attributes(scope, id, attrs)
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  attrs = attrs.is_a?(Hash) ? ::AWSCDK::EC2::LaunchTemplateAttributes.new(**attrs.transform_keys(&:to_sym)) : attrs
  Jsii::Type.check_type(attrs, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWMyLkxhdW5jaFRlbXBsYXRlQXR0cmlidXRlcyJ9")), "attrs")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_ec2.LaunchTemplate", "fromLaunchTemplateAttributes", [scope, id, attrs])
end

.jsii_overridable_methods ⇒ Object 



24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
 
# File 'ec2/launch_template.rb', line 24

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :physical_name => { kind: :property, name: "physicalName", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :connections => { kind: :property, name: "connections", is_optional: false },
    :default_version_number => { kind: :property, name: "defaultVersionNumber", is_optional: false },
    :grant_principal => { kind: :property, name: "grantPrincipal", is_optional: false },
    :latest_version_number => { kind: :property, name: "latestVersionNumber", is_optional: false },
    :launch_template_ref => { kind: :property, name: "launchTemplateRef", is_optional: false },
    :tags => { kind: :property, name: "tags", is_optional: false },
    :version_number => { kind: :property, name: "versionNumber", is_optional: false },
    :image_id => { kind: :property, name: "imageId", is_optional: true },
    :instance_type => { kind: :property, name: "instanceType", is_optional: true },
    :launch_template_id => { kind: :property, name: "launchTemplateId", is_optional: true },
    :launch_template_name => { kind: :property, name: "launchTemplateName", is_optional: true },
    :os_type => { kind: :property, name: "osType", is_optional: true },
    :role => { kind: :property, name: "role", 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 },
    :apply_cross_stack_reference_strength => { kind: :method, name: "applyCrossStackReferenceStrength", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
    :generate_physical_name => { kind: :method, name: "generatePhysicalName", is_optional: false },
    :get_resource_arn_attribute => { kind: :method, name: "getResourceArnAttribute", is_optional: false },
    :get_resource_name_attribute => { kind: :method, name: "getResourceNameAttribute", is_optional: false },
    :add_security_group => { kind: :method, name: "addSecurityGroup", is_optional: false },
  }
end

.PROPERTY_INJECTION_ID ⇒ String

Uniquely identifies this class.

Returns:

  • (String) 


115
116
117
 
# File 'ec2/launch_template.rb', line 115

def self.PROPERTY_INJECTION_ID()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_ec2.LaunchTemplate", "PROPERTY_INJECTION_ID")
end

Instance Method Details

#add_security_group(security_group) ⇒ void

This method returns an undefined value.

Add the security group to the instance.

Parameters:



315
316
317
318
 
# File 'ec2/launch_template.rb', line 315

def add_security_group(security_group)
  Jsii::Type.check_type(security_group, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWMyLklTZWN1cml0eUdyb3VwIn0=")), "securityGroup")
  jsii_call_method("addSecurityGroup", [security_group])
end

#apply_cross_stack_reference_strength(strength) ⇒ void

This method returns an undefined value.

Override the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified mechanism instead of the global default determined by the @aws-cdk/core:defaultCrossStackReferences context key. This is useful for selectively weakening specific references to avoid the "deadly embrace" problem without changing the app-wide default.

Parameters:



254
255
256
257
 
# File 'ec2/launch_template.rb', line 254

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) ⇒ void

This method returns an undefined value.

Apply the given removal policy to this resource.

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).

Parameters:



271
272
273
274
 
# File 'ec2/launch_template.rb', line 271

def apply_removal_policy(policy)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy")
  jsii_call_method("applyRemovalPolicy", [policy])
end

#connections ⇒ AWSCDK::EC2::Connections

Allows specifying security group connections for the instance.

Returns:



122
123
124
 
# File 'ec2/launch_template.rb', line 122

def connections()
  jsii_get_property("connections")
end

#default_version_number ⇒ String

The default version for the launch template.

Returns:

  • (String) 


129
130
131
 
# File 'ec2/launch_template.rb', line 129

def default_version_number()
  jsii_get_property("defaultVersionNumber")
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

Returns:



87
88
89
 
# File 'ec2/launch_template.rb', line 87

def env()
  jsii_get_property("env")
end

#generate_physical_name ⇒ String

Returns:

  • (String) 


277
278
279
 
# File 'ec2/launch_template.rb', line 277

def generate_physical_name()
  jsii_call_method("generatePhysicalName", [])
end

#get_resource_arn_attribute(arn_attr, arn_components) ⇒ String

Returns an environment-sensitive token that should be used for the resource's "ARN" attribute (e.g. bucket.bucketArn).

Normally, this token will resolve to arn_attr, but if the resource is referenced across environments, arn_components will be used to synthesize a concrete ARN with the resource's physical name. Make sure to reference this.physicalName in arn_components.

Parameters:

  • arn_attr (String) —

    The CFN attribute which resolves to the ARN of the resource.

  • arn_components (AWSCDK::ARNComponents) —

    The format of the ARN of this resource.

Returns:

  • (String) 


291
292
293
294
295
296
 
# File 'ec2/launch_template.rb', line 291

def get_resource_arn_attribute(arn_attr, arn_components)
  Jsii::Type.check_type(arn_attr, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "arnAttr")
  arn_components = arn_components.is_a?(Hash) ? ::AWSCDK::ARNComponents.new(**arn_components.transform_keys(&:to_sym)) : arn_components
  Jsii::Type.check_type(arn_components, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5Bcm5Db21wb25lbnRzIn0=")), "arnComponents")
  jsii_call_method("getResourceArnAttribute", [arn_attr, arn_components])
end

#get_resource_name_attribute(name_attr) ⇒ String

Returns an environment-sensitive token that should be used for the resource's "name" attribute (e.g. bucket.bucketName).

Normally, this token will resolve to name_attr, but if the resource is referenced across environments, it will be resolved to this.physicalName, which will be a concrete name.

Parameters:

  • name_attr (String) —

    The CFN attribute which resolves to the resource's name.

Returns:

  • (String) 


306
307
308
309
 
# File 'ec2/launch_template.rb', line 306

def get_resource_name_attribute(name_attr)
  Jsii::Type.check_type(name_attr, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "nameAttr")
  jsii_call_method("getResourceNameAttribute", [name_attr])
end

#grant_principal ⇒ AWSCDK::IAM::IPrincipal

Principal to grant permissions to.

Returns:



136
137
138
 
# File 'ec2/launch_template.rb', line 136

def grant_principal()
  jsii_get_property("grantPrincipal")
end

#image_id ⇒ String?

The AMI ID of the image to use.

Returns:

  • (String, nil) 


171
172
173
 
# File 'ec2/launch_template.rb', line 171

def image_id()
  jsii_get_property("imageId")
end

#instance_type ⇒ AWSCDK::EC2::InstanceType?

Type of instance to launch.

Returns:



178
179
180
 
# File 'ec2/launch_template.rb', line 178

def instance_type()
  jsii_get_property("instanceType")
end

#latest_version_number ⇒ String

The latest version of the launch template.

Returns:

  • (String) 


143
144
145
 
# File 'ec2/launch_template.rb', line 143

def latest_version_number()
  jsii_get_property("latestVersionNumber")
end

#launch_template_id ⇒ String?

The identifier of the Launch Template.

Exactly one of launch_template_id and launch_template_name will be set.

Returns:

  • (String, nil) 


187
188
189
 
# File 'ec2/launch_template.rb', line 187

def launch_template_id()
  jsii_get_property("launchTemplateId")
end

#launch_template_name ⇒ String?

The name of the Launch Template.

Exactly one of launch_template_id and launch_template_name will be set.

Returns:

  • (String, nil) 


196
197
198
 
# File 'ec2/launch_template.rb', line 196

def launch_template_name()
  jsii_get_property("launchTemplateName")
end

#launch_template_ref ⇒ AWSCDK::Interfaces::AWSEC2::LaunchTemplateReference

A reference to a LaunchTemplate resource.

Returns:



150
151
152
 
# File 'ec2/launch_template.rb', line 150

def launch_template_ref()
  jsii_get_property("launchTemplateRef")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


72
73
74
 
# File 'ec2/launch_template.rb', line 72

def node()
  jsii_get_property("node")
end

#os_type ⇒ AWSCDK::EC2::OperatingSystemType?

The type of OS the instance is running.

Returns:



203
204
205
 
# File 'ec2/launch_template.rb', line 203

def os_type()
  jsii_get_property("osType")
end

#physical_name ⇒ String

Returns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource.

This value will resolve to one of the following:

  • a concrete value (e.g. "my-awesome-bucket")
  • undefined, when a name should be generated by CloudFormation
  • a concrete name generated automatically during synthesis, in cross-environment scenarios.

Returns:

  • (String) 


101
102
103
 
# File 'ec2/launch_template.rb', line 101

def physical_name()
  jsii_get_property("physicalName")
end

#role ⇒ AWSCDK::IAM::IRole?

IAM Role assumed by instances that are launched from this template.

Returns:



210
211
212
 
# File 'ec2/launch_template.rb', line 210

def role()
  jsii_get_property("role")
end

#stack ⇒ AWSCDK::Stack

The stack in which this resource is defined.

Returns:



108
109
110
 
# File 'ec2/launch_template.rb', line 108

def stack()
  jsii_get_property("stack")
end

#tags ⇒ AWSCDK::TagManager

TagManager for tagging support.

Returns:



157
158
159
 
# File 'ec2/launch_template.rb', line 157

def tags()
  jsii_get_property("tags")
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) 


224
225
226
 
# File 'ec2/launch_template.rb', line 224

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

#user_data ⇒ AWSCDK::EC2::UserData?

UserData executed by instances that are launched from this template.

Returns:



217
218
219
 
# File 'ec2/launch_template.rb', line 217

def user_data()
  jsii_get_property("userData")
end

#version_number ⇒ String

The version number of this launch template to use.

Returns:

  • (String) 


164
165
166
 
# File 'ec2/launch_template.rb', line 164

def version_number()
  jsii_get_property("versionNumber")
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) 


237
238
239
240
241
242
 
# File 'ec2/launch_template.rb', line 237

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