AWS Fundamentals Logo
AWS Fundamentals
L2 Construct

LaunchTemplate

This represents an EC2 LaunchTemplate.

Import

import { LaunchTemplate } from 'aws-cdk-lib/aws-ec2';

Or use the module namespace:

import * as ec2 from 'aws-cdk-lib/aws-ec2';
// ec2.LaunchTemplate

Properties

Configuration passed to the constructor as LaunchTemplateProps.

associatePublicIpAddressOptional
boolean

Whether instances should have a public IP addresses associated with them.

Default: - Use subnet settings

blockDevicesOptional
BlockDevice[]

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.

Default: - Uses the block device mapping of the AMI

cpuCreditsOptional
CpuCredits

CPU credit type for burstable EC2 instance types.

Default: - No credit type is specified in the Launch Template.

detailedMonitoringOptional
boolean

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

Default: False - Detailed monitoring is disabled.

disableApiTerminationOptional
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; otherwise, you can.

Default: - The API termination setting is not specified in the Launch Template.

ebsOptimizedOptional
boolean

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.

Default: - EBS optimization is not specified in the launch template.

hibernationConfiguredOptional
boolean

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

Default: - Hibernation configuration is not specified in the launch template; defaulting to false.

httpEndpointOptional
boolean

Enables or disables the HTTP metadata endpoint on your instances.

Default: true

httpProtocolIpv6Optional
boolean

Enables or disables the IPv6 endpoint for the instance metadata service.

Default: true

httpPutResponseHopLimitOptional
number

The desired HTTP PUT response hop limit for instance metadata requests. The larger the number, the further instance metadata requests can travel.

Default: 1

httpTokensOptional
LaunchTemplateHttpTokens

The state of token usage for your instance metadata requests. The default state is `optional` if not specified. However, if requireImdsv2 is true, the state must be `required`.

Default: LaunchTemplateHttpTokens.OPTIONAL

instanceInitiatedShutdownBehaviorOptional
InstanceInitiatedShutdownBehavior

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

Default: - Shutdown behavior is not specified in the launch template; defaults to STOP.

instanceMetadataTagsOptional
boolean

Set to enabled to allow access to instance tags from the instance metadata. Set to disabled to turn off access to instance tags from the instance metadata.

Default: false

instanceProfileOptional
IInstanceProfile

The instance profile used to pass role information to EC2 instances. Note: You can provide an instanceProfile or a role, but not both.

Default: - No instance profile

instanceTypeOptional
InstanceType

Type of instance to launch.

Default: - This Launch Template does not specify a default Instance Type.

keyNameOptionalDeprecated
string

Name of SSH keypair to grant access to instance.

Default: - No SSH access will be possible.

Deprecated: - Use `keyPair` instead - https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ec2-readme.html#using-an-existing-ec2-key-pair

keyPairOptional
IKeyPair

The SSH keypair to grant access to the instance.

Default: - No SSH access will be possible.

launchTemplateNameOptional
string

Name for this launch template.

Default: Automatically generated name

machineImageOptional
IMachineImage

The AMI that will be used by instances.

Default: - This Launch Template does not specify a default AMI.

nitroEnclaveEnabledOptional
boolean

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

Default: - Enablement of Nitro enclaves is not specified in the launch template; defaulting to false.

placementGroupOptional
IPlacementGroupRef

The placement group that you want to launch the instance into.

Default: - no placement group will be used for this launch template.

requireImdsv2Optional
boolean

Whether IMDSv2 should be required on launched instances.

Default: - false

roleOptional
IRole

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`. Note: You can provide an instanceProfile or a role, but not both.

Default: - No new role is created.

securityGroupOptional
ISecurityGroup

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

Default: No security group is assigned.

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

Default: - Instance launched with this template will not be spot instances.

userDataOptional
UserData

The user data to make available to the instance.

Default: - This Launch Template creates a UserData based on the type of provided machineImage; no UserData is created if a machineImage is not provided

versionDescriptionOptional
string

A description for the first version of the launch template. The version description must be maximum 255 characters long.

Default: - No description

Get the Amazon EC2 Cheat Sheet

Everything you need to know about Amazon EC2 on one page. HD quality, print-friendly.

Download Free Infographic