Package software.amazon.awscdk.services.ec2

Interface LaunchTemplateProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

LaunchTemplateProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.101.0 (build b95fe5d)",
           date="2024-07-12T19:34:00.963Z")
@Stability(Stable)
public interface LaunchTemplateProps
extends software.amazon.jsii.JsiiSerializable

Properties of a LaunchTemplate.

Example:

 Vpc vpc;
 SecurityGroup sg1 = SecurityGroup.Builder.create(this, "sg1")
         .vpc(vpc)
         .build();
 SecurityGroup sg2 = SecurityGroup.Builder.create(this, "sg2")
         .vpc(vpc)
         .build();
 LaunchTemplate launchTemplate = LaunchTemplate.Builder.create(this, "LaunchTemplate")
         .machineImage(MachineImage.latestAmazonLinux2023())
         .securityGroup(sg1)
         .build();
 launchTemplate.addSecurityGroup(sg2);
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	LaunchTemplateProps.Builder	A builder for LaunchTemplateProps
static final class	LaunchTemplateProps.Jsii$Proxy	An implementation for LaunchTemplateProps

Method Summary

Modifier and Type	Method	Description
static LaunchTemplateProps.Builder	builder()
default Boolean	getAssociatePublicIpAddress()	Whether instances should have a public IP addresses associated with them.
default List<BlockDevice>	getBlockDevices()	Specifies how block devices are exposed to the instance.
default CpuCredits	getCpuCredits()	CPU credit type for burstable EC2 instance types.
default Boolean	getDetailedMonitoring()	If set to true, then detailed monitoring will be enabled on instances created with this launch template.
default Boolean	getDisableApiTermination()	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;
default Boolean	getEbsOptimized()	Indicates whether the instances are optimized for Amazon EBS I/O.
default Boolean	getHibernationConfigured()	If you set this parameter to true, the instance is enabled for hibernation.
default Boolean	getHttpEndpoint()	Enables or disables the HTTP metadata endpoint on your instances.
default Boolean	getHttpProtocolIpv6()	Enables or disables the IPv6 endpoint for the instance metadata service.
default Number	getHttpPutResponseHopLimit()	The desired HTTP PUT response hop limit for instance metadata requests.
default LaunchTemplateHttpTokens	getHttpTokens()	The state of token usage for your instance metadata requests.
default InstanceInitiatedShutdownBehavior	getInstanceInitiatedShutdownBehavior()	Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
default Boolean	getInstanceMetadataTags()	Set to enabled to allow access to instance tags from the instance metadata.
default IInstanceProfile	getInstanceProfile()	The instance profile used to pass role information to EC2 instances.
default InstanceType	getInstanceType()	Type of instance to launch.
default String	getKeyName()	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
default IKeyPair	getKeyPair()	The SSH keypair to grant access to the instance.
default String	getLaunchTemplateName()	Name for this launch template.
default IMachineImage	getMachineImage()	The AMI that will be used by instances.
default Boolean	getNitroEnclaveEnabled()	If this parameter is set to true, the instance is enabled for AWS Nitro Enclaves;
default Boolean	getRequireImdsv2()	Whether IMDSv2 should be required on launched instances.
default IRole	getRole()	An IAM role to associate with the instance profile that is used by instances.
default ISecurityGroup	getSecurityGroup()	Security group to assign to instances created with the launch template.
default LaunchTemplateSpotOptions	getSpotOptions()	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 UserData	getUserData()	The AMI that will be used by instances.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAssociatePublicIpAddress

@Stability(Stable)
@Nullable
default Boolean getAssociatePublicIpAddress()

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

Default: - Use subnet settings

getBlockDevices

@Stability(Stable)
@Nullable
default List<BlockDevice> getBlockDevices()

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

See Also:

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

getCpuCredits

@Stability(Stable)
@Nullable
default CpuCredits getCpuCredits()

CPU credit type for burstable EC2 instance types.

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

See Also:

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

getDetailedMonitoring

@Stability(Stable)
@Nullable
default Boolean getDetailedMonitoring()

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

Default: False - Detailed monitoring is disabled.

See Also:

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

getDisableApiTermination

@Stability(Stable)
@Nullable
default Boolean getDisableApiTermination()

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.

getEbsOptimized

@Stability(Stable)
@Nullable
default Boolean getEbsOptimized()

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.

getHibernationConfigured

@Stability(Stable)
@Nullable
default Boolean getHibernationConfigured()

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.

getHttpEndpoint

@Stability(Stable)
@Nullable
default Boolean getHttpEndpoint()

Enables or disables the HTTP metadata endpoint on your instances.

Default: true

See Also:

• https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-metadataoptions.html#cfn-ec2-launchtemplate-launchtemplatedata-metadataoptions-httpendpoint

getHttpProtocolIpv6

@Stability(Stable)
@Nullable
default Boolean getHttpProtocolIpv6()

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

Default: true

See Also:

• https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-metadataoptions.html#cfn-ec2-launchtemplate-launchtemplatedata-metadataoptions-httpprotocolipv6

getHttpPutResponseHopLimit

@Stability(Stable)
@Nullable
default Number getHttpPutResponseHopLimit()

The desired HTTP PUT response hop limit for instance metadata requests.

The larger the number, the further instance metadata requests can travel.

Default: 1

See Also:

• https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-metadataoptions.html#cfn-ec2-launchtemplate-launchtemplatedata-metadataoptions-httpputresponsehoplimit

getHttpTokens

@Stability(Stable)
@Nullable
default LaunchTemplateHttpTokens getHttpTokens()

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

See Also:

• https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-metadataoptions.html#cfn-ec2-launchtemplate-launchtemplatedata-metadataoptions-httptokens

getInstanceInitiatedShutdownBehavior

@Stability(Stable)
@Nullable
default InstanceInitiatedShutdownBehavior getInstanceInitiatedShutdownBehavior()

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.

See Also:

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

getInstanceMetadataTags

@Stability(Stable)
@Nullable
default Boolean getInstanceMetadataTags()

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

See Also:

• https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-metadataoptions.html#cfn-ec2-launchtemplate-launchtemplatedata-metadataoptions-instancemetadatatags

getInstanceProfile

@Stability(Stable)
@Nullable
default IInstanceProfile getInstanceProfile()

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

getInstanceType

@Stability(Stable)
@Nullable
default InstanceType getInstanceType()

Type of instance to launch.

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

getKeyName

@Stability(Deprecated)
@Deprecated
@Nullable
default String getKeyName()

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

(deprecated) Name of SSH keypair to grant access to instance.

Default: - No SSH access will be possible.

getKeyPair

@Stability(Stable)
@Nullable
default IKeyPair getKeyPair()

The SSH keypair to grant access to the instance.

Default: - No SSH access will be possible.

getLaunchTemplateName

@Stability(Stable)
@Nullable
default String getLaunchTemplateName()

Name for this launch template.

Default: Automatically generated name

getMachineImage

@Stability(Stable)
@Nullable
default IMachineImage getMachineImage()

The AMI that will be used by instances.

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

getNitroEnclaveEnabled

@Stability(Stable)
@Nullable
default Boolean getNitroEnclaveEnabled()

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.

getRequireImdsv2

@Stability(Stable)
@Nullable
default Boolean getRequireImdsv2()

Whether IMDSv2 should be required on launched instances.

Default: - false

getRole

@Stability(Stable)
@Nullable
default IRole getRole()

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.

Example:

 Role role = Role.Builder.create(this, "MyRole")
         .assumedBy(new ServicePrincipal("ec2.amazonaws.com"))
         .build();
 

getSecurityGroup

@Stability(Stable)
@Nullable
default ISecurityGroup getSecurityGroup()

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

Default: No security group is assigned.

getSpotOptions

@Stability(Stable)
@Nullable
default LaunchTemplateSpotOptions getSpotOptions()

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.

getUserData

@Stability(Stable)
@Nullable
default UserData getUserData()

The AMI that will be used by instances.

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

builder

@Stability(Stable)
static LaunchTemplateProps.Builder builder()

Returns:

a LaunchTemplateProps.Builder of LaunchTemplateProps