class LaunchTemplate (construct)

Language	Type name
.NET	Amazon.CDK.AWS.EC2.LaunchTemplate
Java	software.amazon.awscdk.services.ec2.LaunchTemplate
Python	aws_cdk.aws_ec2.LaunchTemplate
TypeScript (source)	@aws-cdk/aws-ec2 » LaunchTemplate

Implements IConstruct, IConstruct, IDependable, IResource, ILaunchTemplate, IGrantable, IConnectable

This represents an EC2 LaunchTemplate.

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

Example

const bootHookConf = ec2.UserData.forLinux();
bootHookConf.addCommands('cloud-init-per once docker_options echo \'OPTIONS="${OPTIONS} --storage-opt dm.basesize=40G"\' >> /etc/sysconfig/docker');

const setupCommands = ec2.UserData.forLinux();
setupCommands.addCommands('sudo yum install awscli && echo Packages installed らと > /var/tmp/setup');

const multipartUserData = new ec2.MultipartUserData();
// The docker has to be configured at early stage, so content type is overridden to boothook
multipartUserData.addPart(ec2.MultipartBody.fromUserData(bootHookConf, 'text/cloud-boothook; charset="us-ascii"'));
// Execute the rest of setup
multipartUserData.addPart(ec2.MultipartBody.fromUserData(setupCommands));

new ec2.LaunchTemplate(this, '', {
  userData: multipartUserData,
  blockDevices: [
    // Block device configuration rest
  ]
});

Initializer

new LaunchTemplate(scope: Construct, id: string, props?: LaunchTemplateProps)

Parameters

• scope Construct
• id string
• props LaunchTemplateProps

Construct Props

Name	Type	Description
blockDevices?	BlockDevice[]	Specifies how block devices are exposed to the instance. You can specify virtual devices and EBS volumes.
cpuCredits?	CpuCredits	CPU credit type for burstable EC2 instance types.
detailedMonitoring?	boolean	If set to true, then detailed monitoring will be enabled on instances created with this launch template.
disableApiTermination?	boolean	If you set this parameter to true, you cannot terminate the instances launched with this launch template using the Amazon EC2 console, CLI, or API;
ebsOptimized?	boolean	Indicates whether the instances are optimized for Amazon EBS I/O.
hibernationConfigured?	boolean	If you set this parameter to true, the instance is enabled for hibernation.
instanceInitiatedShutdownBehavior?	InstanceInitiatedShutdownBehavior	Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
instanceType?	InstanceType	Type of instance to launch.
keyName?	string	Name of SSH keypair to grant access to instance.
launchTemplateName?	string	Name for this launch template.
machineImage?	IMachineImage	The AMI that will be used by instances.
nitroEnclaveEnabled?	boolean	If this parameter is set to true, the instance is enabled for AWS Nitro Enclaves;
requireImdsv2?	boolean	Whether IMDSv2 should be required on launched instances.
role?	IRole	An IAM role to associate with the instance profile that is used by instances.
securityGroup?	ISecurityGroup	Security group to assign to instances created with the launch template.
spotOptions?	LaunchTemplateSpotOptions	If this property is defined, then the Launch Template's InstanceMarketOptions will be set to use Spot instances, and the options for the Spot instances will be as defined.
userData?	UserData	The AMI that will be used by instances.

---

blockDevices?

Type: BlockDevice[] (optional, default: Uses the block device mapping of the AMI)

Specifies how block devices are exposed to the instance. You can specify virtual devices and EBS volumes.

Each instance that is launched has an associated root device volume, either an Amazon EBS volume or an instance store volume. You can use block device mappings to specify additional EBS volumes or instance store volumes to attach to an instance when it is launched.

See also: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-device-mapping-concepts.html

---

cpuCredits?

Type: CpuCredits (optional, default: No credit type is specified in the Launch Template.)

CPU credit type for burstable EC2 instance types.

See also: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances.html

---

detailedMonitoring?

Type: boolean (optional, default: False - Detailed monitoring is disabled.)

If set to true, then detailed monitoring will be enabled on instances created with this launch template.

See also: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-cloudwatch-new.html

---

disableApiTermination?

Type: boolean (optional, default: The API termination setting is not specified in the Launch Template.)

If you set this parameter to true, you cannot terminate the instances launched with this launch template using the Amazon EC2 console, CLI, or API;

otherwise, you can.

---

ebsOptimized?

Type: boolean (optional, default: EBS optimization is not specified in the launch template.)

Indicates whether the instances are optimized for Amazon EBS I/O.

This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal Amazon EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS-optimized instance.

---

hibernationConfigured?

Type: boolean (optional, default: Hibernation configuration is not specified in the launch template; defaulting to false.)

If you set this parameter to true, the instance is enabled for hibernation.

---

instanceInitiatedShutdownBehavior?

Type: InstanceInitiatedShutdownBehavior (optional, default: Shutdown behavior is not specified in the launch template; defaults to STOP.)

Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).

See also: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/terminating-instances.html#Using_ChangingInstanceInitiatedShutdownBehavior

---

instanceType?

Type: InstanceType (optional, default: This Launch Template does not specify a default Instance Type.)

Type of instance to launch.

---

keyName?

Type: string (optional, default: No SSH access will be possible.)

Name of SSH keypair to grant access to instance.

---

launchTemplateName?

Type: string (optional, default: Automatically generated name)

Name for this launch template.

---

machineImage?

Type: IMachineImage (optional, default: This Launch Template does not specify a default AMI.)

The AMI that will be used by instances.

---

nitroEnclaveEnabled?

Type: boolean (optional, default: Enablement of Nitro enclaves is not specified in the launch template; defaulting to false.)

If this parameter is set to true, the instance is enabled for AWS Nitro Enclaves;

otherwise, it is not enabled for AWS Nitro Enclaves.

---

requireImdsv2?

Type: boolean (optional, default: false)

Whether IMDSv2 should be required on launched instances.

---

role?

Type: IRole (optional, default: No new role is created.)

An IAM role to associate with the instance profile that is used by instances.

The role must be assumable by the service principal ec2.amazonaws.com: Example

const role = new iam.Role(this, 'MyRole', {
  assumedBy: new iam.ServicePrincipal('ec2.amazonaws.com')
});

---

securityGroup?

Type: ISecurityGroup (optional, default: No security group is assigned.)

Security group to assign to instances created with the launch template.

---

spotOptions?

Type: LaunchTemplateSpotOptions (optional, default: Instance launched with this template will not be spot instances.)

If this property is defined, then the Launch Template's InstanceMarketOptions will be set to use Spot instances, and the options for the Spot instances will be as defined.

---

userData?

Type: UserData (optional, default: This Launch Template creates a UserData based on the type of provided machineImage; no UserData is created if a machineImage is not provided)

The AMI that will be used by instances.

Properties

Name	Type	Description
connections	Connections	Allows specifying security group connections for the instance.
defaultVersionNumber	string	The default version for the launch template.
env	ResourceEnvironment	The environment this resource belongs to.
grantPrincipal	IPrincipal	Principal to grant permissions to.
latestVersionNumber	string	The latest version of the launch template.
node	ConstructNode	The construct tree node associated with this construct.
stack	Stack	The stack in which this resource is defined.
tags	TagManager	TagManager for tagging support.
versionNumber	string	The version number of this launch template to use.
imageId?	string	The AMI ID of the image to use.
instanceType?	InstanceType	Type of instance to launch.
launchTemplateId?	string	The identifier of the Launch Template.
launchTemplateName?	string	The name of the Launch Template.
osType?	OperatingSystemType	The type of OS the instance is running.
role?	IRole	IAM Role assumed by instances that are launched from this template.
userData?	UserData	UserData executed by instances that are launched from this template.

---

connections

Type: Connections

Allows specifying security group connections for the instance.

---

defaultVersionNumber

Type: string

The default version for the launch template.

---

env

Type: ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

---

grantPrincipal

Type: IPrincipal

Principal to grant permissions to.

---

latestVersionNumber

Type: string

The latest version of the launch template.

---

node

Type: ConstructNode

The construct tree node associated with this construct.

---

stack

Type: Stack

The stack in which this resource is defined.

---

tags

Type: TagManager

TagManager for tagging support.

---

versionNumber

Type: string

The version number of this launch template to use.

---

imageId?

Type: string (optional)

The AMI ID of the image to use.

---

instanceType?

Type: InstanceType (optional)

Type of instance to launch.

---

launchTemplateId?

Type: string (optional)

The identifier of the Launch Template.

Exactly one of launchTemplateId and launchTemplateName will be set.

---

launchTemplateName?

Type: string (optional)

The name of the Launch Template.

Exactly one of launchTemplateId and launchTemplateName will be set.

---

osType?

Type: OperatingSystemType (optional)

The type of OS the instance is running.

---

role?

Type: IRole (optional)

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

---

userData?

Type: UserData (optional)

UserData executed by instances that are launched from this template.

Methods

Name	Description
applyRemovalPolicy(policy)	Apply the given removal policy to this resource.
toString()	Returns a string representation of this construct.
static fromLaunchTemplateAttributes(scope, id, attrs)	Import an existing LaunchTemplate.

---

applyRemovalPolicy(policy)

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

• policy RemovalPolicy

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

---

toString()

public toString(): string

Returns

• string

Returns a string representation of this construct.

---

static fromLaunchTemplateAttributes(scope, id, attrs)

public static fromLaunchTemplateAttributes(scope: Construct, id: string, attrs: LaunchTemplateAttributes): ILaunchTemplate

Parameters

• scope Construct
• id string
• attrs LaunchTemplateAttributes

Returns

• ILaunchTemplate

Import an existing LaunchTemplate.