software.amazon.awscdk.services.ec2

Class LaunchTemplate

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.Resource

software.amazon.awscdk.services.ec2.LaunchTemplate

All Implemented Interfaces:

IResource, IConnectable, ILaunchTemplate, IGrantable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:38.464Z")
 @Stability(value=Stable)
public class LaunchTemplate
extends Resource
implements ILaunchTemplate, IGrantable, IConnectable

This represents an EC2 LaunchTemplate.

Example:

 // Example automatically generated from non-compiling source. May contain errors.
 UserData bootHookConf = UserData.forLinux();
 bootHookConf.addCommands("cloud-init-per once docker_options echo 'OPTIONS=\"${OPTIONS} --storage-opt dm.basesize=40G\"' >> /etc/sysconfig/docker");
 UserData setupCommands = UserData.forLinux();
 setupCommands.addCommands("sudo yum install awscli && echo Packages installed らと > /var/tmp/setup");
 MultipartUserData multipartUserData = new MultipartUserData();
 // The docker has to be configured at early stage, so content type is overridden to boothook
 multipartUserData.addPart(MultipartBody.fromUserData(bootHookConf, "text/cloud-boothook; charset=\"us-ascii\""));
 // Execute the rest of setup
 multipartUserData.addPart(MultipartBody.fromUserData(setupCommands));
 LaunchTemplate.Builder.create(this, "")
         .userData(multipartUserData)
         .blockDevices(List.of())
         .build();
 

See Also:

https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LaunchTemplate.Builder A fluent builder for LaunchTemplate.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.ec2.ILaunchTemplate

ILaunchTemplate.Jsii$Default, ILaunchTemplate.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.iam.IGrantable

IGrantable.Jsii$Default, IGrantable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.ec2.IConnectable

IConnectable.Jsii$Default, IConnectable.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
	LaunchTemplate(software.constructs.Construct scope, String id)
	LaunchTemplate(software.constructs.Construct scope, String id, LaunchTemplateProps props)
protected	LaunchTemplate(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	LaunchTemplate(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
static ILaunchTemplate	fromLaunchTemplateAttributes(software.constructs.Construct scope, String id, LaunchTemplateAttributes attrs) Import an existing LaunchTemplate.
Connections	getConnections() Allows specifying security group connections for the instance.
String	getDefaultVersionNumber() The default version for the launch template.
IPrincipal	getGrantPrincipal() Principal to grant permissions to.
String	getImageId() The AMI ID of the image to use.
InstanceType	getInstanceType() Type of instance to launch.
String	getLatestVersionNumber() The latest version of the launch template.
String	getLaunchTemplateId() The identifier of the Launch Template.
String	getLaunchTemplateName() The name of the Launch Template.
OperatingSystemType	getOsType() The type of OS the instance is running.
IRole	getRole() IAM Role assumed by instances that are launched from this template.
protected TagManager	getTags() TagManager for tagging support.
UserData	getUserData() UserData executed by instances that are launched from this template.
String	getVersionNumber() The version number of this launch template to use.

Methods inherited from class software.amazon.awscdk.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isOwnedResource, isResource

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awscdk.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

LaunchTemplate

protected LaunchTemplate(software.amazon.jsii.JsiiObjectRef objRef)

LaunchTemplate

protected LaunchTemplate(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

LaunchTemplate

@Stability(value=Stable)
public LaunchTemplate(@NotNull
                                               software.constructs.Construct scope,
                                               @NotNull
                                               String id,
                                               @Nullable
                                               LaunchTemplateProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props -

LaunchTemplate

@Stability(value=Stable)
public LaunchTemplate(@NotNull
                                               software.constructs.Construct scope,
                                               @NotNull
                                               String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Method Detail

fromLaunchTemplateAttributes

@Stability(value=Stable)
 @NotNull
public static ILaunchTemplate fromLaunchTemplateAttributes(@NotNull
                                                                                              software.constructs.Construct scope,
                                                                                              @NotNull
                                                                                              String id,
                                                                                              @NotNull
                                                                                              LaunchTemplateAttributes attrs)

Import an existing LaunchTemplate.

Parameters:

scope - This parameter is required.

id - This parameter is required.

attrs - This parameter is required.

getConnections

@Stability(value=Stable)
 @NotNull
public Connections getConnections()

Allows specifying security group connections for the instance.

Specified by:

getConnections in interface IConnectable

getDefaultVersionNumber

@Stability(value=Stable)
 @NotNull
public String getDefaultVersionNumber()

The default version for the launch template.

getGrantPrincipal

@Stability(value=Stable)
 @NotNull
public IPrincipal getGrantPrincipal()

Principal to grant permissions to.

Specified by:

getGrantPrincipal in interface IGrantable

getLatestVersionNumber

@Stability(value=Stable)
 @NotNull
public String getLatestVersionNumber()

The latest version of the launch template.

getTags

@Stability(value=Stable)
 @NotNull
protected TagManager getTags()

TagManager for tagging support.

getVersionNumber

@Stability(value=Stable)
 @NotNull
public String getVersionNumber()

The version number of this launch template to use.

Specified by:

getVersionNumber in interface ILaunchTemplate

getImageId

@Stability(value=Stable)
 @Nullable
public String getImageId()

The AMI ID of the image to use.

getInstanceType

@Stability(value=Stable)
 @Nullable
public InstanceType getInstanceType()

Type of instance to launch.

getLaunchTemplateId

@Stability(value=Stable)
 @Nullable
public String getLaunchTemplateId()

The identifier of the Launch Template.

Exactly one of launchTemplateId and launchTemplateName will be set.

Specified by:

getLaunchTemplateId in interface ILaunchTemplate

getLaunchTemplateName

@Stability(value=Stable)
 @Nullable
public String getLaunchTemplateName()

The name of the Launch Template.

Exactly one of launchTemplateId and launchTemplateName will be set.

Specified by:

getLaunchTemplateName in interface ILaunchTemplate

getOsType

@Stability(value=Stable)
 @Nullable
public OperatingSystemType getOsType()

The type of OS the instance is running.

getRole

@Stability(value=Stable)
 @Nullable
public IRole getRole()

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

getUserData

@Stability(value=Stable)
 @Nullable
public UserData getUserData()

UserData executed by instances that are launched from this template.