AWS v6.77.0, Apr 9 25

AWS v6.77.0 published on Wednesday, Apr 9, 2025 by Pulumi

aws.ec2.getLaunchTemplate

Explore with Pulumi AI

AWS v6.77.0 published on Wednesday, Apr 9, 2025 by Pulumi

Example Usage

TypeScript
Python
Go
C#
Java
YAML

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const _default = aws.ec2.getLaunchTemplate({
    name: "my-launch-template",
});

import pulumi
import pulumi_aws as aws

default = aws.ec2.get_launch_template(name="my-launch-template")

package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/ec2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ec2.LookupLaunchTemplate(ctx, &ec2.LookupLaunchTemplateArgs{
			Name: pulumi.StringRef("my-launch-template"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var @default = Aws.Ec2.GetLaunchTemplate.Invoke(new()
    {
        Name = "my-launch-template",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.ec2.Ec2Functions;
import com.pulumi.aws.ec2.inputs.GetLaunchTemplateArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var default = Ec2Functions.getLaunchTemplate(GetLaunchTemplateArgs.builder()
            .name("my-launch-template")
            .build());

    }
}

variables:
  default:
    fn::invoke:
      function: aws:ec2:getLaunchTemplate
      arguments:
        name: my-launch-template

Filter

TypeScript
Python
Go
C#
Java
YAML

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const test = aws.ec2.getLaunchTemplate({
    filters: [{
        name: "launch-template-name",
        values: ["some-template"],
    }],
});

import pulumi
import pulumi_aws as aws

test = aws.ec2.get_launch_template(filters=[{
    "name": "launch-template-name",
    "values": ["some-template"],
}])

package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/ec2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ec2.LookupLaunchTemplate(ctx, &ec2.LookupLaunchTemplateArgs{
			Filters: []ec2.GetLaunchTemplateFilter{
				{
					Name: "launch-template-name",
					Values: []string{
						"some-template",
					},
				},
			},
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var test = Aws.Ec2.GetLaunchTemplate.Invoke(new()
    {
        Filters = new[]
        {
            new Aws.Ec2.Inputs.GetLaunchTemplateFilterInputArgs
            {
                Name = "launch-template-name",
                Values = new[]
                {
                    "some-template",
                },
            },
        },
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.ec2.Ec2Functions;
import com.pulumi.aws.ec2.inputs.GetLaunchTemplateArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var test = Ec2Functions.getLaunchTemplate(GetLaunchTemplateArgs.builder()
            .filters(GetLaunchTemplateFilterArgs.builder()
                .name("launch-template-name")
                .values("some-template")
                .build())
            .build());

    }
}

variables:
  test:
    fn::invoke:
      function: aws:ec2:getLaunchTemplate
      arguments:
        filters:
          - name: launch-template-name
            values:
              - some-template

Using getLaunchTemplate

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

TypeScript
Python
Go
C#
Java
YAML

function getLaunchTemplate(args: GetLaunchTemplateArgs, opts?: InvokeOptions): Promise<GetLaunchTemplateResult>
function getLaunchTemplateOutput(args: GetLaunchTemplateOutputArgs, opts?: InvokeOptions): Output<GetLaunchTemplateResult>

def get_launch_template(filters: Optional[Sequence[GetLaunchTemplateFilter]] = None,
                        id: Optional[str] = None,
                        name: Optional[str] = None,
                        tags: Optional[Mapping[str, str]] = None,
                        opts: Optional[InvokeOptions] = None) -> GetLaunchTemplateResult
def get_launch_template_output(filters: Optional[pulumi.Input[Sequence[pulumi.Input[GetLaunchTemplateFilterArgs]]]] = None,
                        id: Optional[pulumi.Input[str]] = None,
                        name: Optional[pulumi.Input[str]] = None,
                        tags: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetLaunchTemplateResult]

func LookupLaunchTemplate(ctx *Context, args *LookupLaunchTemplateArgs, opts ...InvokeOption) (*LookupLaunchTemplateResult, error)
func LookupLaunchTemplateOutput(ctx *Context, args *LookupLaunchTemplateOutputArgs, opts ...InvokeOption) LookupLaunchTemplateResultOutput

> Note: This function is named LookupLaunchTemplate in the Go SDK.

public static class GetLaunchTemplate 
{
    public static Task<GetLaunchTemplateResult> InvokeAsync(GetLaunchTemplateArgs args, InvokeOptions? opts = null)
    public static Output<GetLaunchTemplateResult> Invoke(GetLaunchTemplateInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetLaunchTemplateResult> getLaunchTemplate(GetLaunchTemplateArgs args, InvokeOptions options)
public static Output<GetLaunchTemplateResult> getLaunchTemplate(GetLaunchTemplateArgs args, InvokeOptions options)

fn::invoke:
  function: aws:ec2/getLaunchTemplate:getLaunchTemplate
  arguments:
    # arguments dictionary

The following arguments are supported:

Filters List<GetLaunchTemplateFilter>: Configuration block(s) for filtering. Detailed below.
Id string: ID of the specific launch template to retrieve.
Name string: Name of the launch template.
Tags Dictionary<string, string>: Map of tags, each pair of which must exactly match a pair on the desired Launch Template.

Filters []GetLaunchTemplateFilter: Configuration block(s) for filtering. Detailed below.
Id string: ID of the specific launch template to retrieve.
Name string: Name of the launch template.
Tags map[string]string: Map of tags, each pair of which must exactly match a pair on the desired Launch Template.

filters List<GetLaunchTemplateFilter>: Configuration block(s) for filtering. Detailed below.
id String: ID of the specific launch template to retrieve.
name String: Name of the launch template.
tags Map<String,String>: Map of tags, each pair of which must exactly match a pair on the desired Launch Template.

filters GetLaunchTemplateFilter[]: Configuration block(s) for filtering. Detailed below.
id string: ID of the specific launch template to retrieve.
name string: Name of the launch template.
tags {[key: string]: string}: Map of tags, each pair of which must exactly match a pair on the desired Launch Template.

filters Sequence[GetLaunchTemplateFilter]: Configuration block(s) for filtering. Detailed below.
id str: ID of the specific launch template to retrieve.
name str: Name of the launch template.
tags Mapping[str, str]: Map of tags, each pair of which must exactly match a pair on the desired Launch Template.

filters List<Property Map>: Configuration block(s) for filtering. Detailed below.
id String: ID of the specific launch template to retrieve.
name String: Name of the launch template.
tags Map<String>: Map of tags, each pair of which must exactly match a pair on the desired Launch Template.

getLaunchTemplate Result

The following output properties are available:

Arn string
BlockDeviceMappings List<GetLaunchTemplateBlockDeviceMapping>
CapacityReservationSpecifications List<GetLaunchTemplateCapacityReservationSpecification>
CpuOptions List<GetLaunchTemplateCpuOption>
CreditSpecifications List<GetLaunchTemplateCreditSpecification>
DefaultVersion int
Description string
DisableApiStop bool
DisableApiTermination bool
EbsOptimized string
ElasticGpuSpecifications List<GetLaunchTemplateElasticGpuSpecification>: Deprecated: elastic_gpu_specifications is deprecated. AWS no longer supports the Elastic Graphics service.
ElasticInferenceAccelerators List<GetLaunchTemplateElasticInferenceAccelerator>: Deprecated: elastic_inference_accelerator is deprecated. AWS no longer supports the Elastic Inference service.
EnclaveOptions List<GetLaunchTemplateEnclaveOption>
HibernationOptions List<GetLaunchTemplateHibernationOption>
IamInstanceProfiles List<GetLaunchTemplateIamInstanceProfile>
Id string: ID of the launch template.
ImageId string
InstanceInitiatedShutdownBehavior string
InstanceMarketOptions List<GetLaunchTemplateInstanceMarketOption>
InstanceRequirements List<GetLaunchTemplateInstanceRequirement>
InstanceType string
KernelId string
KeyName string
LatestVersion int
LicenseSpecifications List<GetLaunchTemplateLicenseSpecification>
MaintenanceOptions List<GetLaunchTemplateMaintenanceOption>
MetadataOptions List<GetLaunchTemplateMetadataOption>
Monitorings List<GetLaunchTemplateMonitoring>
Name string
NetworkInterfaces List<GetLaunchTemplateNetworkInterface>
Placements List<GetLaunchTemplatePlacement>
PrivateDnsNameOptions List<GetLaunchTemplatePrivateDnsNameOption>
RamDiskId string
SecurityGroupNames List<string>
TagSpecifications List<GetLaunchTemplateTagSpecification>
Tags Dictionary<string, string>
UserData string
VpcSecurityGroupIds List<string>
Filters List<GetLaunchTemplateFilter>

Arn string
BlockDeviceMappings []GetLaunchTemplateBlockDeviceMapping
CapacityReservationSpecifications []GetLaunchTemplateCapacityReservationSpecification
CpuOptions []GetLaunchTemplateCpuOption
CreditSpecifications []GetLaunchTemplateCreditSpecification
DefaultVersion int
Description string
DisableApiStop bool
DisableApiTermination bool
EbsOptimized string
ElasticGpuSpecifications []GetLaunchTemplateElasticGpuSpecification: Deprecated: elastic_gpu_specifications is deprecated. AWS no longer supports the Elastic Graphics service.
ElasticInferenceAccelerators []GetLaunchTemplateElasticInferenceAccelerator: Deprecated: elastic_inference_accelerator is deprecated. AWS no longer supports the Elastic Inference service.
EnclaveOptions []GetLaunchTemplateEnclaveOption
HibernationOptions []GetLaunchTemplateHibernationOption
IamInstanceProfiles []GetLaunchTemplateIamInstanceProfile
Id string: ID of the launch template.
ImageId string
InstanceInitiatedShutdownBehavior string
InstanceMarketOptions []GetLaunchTemplateInstanceMarketOption
InstanceRequirements []GetLaunchTemplateInstanceRequirement
InstanceType string
KernelId string
KeyName string
LatestVersion int
LicenseSpecifications []GetLaunchTemplateLicenseSpecification
MaintenanceOptions []GetLaunchTemplateMaintenanceOption
MetadataOptions []GetLaunchTemplateMetadataOption
Monitorings []GetLaunchTemplateMonitoring
Name string
NetworkInterfaces []GetLaunchTemplateNetworkInterface
Placements []GetLaunchTemplatePlacement
PrivateDnsNameOptions []GetLaunchTemplatePrivateDnsNameOption
RamDiskId string
SecurityGroupNames []string
TagSpecifications []GetLaunchTemplateTagSpecification
Tags map[string]string
UserData string
VpcSecurityGroupIds []string
Filters []GetLaunchTemplateFilter

arn String
blockDeviceMappings List<GetLaunchTemplateBlockDeviceMapping>
capacityReservationSpecifications List<GetLaunchTemplateCapacityReservationSpecification>
cpuOptions List<GetLaunchTemplateCpuOption>
creditSpecifications List<GetLaunchTemplateCreditSpecification>
defaultVersion Integer
description String
disableApiStop Boolean
disableApiTermination Boolean
ebsOptimized String
elasticGpuSpecifications List<GetLaunchTemplateElasticGpuSpecification>: Deprecated: elastic_gpu_specifications is deprecated. AWS no longer supports the Elastic Graphics service.
elasticInferenceAccelerators List<GetLaunchTemplateElasticInferenceAccelerator>: Deprecated: elastic_inference_accelerator is deprecated. AWS no longer supports the Elastic Inference service.
enclaveOptions List<GetLaunchTemplateEnclaveOption>
hibernationOptions List<GetLaunchTemplateHibernationOption>
iamInstanceProfiles List<GetLaunchTemplateIamInstanceProfile>
id String: ID of the launch template.
imageId String
instanceInitiatedShutdownBehavior String
instanceMarketOptions List<GetLaunchTemplateInstanceMarketOption>
instanceRequirements List<GetLaunchTemplateInstanceRequirement>
instanceType String
kernelId String
keyName String
latestVersion Integer
licenseSpecifications List<GetLaunchTemplateLicenseSpecification>
maintenanceOptions List<GetLaunchTemplateMaintenanceOption>
metadataOptions List<GetLaunchTemplateMetadataOption>
monitorings List<GetLaunchTemplateMonitoring>
name String
networkInterfaces List<GetLaunchTemplateNetworkInterface>
placements List<GetLaunchTemplatePlacement>
privateDnsNameOptions List<GetLaunchTemplatePrivateDnsNameOption>
ramDiskId String
securityGroupNames List<String>
tagSpecifications List<GetLaunchTemplateTagSpecification>
tags Map<String,String>
userData String
vpcSecurityGroupIds List<String>
filters List<GetLaunchTemplateFilter>

arn string
blockDeviceMappings GetLaunchTemplateBlockDeviceMapping[]
capacityReservationSpecifications GetLaunchTemplateCapacityReservationSpecification[]
cpuOptions GetLaunchTemplateCpuOption[]
creditSpecifications GetLaunchTemplateCreditSpecification[]
defaultVersion number
description string
disableApiStop boolean
disableApiTermination boolean
ebsOptimized string
elasticGpuSpecifications GetLaunchTemplateElasticGpuSpecification[]: Deprecated: elastic_gpu_specifications is deprecated. AWS no longer supports the Elastic Graphics service.
elasticInferenceAccelerators GetLaunchTemplateElasticInferenceAccelerator[]: Deprecated: elastic_inference_accelerator is deprecated. AWS no longer supports the Elastic Inference service.
enclaveOptions GetLaunchTemplateEnclaveOption[]
hibernationOptions GetLaunchTemplateHibernationOption[]
iamInstanceProfiles GetLaunchTemplateIamInstanceProfile[]
id string: ID of the launch template.
imageId string
instanceInitiatedShutdownBehavior string
instanceMarketOptions GetLaunchTemplateInstanceMarketOption[]
instanceRequirements GetLaunchTemplateInstanceRequirement[]
instanceType string
kernelId string
keyName string
latestVersion number
licenseSpecifications GetLaunchTemplateLicenseSpecification[]
maintenanceOptions GetLaunchTemplateMaintenanceOption[]
metadataOptions GetLaunchTemplateMetadataOption[]
monitorings GetLaunchTemplateMonitoring[]
name string
networkInterfaces GetLaunchTemplateNetworkInterface[]
placements GetLaunchTemplatePlacement[]
privateDnsNameOptions GetLaunchTemplatePrivateDnsNameOption[]
ramDiskId string
securityGroupNames string[]
tagSpecifications GetLaunchTemplateTagSpecification[]
tags {[key: string]: string}
userData string
vpcSecurityGroupIds string[]
filters GetLaunchTemplateFilter[]

arn str
block_device_mappings Sequence[GetLaunchTemplateBlockDeviceMapping]
capacity_reservation_specifications Sequence[GetLaunchTemplateCapacityReservationSpecification]
cpu_options Sequence[GetLaunchTemplateCpuOption]
credit_specifications Sequence[GetLaunchTemplateCreditSpecification]
default_version int
description str
disable_api_stop bool
disable_api_termination bool
ebs_optimized str
elastic_gpu_specifications Sequence[GetLaunchTemplateElasticGpuSpecification]: Deprecated: elastic_gpu_specifications is deprecated. AWS no longer supports the Elastic Graphics service.
elastic_inference_accelerators Sequence[GetLaunchTemplateElasticInferenceAccelerator]: Deprecated: elastic_inference_accelerator is deprecated. AWS no longer supports the Elastic Inference service.
enclave_options Sequence[GetLaunchTemplateEnclaveOption]
hibernation_options Sequence[GetLaunchTemplateHibernationOption]
iam_instance_profiles Sequence[GetLaunchTemplateIamInstanceProfile]
id str: ID of the launch template.
image_id str
instance_initiated_shutdown_behavior str
instance_market_options Sequence[GetLaunchTemplateInstanceMarketOption]
instance_requirements Sequence[GetLaunchTemplateInstanceRequirement]
instance_type str
kernel_id str
key_name str
latest_version int
license_specifications Sequence[GetLaunchTemplateLicenseSpecification]
maintenance_options Sequence[GetLaunchTemplateMaintenanceOption]
metadata_options Sequence[GetLaunchTemplateMetadataOption]
monitorings Sequence[GetLaunchTemplateMonitoring]
name str
network_interfaces Sequence[GetLaunchTemplateNetworkInterface]
placements Sequence[GetLaunchTemplatePlacement]
private_dns_name_options Sequence[GetLaunchTemplatePrivateDnsNameOption]
ram_disk_id str
security_group_names Sequence[str]
tag_specifications Sequence[GetLaunchTemplateTagSpecification]
tags Mapping[str, str]
user_data str
vpc_security_group_ids Sequence[str]
filters Sequence[GetLaunchTemplateFilter]

arn String
blockDeviceMappings List<Property Map>
capacityReservationSpecifications List<Property Map>
cpuOptions List<Property Map>
creditSpecifications List<Property Map>
defaultVersion Number
description String
disableApiStop Boolean
disableApiTermination Boolean
ebsOptimized String
elasticGpuSpecifications List<Property Map>: Deprecated: elastic_gpu_specifications is deprecated. AWS no longer supports the Elastic Graphics service.
elasticInferenceAccelerators List<Property Map>: Deprecated: elastic_inference_accelerator is deprecated. AWS no longer supports the Elastic Inference service.
enclaveOptions List<Property Map>
hibernationOptions List<Property Map>
iamInstanceProfiles List<Property Map>
id String: ID of the launch template.
imageId String
instanceInitiatedShutdownBehavior String
instanceMarketOptions List<Property Map>
instanceRequirements List<Property Map>
instanceType String
kernelId String
keyName String
latestVersion Number
licenseSpecifications List<Property Map>
maintenanceOptions List<Property Map>
metadataOptions List<Property Map>
monitorings List<Property Map>
name String
networkInterfaces List<Property Map>
placements List<Property Map>
privateDnsNameOptions List<Property Map>
ramDiskId String
securityGroupNames List<String>
tagSpecifications List<Property Map>
tags Map<String>
userData String
vpcSecurityGroupIds List<String>
filters List<Property Map>

Supporting Types

GetLaunchTemplateElasticGpuSpecification

Type string

Type string

type String

type string

type str

type String

GetLaunchTemplateElasticInferenceAccelerator

Type string

Type string

type String

type string

type str

type String

GetLaunchTemplateEnclaveOption

Enabled bool

Enabled bool

enabled Boolean

enabled boolean

enabled bool

enabled Boolean

GetLaunchTemplateFilter

Name string: Name of the filter field. Valid values can be found in the EC2 DescribeLaunchTemplates API Reference.
Values List<string>: Set of values that are accepted for the given filter field. Results will be selected if any given value matches.

Name string: Name of the filter field. Valid values can be found in the EC2 DescribeLaunchTemplates API Reference.
Values []string: Set of values that are accepted for the given filter field. Results will be selected if any given value matches.

name String: Name of the filter field. Valid values can be found in the EC2 DescribeLaunchTemplates API Reference.
values List<String>: Set of values that are accepted for the given filter field. Results will be selected if any given value matches.

name string: Name of the filter field. Valid values can be found in the EC2 DescribeLaunchTemplates API Reference.
values string[]: Set of values that are accepted for the given filter field. Results will be selected if any given value matches.

name str: Name of the filter field. Valid values can be found in the EC2 DescribeLaunchTemplates API Reference.
values Sequence[str]: Set of values that are accepted for the given filter field. Results will be selected if any given value matches.

name String: Name of the filter field. Valid values can be found in the EC2 DescribeLaunchTemplates API Reference.
values List<String>: Set of values that are accepted for the given filter field. Results will be selected if any given value matches.