LaunchTemplate

Provides an EC2 launch template resource. Can be used to create instances or auto scaling groups.

Create a LaunchTemplate Resource

new LaunchTemplate(name: string, args?: LaunchTemplateArgs, opts?: CustomResourceOptions);

def LaunchTemplate(resource_name, opts=None, block_device_mappings=None, capacity_reservation_specification=None, cpu_options=None, credit_specification=None, description=None, disable_api_termination=None, ebs_optimized=None, elastic_gpu_specifications=None, elastic_inference_accelerator=None, hibernation_options=None, iam_instance_profile=None, image_id=None, instance_initiated_shutdown_behavior=None, instance_market_options=None, instance_type=None, kernel_id=None, key_name=None, license_specifications=None, metadata_options=None, monitoring=None, name=None, name_prefix=None, network_interfaces=None, placement=None, ram_disk_id=None, security_group_names=None, tag_specifications=None, tags=None, user_data=None, vpc_security_group_ids=None, __props__=None);

func NewLaunchTemplate(ctx *Context, name string, args *LaunchTemplateArgs, opts ...ResourceOption) (*LaunchTemplate, error)

public LaunchTemplate(string name, LaunchTemplateArgs? args = null, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args LaunchTemplateArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args LaunchTemplateArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args LaunchTemplateArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

LaunchTemplate Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The LaunchTemplate resource accepts the following input properties:

BlockDeviceMappings List<LaunchTemplateBlockDeviceMappingArgs>: Specify volumes to attach to the instance besides the volumes specified by the AMI. See Block Devices below for details.
CapacityReservationSpecification LaunchTemplateCapacityReservationSpecificationArgs: Targeting for EC2 capacity reservations. See Capacity Reservation Specification below for more details.
CpuOptions LaunchTemplateCpuOptionsArgs: The CPU options for the instance. See CPU Options below for more details.
CreditSpecification LaunchTemplateCreditSpecificationArgs: Customize the credit specification of the instance. See Credit Specification below for more details.
Description string: Description of the launch template.
DisableApiTermination bool: If true, enables EC2 Instance Termination Protection
EbsOptimized string: If true, the launched EC2 instance will be EBS-optimized.
ElasticGpuSpecifications List<LaunchTemplateElasticGpuSpecificationArgs>: The elastic GPU to attach to the instance. See Elastic GPU below for more details.
ElasticInferenceAccelerator LaunchTemplateElasticInferenceAcceleratorArgs: Configuration block containing an Elastic Inference Accelerator to attach to the instance. See Elastic Inference Accelerator below for more details.
HibernationOptions LaunchTemplateHibernationOptionsArgs: The hibernation options for the instance. See Hibernation Options below for more details.
IamInstanceProfile LaunchTemplateIamInstanceProfileArgs: The IAM Instance Profile to launch the instance with. See Instance Profile below for more details.
ImageId string: The AMI from which to launch the instance.
InstanceInitiatedShutdownBehavior string: Shutdown behavior for the instance. Can be stop or terminate. (Default: stop).
InstanceMarketOptions LaunchTemplateInstanceMarketOptionsArgs: The market (purchasing) option for the instance. See Market Options below for details.
InstanceType string: The type of the instance.
KernelId string: The kernel ID.
KeyName string: The key name to use for the instance.
LicenseSpecifications List<LaunchTemplateLicenseSpecificationArgs>: A list of license specifications to associate with. See License Specification below for more details.
MetadataOptions LaunchTemplateMetadataOptionsArgs: Customize the metadata options for the instance. See Metadata Options below for more details.
Monitoring LaunchTemplateMonitoringArgs: The monitoring option for the instance. See Monitoring below for more details.
Name string: The name of the launch template. If you leave this blank, this provider will auto-generate a unique name.
NamePrefix string: Creates a unique name beginning with the specified prefix. Conflicts with name.
NetworkInterfaces List<LaunchTemplateNetworkInterfaceArgs>: Customize network interfaces to be attached at instance boot time. See Network Interfaces below for more details.
Placement LaunchTemplatePlacementArgs: The placement of the instance. See Placement below for more details.
RamDiskId string: The ID of the RAM disk.
SecurityGroupNames List<string>: A list of security group names to associate with. If you are creating Instances in a VPC, use vpc_security_group_ids instead.
TagSpecifications List<LaunchTemplateTagSpecificationArgs>: The tags to apply to the resources during launch. See Tag Specifications below for more details.
Tags Dictionary<string, string>: A map of tags to assign to the launch template.
UserData string: The Base64-encoded user data to provide when launching the instance.
VpcSecurityGroupIds List<string>: A list of security group IDs to associate with.

BlockDeviceMappings []LaunchTemplateBlockDeviceMapping: Specify volumes to attach to the instance besides the volumes specified by the AMI. See Block Devices below for details.
CapacityReservationSpecification LaunchTemplateCapacityReservationSpecification: Targeting for EC2 capacity reservations. See Capacity Reservation Specification below for more details.
CpuOptions LaunchTemplateCpuOptions: The CPU options for the instance. See CPU Options below for more details.
CreditSpecification LaunchTemplateCreditSpecification: Customize the credit specification of the instance. See Credit Specification below for more details.
Description string: Description of the launch template.
DisableApiTermination bool: If true, enables EC2 Instance Termination Protection
EbsOptimized string: If true, the launched EC2 instance will be EBS-optimized.
ElasticGpuSpecifications []LaunchTemplateElasticGpuSpecification: The elastic GPU to attach to the instance. See Elastic GPU below for more details.
ElasticInferenceAccelerator LaunchTemplateElasticInferenceAccelerator: Configuration block containing an Elastic Inference Accelerator to attach to the instance. See Elastic Inference Accelerator below for more details.
HibernationOptions LaunchTemplateHibernationOptions: The hibernation options for the instance. See Hibernation Options below for more details.
IamInstanceProfile LaunchTemplateIamInstanceProfile: The IAM Instance Profile to launch the instance with. See Instance Profile below for more details.
ImageId string: The AMI from which to launch the instance.
InstanceInitiatedShutdownBehavior string: Shutdown behavior for the instance. Can be stop or terminate. (Default: stop).
InstanceMarketOptions LaunchTemplateInstanceMarketOptions: The market (purchasing) option for the instance. See Market Options below for details.
InstanceType string: The type of the instance.
KernelId string: The kernel ID.
KeyName string: The key name to use for the instance.
LicenseSpecifications []LaunchTemplateLicenseSpecification: A list of license specifications to associate with. See License Specification below for more details.
MetadataOptions LaunchTemplateMetadataOptions: Customize the metadata options for the instance. See Metadata Options below for more details.
Monitoring LaunchTemplateMonitoring: The monitoring option for the instance. See Monitoring below for more details.
Name string: The name of the launch template. If you leave this blank, this provider will auto-generate a unique name.
NamePrefix string: Creates a unique name beginning with the specified prefix. Conflicts with name.
NetworkInterfaces []LaunchTemplateNetworkInterface: Customize network interfaces to be attached at instance boot time. See Network Interfaces below for more details.
Placement LaunchTemplatePlacement: The placement of the instance. See Placement below for more details.
RamDiskId string: The ID of the RAM disk.
SecurityGroupNames []string: A list of security group names to associate with. If you are creating Instances in a VPC, use vpc_security_group_ids instead.
TagSpecifications []LaunchTemplateTagSpecification: The tags to apply to the resources during launch. See Tag Specifications below for more details.
Tags map[string]string: A map of tags to assign to the launch template.
UserData string: The Base64-encoded user data to provide when launching the instance.
VpcSecurityGroupIds []string: A list of security group IDs to associate with.

blockDeviceMappings LaunchTemplateBlockDeviceMapping[]: Specify volumes to attach to the instance besides the volumes specified by the AMI. See Block Devices below for details.
capacityReservationSpecification LaunchTemplateCapacityReservationSpecification: Targeting for EC2 capacity reservations. See Capacity Reservation Specification below for more details.
cpuOptions LaunchTemplateCpuOptions: The CPU options for the instance. See CPU Options below for more details.
creditSpecification LaunchTemplateCreditSpecification: Customize the credit specification of the instance. See Credit Specification below for more details.
description string: Description of the launch template.
disableApiTermination boolean: If true, enables EC2 Instance Termination Protection
ebsOptimized string: If true, the launched EC2 instance will be EBS-optimized.
elasticGpuSpecifications LaunchTemplateElasticGpuSpecification[]: The elastic GPU to attach to the instance. See Elastic GPU below for more details.
elasticInferenceAccelerator LaunchTemplateElasticInferenceAccelerator: Configuration block containing an Elastic Inference Accelerator to attach to the instance. See Elastic Inference Accelerator below for more details.
hibernationOptions LaunchTemplateHibernationOptions: The hibernation options for the instance. See Hibernation Options below for more details.
iamInstanceProfile LaunchTemplateIamInstanceProfile: The IAM Instance Profile to launch the instance with. See Instance Profile below for more details.
imageId string: The AMI from which to launch the instance.
instanceInitiatedShutdownBehavior string: Shutdown behavior for the instance. Can be stop or terminate. (Default: stop).
instanceMarketOptions LaunchTemplateInstanceMarketOptions: The market (purchasing) option for the instance. See Market Options below for details.
instanceType string: The type of the instance.
kernelId string: The kernel ID.
keyName string: The key name to use for the instance.
licenseSpecifications LaunchTemplateLicenseSpecification[]: A list of license specifications to associate with. See License Specification below for more details.
metadataOptions LaunchTemplateMetadataOptions: Customize the metadata options for the instance. See Metadata Options below for more details.
monitoring LaunchTemplateMonitoring: The monitoring option for the instance. See Monitoring below for more details.
name string: The name of the launch template. If you leave this blank, this provider will auto-generate a unique name.
namePrefix string: Creates a unique name beginning with the specified prefix. Conflicts with name.
networkInterfaces LaunchTemplateNetworkInterface[]: Customize network interfaces to be attached at instance boot time. See Network Interfaces below for more details.
placement LaunchTemplatePlacement: The placement of the instance. See Placement below for more details.
ramDiskId string: The ID of the RAM disk.
securityGroupNames string[]: A list of security group names to associate with. If you are creating Instances in a VPC, use vpc_security_group_ids instead.
tagSpecifications LaunchTemplateTagSpecification[]: The tags to apply to the resources during launch. See Tag Specifications below for more details.
tags {[key: string]: string}: A map of tags to assign to the launch template.
userData string: The Base64-encoded user data to provide when launching the instance.
vpcSecurityGroupIds string[]: A list of security group IDs to associate with.

block_device_mappings List[LaunchTemplateBlockDeviceMapping]: Specify volumes to attach to the instance besides the volumes specified by the AMI. See Block Devices below for details.
capacity_reservation_specification Dict[LaunchTemplateCapacityReservationSpecification]: Targeting for EC2 capacity reservations. See Capacity Reservation Specification below for more details.
cpu_options Dict[LaunchTemplateCpuOptions]: The CPU options for the instance. See CPU Options below for more details.
credit_specification Dict[LaunchTemplateCreditSpecification]: Customize the credit specification of the instance. See Credit Specification below for more details.
description str: Description of the launch template.
disable_api_termination bool: If true, enables EC2 Instance Termination Protection
ebs_optimized str: If true, the launched EC2 instance will be EBS-optimized.
elastic_gpu_specifications List[LaunchTemplateElasticGpuSpecification]: The elastic GPU to attach to the instance. See Elastic GPU below for more details.
elastic_inference_accelerator Dict[LaunchTemplateElasticInferenceAccelerator]: Configuration block containing an Elastic Inference Accelerator to attach to the instance. See Elastic Inference Accelerator below for more details.
hibernation_options Dict[LaunchTemplateHibernationOptions]: The hibernation options for the instance. See Hibernation Options below for more details.
iam_instance_profile Dict[LaunchTemplateIamInstanceProfile]: The IAM Instance Profile to launch the instance with. See Instance Profile below for more details.
image_id str: The AMI from which to launch the instance.
instance_initiated_shutdown_behavior str: Shutdown behavior for the instance. Can be stop or terminate. (Default: stop).
instance_market_options Dict[LaunchTemplateInstanceMarketOptions]: The market (purchasing) option for the instance. See Market Options below for details.
instance_type str: The type of the instance.
kernel_id str: The kernel ID.
key_name str: The key name to use for the instance.
license_specifications List[LaunchTemplateLicenseSpecification]: A list of license specifications to associate with. See License Specification below for more details.
metadata_options Dict[LaunchTemplateMetadataOptions]: Customize the metadata options for the instance. See Metadata Options below for more details.
monitoring Dict[LaunchTemplateMonitoring]: The monitoring option for the instance. See Monitoring below for more details.
name str: The name of the launch template. If you leave this blank, this provider will auto-generate a unique name.
name_prefix str: Creates a unique name beginning with the specified prefix. Conflicts with name.
network_interfaces List[LaunchTemplateNetworkInterface]: Customize network interfaces to be attached at instance boot time. See Network Interfaces below for more details.
placement Dict[LaunchTemplatePlacement]: The placement of the instance. See Placement below for more details.
ram_disk_id str: The ID of the RAM disk.
security_group_names List[str]: A list of security group names to associate with. If you are creating Instances in a VPC, use vpc_security_group_ids instead.
tag_specifications List[LaunchTemplateTagSpecification]: The tags to apply to the resources during launch. See Tag Specifications below for more details.
tags Dict[str, str]: A map of tags to assign to the launch template.
user_data str: The Base64-encoded user data to provide when launching the instance.
vpc_security_group_ids List[str]: A list of security group IDs to associate with.

Outputs

All input properties are implicitly available as output properties. Additionally, the LaunchTemplate resource produces the following output properties:

Arn string: The Amazon Resource Name (ARN) of the instance profile.
DefaultVersion int: The default version of the launch template.
Id string: The provider-assigned unique ID for this managed resource.
LatestVersion int: The latest version of the launch template.

Arn string: The Amazon Resource Name (ARN) of the instance profile.
DefaultVersion int: The default version of the launch template.
Id string: The provider-assigned unique ID for this managed resource.
LatestVersion int: The latest version of the launch template.

arn string: The Amazon Resource Name (ARN) of the instance profile.
defaultVersion number: The default version of the launch template.
id string: The provider-assigned unique ID for this managed resource.
latestVersion number: The latest version of the launch template.

arn str: The Amazon Resource Name (ARN) of the instance profile.
default_version float: The default version of the launch template.
id str: The provider-assigned unique ID for this managed resource.
latest_version float: The latest version of the launch template.

Look up an Existing LaunchTemplate Resource

Get an existing LaunchTemplate resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: LaunchTemplateState, opts?: CustomResourceOptions): LaunchTemplate

static get(resource_name, id, opts=None, arn=None, block_device_mappings=None, capacity_reservation_specification=None, cpu_options=None, credit_specification=None, default_version=None, description=None, disable_api_termination=None, ebs_optimized=None, elastic_gpu_specifications=None, elastic_inference_accelerator=None, hibernation_options=None, iam_instance_profile=None, image_id=None, instance_initiated_shutdown_behavior=None, instance_market_options=None, instance_type=None, kernel_id=None, key_name=None, latest_version=None, license_specifications=None, metadata_options=None, monitoring=None, name=None, name_prefix=None, network_interfaces=None, placement=None, ram_disk_id=None, security_group_names=None, tag_specifications=None, tags=None, user_data=None, vpc_security_group_ids=None, __props__=None);

func GetLaunchTemplate(ctx *Context, name string, id IDInput, state *LaunchTemplateState, opts ...ResourceOption) (*LaunchTemplate, error)

public static LaunchTemplate Get(string name, Input<string> id, LaunchTemplateState? state, CustomResourceOptions? opts = null)

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

Arn string: The Amazon Resource Name (ARN) of the instance profile.
BlockDeviceMappings List<LaunchTemplateBlockDeviceMappingArgs>: Specify volumes to attach to the instance besides the volumes specified by the AMI. See Block Devices below for details.
CapacityReservationSpecification LaunchTemplateCapacityReservationSpecificationArgs: Targeting for EC2 capacity reservations. See Capacity Reservation Specification below for more details.
CpuOptions LaunchTemplateCpuOptionsArgs: The CPU options for the instance. See CPU Options below for more details.
CreditSpecification LaunchTemplateCreditSpecificationArgs: Customize the credit specification of the instance. See Credit Specification below for more details.
DefaultVersion int: The default version of the launch template.
Description string: Description of the launch template.
DisableApiTermination bool: If true, enables EC2 Instance Termination Protection
EbsOptimized string: If true, the launched EC2 instance will be EBS-optimized.
ElasticGpuSpecifications List<LaunchTemplateElasticGpuSpecificationArgs>: The elastic GPU to attach to the instance. See Elastic GPU below for more details.
ElasticInferenceAccelerator LaunchTemplateElasticInferenceAcceleratorArgs: Configuration block containing an Elastic Inference Accelerator to attach to the instance. See Elastic Inference Accelerator below for more details.
HibernationOptions LaunchTemplateHibernationOptionsArgs: The hibernation options for the instance. See Hibernation Options below for more details.
IamInstanceProfile LaunchTemplateIamInstanceProfileArgs: The IAM Instance Profile to launch the instance with. See Instance Profile below for more details.
ImageId string: The AMI from which to launch the instance.
InstanceInitiatedShutdownBehavior string: Shutdown behavior for the instance. Can be stop or terminate. (Default: stop).
InstanceMarketOptions LaunchTemplateInstanceMarketOptionsArgs: The market (purchasing) option for the instance. See Market Options below for details.
InstanceType string: The type of the instance.
KernelId string: The kernel ID.
KeyName string: The key name to use for the instance.
LatestVersion int: The latest version of the launch template.
LicenseSpecifications List<LaunchTemplateLicenseSpecificationArgs>: A list of license specifications to associate with. See License Specification below for more details.
MetadataOptions LaunchTemplateMetadataOptionsArgs: Customize the metadata options for the instance. See Metadata Options below for more details.
Monitoring LaunchTemplateMonitoringArgs: The monitoring option for the instance. See Monitoring below for more details.
Name string: The name of the launch template. If you leave this blank, this provider will auto-generate a unique name.
NamePrefix string: Creates a unique name beginning with the specified prefix. Conflicts with name.
NetworkInterfaces List<LaunchTemplateNetworkInterfaceArgs>: Customize network interfaces to be attached at instance boot time. See Network Interfaces below for more details.
Placement LaunchTemplatePlacementArgs: The placement of the instance. See Placement below for more details.
RamDiskId string: The ID of the RAM disk.
SecurityGroupNames List<string>: A list of security group names to associate with. If you are creating Instances in a VPC, use vpc_security_group_ids instead.
TagSpecifications List<LaunchTemplateTagSpecificationArgs>: The tags to apply to the resources during launch. See Tag Specifications below for more details.
Tags Dictionary<string, string>: A map of tags to assign to the launch template.
UserData string: The Base64-encoded user data to provide when launching the instance.
VpcSecurityGroupIds List<string>: A list of security group IDs to associate with.

Arn string: The Amazon Resource Name (ARN) of the instance profile.
BlockDeviceMappings []LaunchTemplateBlockDeviceMapping: Specify volumes to attach to the instance besides the volumes specified by the AMI. See Block Devices below for details.
CapacityReservationSpecification LaunchTemplateCapacityReservationSpecification: Targeting for EC2 capacity reservations. See Capacity Reservation Specification below for more details.
CpuOptions LaunchTemplateCpuOptions: The CPU options for the instance. See CPU Options below for more details.
CreditSpecification LaunchTemplateCreditSpecification: Customize the credit specification of the instance. See Credit Specification below for more details.
DefaultVersion int: The default version of the launch template.
Description string: Description of the launch template.
DisableApiTermination bool: If true, enables EC2 Instance Termination Protection
EbsOptimized string: If true, the launched EC2 instance will be EBS-optimized.
ElasticGpuSpecifications []LaunchTemplateElasticGpuSpecification: The elastic GPU to attach to the instance. See Elastic GPU below for more details.
ElasticInferenceAccelerator LaunchTemplateElasticInferenceAccelerator: Configuration block containing an Elastic Inference Accelerator to attach to the instance. See Elastic Inference Accelerator below for more details.
HibernationOptions LaunchTemplateHibernationOptions: The hibernation options for the instance. See Hibernation Options below for more details.
IamInstanceProfile LaunchTemplateIamInstanceProfile: The IAM Instance Profile to launch the instance with. See Instance Profile below for more details.
ImageId string: The AMI from which to launch the instance.
InstanceInitiatedShutdownBehavior string: Shutdown behavior for the instance. Can be stop or terminate. (Default: stop).
InstanceMarketOptions LaunchTemplateInstanceMarketOptions: The market (purchasing) option for the instance. See Market Options below for details.
InstanceType string: The type of the instance.
KernelId string: The kernel ID.
KeyName string: The key name to use for the instance.
LatestVersion int: The latest version of the launch template.
LicenseSpecifications []LaunchTemplateLicenseSpecification: A list of license specifications to associate with. See License Specification below for more details.
MetadataOptions LaunchTemplateMetadataOptions: Customize the metadata options for the instance. See Metadata Options below for more details.
Monitoring LaunchTemplateMonitoring: The monitoring option for the instance. See Monitoring below for more details.
Name string: The name of the launch template. If you leave this blank, this provider will auto-generate a unique name.
NamePrefix string: Creates a unique name beginning with the specified prefix. Conflicts with name.
NetworkInterfaces []LaunchTemplateNetworkInterface: Customize network interfaces to be attached at instance boot time. See Network Interfaces below for more details.
Placement LaunchTemplatePlacement: The placement of the instance. See Placement below for more details.
RamDiskId string: The ID of the RAM disk.
SecurityGroupNames []string: A list of security group names to associate with. If you are creating Instances in a VPC, use vpc_security_group_ids instead.
TagSpecifications []LaunchTemplateTagSpecification: The tags to apply to the resources during launch. See Tag Specifications below for more details.
Tags map[string]string: A map of tags to assign to the launch template.
UserData string: The Base64-encoded user data to provide when launching the instance.
VpcSecurityGroupIds []string: A list of security group IDs to associate with.

arn string: The Amazon Resource Name (ARN) of the instance profile.
blockDeviceMappings LaunchTemplateBlockDeviceMapping[]: Specify volumes to attach to the instance besides the volumes specified by the AMI. See Block Devices below for details.
capacityReservationSpecification LaunchTemplateCapacityReservationSpecification: Targeting for EC2 capacity reservations. See Capacity Reservation Specification below for more details.
cpuOptions LaunchTemplateCpuOptions: The CPU options for the instance. See CPU Options below for more details.
creditSpecification LaunchTemplateCreditSpecification: Customize the credit specification of the instance. See Credit Specification below for more details.
defaultVersion number: The default version of the launch template.
description string: Description of the launch template.
disableApiTermination boolean: If true, enables EC2 Instance Termination Protection
ebsOptimized string: If true, the launched EC2 instance will be EBS-optimized.
elasticGpuSpecifications LaunchTemplateElasticGpuSpecification[]: The elastic GPU to attach to the instance. See Elastic GPU below for more details.
elasticInferenceAccelerator LaunchTemplateElasticInferenceAccelerator: Configuration block containing an Elastic Inference Accelerator to attach to the instance. See Elastic Inference Accelerator below for more details.
hibernationOptions LaunchTemplateHibernationOptions: The hibernation options for the instance. See Hibernation Options below for more details.
iamInstanceProfile LaunchTemplateIamInstanceProfile: The IAM Instance Profile to launch the instance with. See Instance Profile below for more details.
imageId string: The AMI from which to launch the instance.
instanceInitiatedShutdownBehavior string: Shutdown behavior for the instance. Can be stop or terminate. (Default: stop).
instanceMarketOptions LaunchTemplateInstanceMarketOptions: The market (purchasing) option for the instance. See Market Options below for details.
instanceType string: The type of the instance.
kernelId string: The kernel ID.
keyName string: The key name to use for the instance.
latestVersion number: The latest version of the launch template.
licenseSpecifications LaunchTemplateLicenseSpecification[]: A list of license specifications to associate with. See License Specification below for more details.
metadataOptions LaunchTemplateMetadataOptions: Customize the metadata options for the instance. See Metadata Options below for more details.
monitoring LaunchTemplateMonitoring: The monitoring option for the instance. See Monitoring below for more details.
name string: The name of the launch template. If you leave this blank, this provider will auto-generate a unique name.
namePrefix string: Creates a unique name beginning with the specified prefix. Conflicts with name.
networkInterfaces LaunchTemplateNetworkInterface[]: Customize network interfaces to be attached at instance boot time. See Network Interfaces below for more details.
placement LaunchTemplatePlacement: The placement of the instance. See Placement below for more details.
ramDiskId string: The ID of the RAM disk.
securityGroupNames string[]: A list of security group names to associate with. If you are creating Instances in a VPC, use vpc_security_group_ids instead.
tagSpecifications LaunchTemplateTagSpecification[]: The tags to apply to the resources during launch. See Tag Specifications below for more details.
tags {[key: string]: string}: A map of tags to assign to the launch template.
userData string: The Base64-encoded user data to provide when launching the instance.
vpcSecurityGroupIds string[]: A list of security group IDs to associate with.

arn str: The Amazon Resource Name (ARN) of the instance profile.
block_device_mappings List[LaunchTemplateBlockDeviceMapping]: Specify volumes to attach to the instance besides the volumes specified by the AMI. See Block Devices below for details.
capacity_reservation_specification Dict[LaunchTemplateCapacityReservationSpecification]: Targeting for EC2 capacity reservations. See Capacity Reservation Specification below for more details.
cpu_options Dict[LaunchTemplateCpuOptions]: The CPU options for the instance. See CPU Options below for more details.
credit_specification Dict[LaunchTemplateCreditSpecification]: Customize the credit specification of the instance. See Credit Specification below for more details.
default_version float: The default version of the launch template.
description str: Description of the launch template.
disable_api_termination bool: If true, enables EC2 Instance Termination Protection
ebs_optimized str: If true, the launched EC2 instance will be EBS-optimized.
elastic_gpu_specifications List[LaunchTemplateElasticGpuSpecification]: The elastic GPU to attach to the instance. See Elastic GPU below for more details.
elastic_inference_accelerator Dict[LaunchTemplateElasticInferenceAccelerator]: Configuration block containing an Elastic Inference Accelerator to attach to the instance. See Elastic Inference Accelerator below for more details.
hibernation_options Dict[LaunchTemplateHibernationOptions]: The hibernation options for the instance. See Hibernation Options below for more details.
iam_instance_profile Dict[LaunchTemplateIamInstanceProfile]: The IAM Instance Profile to launch the instance with. See Instance Profile below for more details.
image_id str: The AMI from which to launch the instance.
instance_initiated_shutdown_behavior str: Shutdown behavior for the instance. Can be stop or terminate. (Default: stop).
instance_market_options Dict[LaunchTemplateInstanceMarketOptions]: The market (purchasing) option for the instance. See Market Options below for details.
instance_type str: The type of the instance.
kernel_id str: The kernel ID.
key_name str: The key name to use for the instance.
latest_version float: The latest version of the launch template.
license_specifications List[LaunchTemplateLicenseSpecification]: A list of license specifications to associate with. See License Specification below for more details.
metadata_options Dict[LaunchTemplateMetadataOptions]: Customize the metadata options for the instance. See Metadata Options below for more details.
monitoring Dict[LaunchTemplateMonitoring]: The monitoring option for the instance. See Monitoring below for more details.
name str: The name of the launch template. If you leave this blank, this provider will auto-generate a unique name.
name_prefix str: Creates a unique name beginning with the specified prefix. Conflicts with name.
network_interfaces List[LaunchTemplateNetworkInterface]: Customize network interfaces to be attached at instance boot time. See Network Interfaces below for more details.
placement Dict[LaunchTemplatePlacement]: The placement of the instance. See Placement below for more details.
ram_disk_id str: The ID of the RAM disk.
security_group_names List[str]: A list of security group names to associate with. If you are creating Instances in a VPC, use vpc_security_group_ids instead.
tag_specifications List[LaunchTemplateTagSpecification]: The tags to apply to the resources during launch. See Tag Specifications below for more details.
tags Dict[str, str]: A map of tags to assign to the launch template.
user_data str: The Base64-encoded user data to provide when launching the instance.
vpc_security_group_ids List[str]: A list of security group IDs to associate with.

Supporting Types

LaunchTemplateBlockDeviceMapping

DeviceName string: The name of the device to mount.
Ebs LaunchTemplateBlockDeviceMappingEbsArgs: Configure EBS volume properties.
NoDevice string: Suppresses the specified device included in the AMI’s block device mapping.
VirtualName string: The Instance Store Device Name (e.g. "ephemeral0").

DeviceName string: The name of the device to mount.
Ebs LaunchTemplateBlockDeviceMappingEbs: Configure EBS volume properties.
NoDevice string: Suppresses the specified device included in the AMI’s block device mapping.
VirtualName string: The Instance Store Device Name (e.g. "ephemeral0").

deviceName string: The name of the device to mount.
ebs LaunchTemplateBlockDeviceMappingEbs: Configure EBS volume properties.
noDevice string: Suppresses the specified device included in the AMI’s block device mapping.
virtualName string: The Instance Store Device Name (e.g. "ephemeral0").

device_name str: The name of the device to mount.
ebs Dict[LaunchTemplateBlockDeviceMappingEbs]: Configure EBS volume properties.
noDevice str: Suppresses the specified device included in the AMI’s block device mapping.
virtualName str: The Instance Store Device Name (e.g. "ephemeral0").

LaunchTemplateBlockDeviceMappingEbs

DeleteOnTermination string: Whether the volume should be destroyed on instance termination. Defaults to false if not set. See Preserving Amazon EBS Volumes on Instance Termination for more information.
Encrypted string: Enables EBS encryption on the volume (Default: false). Cannot be used with snapshot_id.
Iops int: The amount of provisioned IOPS. This must be set with a volume_type of "io1".
KmsKeyId string: The ARN of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use when creating the encrypted volume. encrypted must be set to true when this is set.
SnapshotId string: The Snapshot ID to mount.
VolumeSize int: The size of the volume in gigabytes.
VolumeType string: The type of volume. Can be "standard", "gp2", or "io1". (Default: "standard").

DeleteOnTermination string: Whether the volume should be destroyed on instance termination. Defaults to false if not set. See Preserving Amazon EBS Volumes on Instance Termination for more information.
Encrypted string: Enables EBS encryption on the volume (Default: false). Cannot be used with snapshot_id.
Iops int: The amount of provisioned IOPS. This must be set with a volume_type of "io1".
KmsKeyId string: The ARN of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use when creating the encrypted volume. encrypted must be set to true when this is set.
SnapshotId string: The Snapshot ID to mount.
VolumeSize int: The size of the volume in gigabytes.
VolumeType string: The type of volume. Can be "standard", "gp2", or "io1". (Default: "standard").

deleteOnTermination string: Whether the volume should be destroyed on instance termination. Defaults to false if not set. See Preserving Amazon EBS Volumes on Instance Termination for more information.
encrypted string: Enables EBS encryption on the volume (Default: false). Cannot be used with snapshot_id.
iops number: The amount of provisioned IOPS. This must be set with a volume_type of "io1".
kmsKeyId string: The ARN of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use when creating the encrypted volume. encrypted must be set to true when this is set.
snapshotId string: The Snapshot ID to mount.
volumeSize number: The size of the volume in gigabytes.
volumeType string: The type of volume. Can be "standard", "gp2", or "io1". (Default: "standard").

deleteOnTermination str: Whether the volume should be destroyed on instance termination. Defaults to false if not set. See Preserving Amazon EBS Volumes on Instance Termination for more information.
encrypted str: Enables EBS encryption on the volume (Default: false). Cannot be used with snapshot_id.
iops float: The amount of provisioned IOPS. This must be set with a volume_type of "io1".
kms_key_id str: The ARN of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use when creating the encrypted volume. encrypted must be set to true when this is set.
snapshot_id str: The Snapshot ID to mount.
volumeType str: The type of volume. Can be "standard", "gp2", or "io1". (Default: "standard").
volume_size float: The size of the volume in gigabytes.

LaunchTemplateCapacityReservationSpecification

CapacityReservationPreference string: Indicates the instance’s Capacity Reservation preferences. Can be open or none. (Default none).
CapacityReservationTarget LaunchTemplateCapacityReservationSpecificationCapacityReservationTargetArgs: Used to target a specific Capacity Reservation:

CapacityReservationPreference string: Indicates the instance’s Capacity Reservation preferences. Can be open or none. (Default none).
CapacityReservationTarget LaunchTemplateCapacityReservationSpecificationCapacityReservationTarget: Used to target a specific Capacity Reservation:

capacityReservationPreference string: Indicates the instance’s Capacity Reservation preferences. Can be open or none. (Default none).
capacityReservationTarget LaunchTemplateCapacityReservationSpecificationCapacityReservationTarget: Used to target a specific Capacity Reservation:

capacityReservationPreference str: Indicates the instance’s Capacity Reservation preferences. Can be open or none. (Default none).
capacityReservationTarget Dict[LaunchTemplateCapacityReservationSpecificationCapacityReservationTarget]: Used to target a specific Capacity Reservation:

LaunchTemplateCapacityReservationSpecificationCapacityReservationTarget

CapacityReservationId string: The ID of the Capacity Reservation to target.

CapacityReservationId string: The ID of the Capacity Reservation to target.

capacityReservationId string: The ID of the Capacity Reservation to target.

capacityReservationId str: The ID of the Capacity Reservation to target.

LaunchTemplateCpuOptions

CoreCount int: The number of CPU cores for the instance.
ThreadsPerCore int: The number of threads per CPU core. To disable Intel Hyper-Threading Technology for the instance, specify a value of 1. Otherwise, specify the default value of 2.

CoreCount int: The number of CPU cores for the instance.
ThreadsPerCore int: The number of threads per CPU core. To disable Intel Hyper-Threading Technology for the instance, specify a value of 1. Otherwise, specify the default value of 2.

coreCount number: The number of CPU cores for the instance.
threadsPerCore number: The number of threads per CPU core. To disable Intel Hyper-Threading Technology for the instance, specify a value of 1. Otherwise, specify the default value of 2.

coreCount float: The number of CPU cores for the instance.
threadsPerCore float: The number of threads per CPU core. To disable Intel Hyper-Threading Technology for the instance, specify a value of 1. Otherwise, specify the default value of 2.

LaunchTemplateCreditSpecification

CpuCredits string: The credit option for CPU usage. Can be "standard" or "unlimited". T3 instances are launched as unlimited by default. T2 instances are launched as standard by default.

CpuCredits string: The credit option for CPU usage. Can be "standard" or "unlimited". T3 instances are launched as unlimited by default. T2 instances are launched as standard by default.

cpuCredits string: The credit option for CPU usage. Can be "standard" or "unlimited". T3 instances are launched as unlimited by default. T2 instances are launched as standard by default.

cpuCredits str: The credit option for CPU usage. Can be "standard" or "unlimited". T3 instances are launched as unlimited by default. T2 instances are launched as standard by default.

LaunchTemplateElasticGpuSpecification

Type string: The Elastic GPU Type

Type string: The Elastic GPU Type

type string: The Elastic GPU Type

type str: The Elastic GPU Type

LaunchTemplateElasticInferenceAccelerator

Type string: Accelerator type.

Type string: Accelerator type.

type string: Accelerator type.

type str: Accelerator type.

LaunchTemplateHibernationOptions

Configured bool: If set to true, the launched EC2 instance will hibernation enabled.

Configured bool: If set to true, the launched EC2 instance will hibernation enabled.

configured boolean: If set to true, the launched EC2 instance will hibernation enabled.

configured bool: If set to true, the launched EC2 instance will hibernation enabled.

LaunchTemplateIamInstanceProfile

Arn string: The Amazon Resource Name (ARN) of the instance profile.
Name string: The name of the instance profile.

Arn string: The Amazon Resource Name (ARN) of the instance profile.
Name string: The name of the instance profile.

arn string: The Amazon Resource Name (ARN) of the instance profile.
name string: The name of the instance profile.

arn str: The Amazon Resource Name (ARN) of the instance profile.
name str: The name of the instance profile.

LaunchTemplateInstanceMarketOptions

MarketType string: The market type. Can be spot.
SpotOptions LaunchTemplateInstanceMarketOptionsSpotOptionsArgs: The options for Spot Instance

MarketType string: The market type. Can be spot.
SpotOptions LaunchTemplateInstanceMarketOptionsSpotOptions: The options for Spot Instance

marketType string: The market type. Can be spot.
spotOptions LaunchTemplateInstanceMarketOptionsSpotOptions: The options for Spot Instance

marketType str: The market type. Can be spot.
spot_options Dict[LaunchTemplateInstanceMarketOptionsSpotOptions]: The options for Spot Instance

LaunchTemplateInstanceMarketOptionsSpotOptions

BlockDurationMinutes int: The required duration in minutes. This value must be a multiple of 60.
InstanceInterruptionBehavior string: The behavior when a Spot Instance is interrupted. Can be hibernate, stop, or terminate. (Default: terminate).
MaxPrice string: The maximum hourly price you’re willing to pay for the Spot Instances.
SpotInstanceType string: The Spot Instance request type. Can be one-time, or persistent.
ValidUntil string: The end date of the request.

BlockDurationMinutes int: The required duration in minutes. This value must be a multiple of 60.
InstanceInterruptionBehavior string: The behavior when a Spot Instance is interrupted. Can be hibernate, stop, or terminate. (Default: terminate).
MaxPrice string: The maximum hourly price you’re willing to pay for the Spot Instances.
SpotInstanceType string: The Spot Instance request type. Can be one-time, or persistent.
ValidUntil string: The end date of the request.

blockDurationMinutes number: The required duration in minutes. This value must be a multiple of 60.
instanceInterruptionBehavior string: The behavior when a Spot Instance is interrupted. Can be hibernate, stop, or terminate. (Default: terminate).
maxPrice string: The maximum hourly price you’re willing to pay for the Spot Instances.
spotInstanceType string: The Spot Instance request type. Can be one-time, or persistent.
validUntil string: The end date of the request.

block_duration_minutes float: The required duration in minutes. This value must be a multiple of 60.
instanceInterruptionBehavior str: The behavior when a Spot Instance is interrupted. Can be hibernate, stop, or terminate. (Default: terminate).
maxPrice str: The maximum hourly price you’re willing to pay for the Spot Instances.
spotInstanceType str: The Spot Instance request type. Can be one-time, or persistent.
valid_until str: The end date of the request.

LaunchTemplateLicenseSpecification

LicenseConfigurationArn string: ARN of the license configuration.

LicenseConfigurationArn string: ARN of the license configuration.

licenseConfigurationArn string: ARN of the license configuration.

license_configuration_arn str: ARN of the license configuration.

LaunchTemplateMetadataOptions

HttpEndpoint string: Whether the metadata service is available. Can be "enabled" or "disabled". (Default: "enabled").
HttpPutResponseHopLimit int: The desired HTTP PUT response hop limit for instance metadata requests. The larger the number, the further instance metadata requests can travel. Can be an integer from 1 to 64. (Default: 1).
HttpTokens string: Whether or not the metadata service requires session tokens, also referred to as Instance Metadata Service Version 2. Can be "optional" or "required". (Default: "optional").

HttpEndpoint string: Whether the metadata service is available. Can be "enabled" or "disabled". (Default: "enabled").
HttpPutResponseHopLimit int: The desired HTTP PUT response hop limit for instance metadata requests. The larger the number, the further instance metadata requests can travel. Can be an integer from 1 to 64. (Default: 1).
HttpTokens string: Whether or not the metadata service requires session tokens, also referred to as Instance Metadata Service Version 2. Can be "optional" or "required". (Default: "optional").

httpEndpoint string: Whether the metadata service is available. Can be "enabled" or "disabled". (Default: "enabled").
httpPutResponseHopLimit number: The desired HTTP PUT response hop limit for instance metadata requests. The larger the number, the further instance metadata requests can travel. Can be an integer from 1 to 64. (Default: 1).
httpTokens string: Whether or not the metadata service requires session tokens, also referred to as Instance Metadata Service Version 2. Can be "optional" or "required". (Default: "optional").

httpEndpoint str: Whether the metadata service is available. Can be "enabled" or "disabled". (Default: "enabled").
httpPutResponseHopLimit float: The desired HTTP PUT response hop limit for instance metadata requests. The larger the number, the further instance metadata requests can travel. Can be an integer from 1 to 64. (Default: 1).
httpTokens str: Whether or not the metadata service requires session tokens, also referred to as Instance Metadata Service Version 2. Can be "optional" or "required". (Default: "optional").

LaunchTemplateMonitoring

Enabled bool: If true, the launched EC2 instance will have detailed monitoring enabled.

Enabled bool: If true, the launched EC2 instance will have detailed monitoring enabled.

enabled boolean: If true, the launched EC2 instance will have detailed monitoring enabled.

enabled bool: If true, the launched EC2 instance will have detailed monitoring enabled.

LaunchTemplateNetworkInterface

AssociatePublicIpAddress string: Associate a public ip address with the network interface. Boolean value.
DeleteOnTermination bool: Whether the network interface should be destroyed on instance termination. Defaults to false if not set.
Description string: Description of the network interface.
DeviceIndex int: The integer index of the network interface attachment.
Ipv4AddressCount int: The number of secondary private IPv4 addresses to assign to a network interface. Conflicts with ipv4_addresses
Ipv4Addresses List<string>: One or more private IPv4 addresses to associate. Conflicts with ipv4_address_count
Ipv6AddressCount int: The number of IPv6 addresses to assign to a network interface. Conflicts with ipv6_addresses
Ipv6Addresses List<string>: One or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet. Conflicts with ipv6_address_count
NetworkInterfaceId string: The ID of the network interface to attach.
PrivateIpAddress string: The primary private IPv4 address.
SecurityGroups List<string>: A list of security group IDs to associate.
SubnetId string: The VPC Subnet ID to associate.

AssociatePublicIpAddress string: Associate a public ip address with the network interface. Boolean value.
DeleteOnTermination bool: Whether the network interface should be destroyed on instance termination. Defaults to false if not set.
Description string: Description of the network interface.
DeviceIndex int: The integer index of the network interface attachment.
Ipv4AddressCount int: The number of secondary private IPv4 addresses to assign to a network interface. Conflicts with ipv4_addresses
Ipv4Addresses []string: One or more private IPv4 addresses to associate. Conflicts with ipv4_address_count
Ipv6AddressCount int: The number of IPv6 addresses to assign to a network interface. Conflicts with ipv6_addresses
Ipv6Addresses []string: One or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet. Conflicts with ipv6_address_count
NetworkInterfaceId string: The ID of the network interface to attach.
PrivateIpAddress string: The primary private IPv4 address.
SecurityGroups []string: A list of security group IDs to associate.
SubnetId string: The VPC Subnet ID to associate.

associatePublicIpAddress string: Associate a public ip address with the network interface. Boolean value.
deleteOnTermination boolean: Whether the network interface should be destroyed on instance termination. Defaults to false if not set.
description string: Description of the network interface.
deviceIndex number: The integer index of the network interface attachment.
ipv4AddressCount number: The number of secondary private IPv4 addresses to assign to a network interface. Conflicts with ipv4_addresses
ipv4Addresses string[]: One or more private IPv4 addresses to associate. Conflicts with ipv4_address_count
ipv6AddressCount number: The number of IPv6 addresses to assign to a network interface. Conflicts with ipv6_addresses
ipv6Addresses string[]: One or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet. Conflicts with ipv6_address_count
networkInterfaceId string: The ID of the network interface to attach.
privateIpAddress string: The primary private IPv4 address.
securityGroups string[]: A list of security group IDs to associate.
subnetId string: The VPC Subnet ID to associate.

associate_public_ip_address str: Associate a public ip address with the network interface. Boolean value.
deleteOnTermination bool: Whether the network interface should be destroyed on instance termination. Defaults to false if not set.
description str: Description of the network interface.
device_index float: The integer index of the network interface attachment.
ipv4AddressCount float: The number of secondary private IPv4 addresses to assign to a network interface. Conflicts with ipv4_addresses
ipv4Addresses List[str]: One or more private IPv4 addresses to associate. Conflicts with ipv4_address_count
ipv6_address_count float: The number of IPv6 addresses to assign to a network interface. Conflicts with ipv6_addresses
ipv6_addresses List[str]: One or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet. Conflicts with ipv6_address_count
network_interface_id str: The ID of the network interface to attach.
private_ip_address str: The primary private IPv4 address.
security_groups List[str]: A list of security group IDs to associate.
subnet_id str: The VPC Subnet ID to associate.

LaunchTemplatePlacement

Affinity string: The affinity setting for an instance on a Dedicated Host.
AvailabilityZone string: The Availability Zone for the instance.
GroupName string: The name of the placement group for the instance.
HostId string: The ID of the Dedicated Host for the instance.
PartitionNumber int: The number of the partition the instance should launch in. Valid only if the placement group strategy is set to partition.
SpreadDomain string: Reserved for future use.
Tenancy string: The tenancy of the instance (if the instance is running in a VPC). Can be default, dedicated, or host.

Affinity string: The affinity setting for an instance on a Dedicated Host.
AvailabilityZone string: The Availability Zone for the instance.
GroupName string: The name of the placement group for the instance.
HostId string: The ID of the Dedicated Host for the instance.
PartitionNumber int: The number of the partition the instance should launch in. Valid only if the placement group strategy is set to partition.
SpreadDomain string: Reserved for future use.
Tenancy string: The tenancy of the instance (if the instance is running in a VPC). Can be default, dedicated, or host.

affinity string: The affinity setting for an instance on a Dedicated Host.
availabilityZone string: The Availability Zone for the instance.
groupName string: The name of the placement group for the instance.
hostId string: The ID of the Dedicated Host for the instance.
partitionNumber number: The number of the partition the instance should launch in. Valid only if the placement group strategy is set to partition.
spreadDomain string: Reserved for future use.
tenancy string: The tenancy of the instance (if the instance is running in a VPC). Can be default, dedicated, or host.

affinity str: The affinity setting for an instance on a Dedicated Host.
availability_zone str: The Availability Zone for the instance.
group_name str: The name of the placement group for the instance.
host_id str: The ID of the Dedicated Host for the instance.
partitionNumber float: The number of the partition the instance should launch in. Valid only if the placement group strategy is set to partition.
spreadDomain str: Reserved for future use.
tenancy str: The tenancy of the instance (if the instance is running in a VPC). Can be default, dedicated, or host.

LaunchTemplateTagSpecification

ResourceType string: The type of resource to tag. Valid values are instance and volume.
Tags Dictionary<string, string>: A map of tags to assign to the resource.

ResourceType string: The type of resource to tag. Valid values are instance and volume.
Tags map[string]string: A map of tags to assign to the resource.

resourceType string: The type of resource to tag. Valid values are instance and volume.
tags {[key: string]: string}: A map of tags to assign to the resource.

resource_type str: The type of resource to tag. Valid values are instance and volume.
tags Dict[str, str]: A map of tags to assign to the resource.

Package Details

Repository: https://github.com/pulumi/pulumi-aws
License: Apache-2.0
Notes: This Pulumi package is based on the aws Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud