pulumi-aws-kotlin/com.pulumi.aws.ec2.kotlin/LaunchConfigurationArgs

LaunchConfigurationArgs

data class LaunchConfigurationArgs(val associatePublicIpAddress: Output<Boolean>? = null, val ebsBlockDevices: Output<List<LaunchConfigurationEbsBlockDeviceArgs>>? = null, val ebsOptimized: Output<Boolean>? = null, val enableMonitoring: Output<Boolean>? = null, val ephemeralBlockDevices: Output<List<LaunchConfigurationEphemeralBlockDeviceArgs>>? = null, val iamInstanceProfile: Output<String>? = null, val imageId: Output<String>? = null, val instanceType: Output<String>? = null, val keyName: Output<String>? = null, val metadataOptions: Output<LaunchConfigurationMetadataOptionsArgs>? = null, val name: Output<String>? = null, val namePrefix: Output<String>? = null, val placementTenancy: Output<String>? = null, val rootBlockDevice: Output<LaunchConfigurationRootBlockDeviceArgs>? = null, val securityGroups: Output<List<String>>? = null, val spotPrice: Output<String>? = null, val userData: Output<String>? = null, val userDataBase64: Output<String>? = null, val vpcClassicLinkId: Output<String>? = null, val vpcClassicLinkSecurityGroups: Output<List<String>>? = null) : ConvertibleToJava<LaunchConfigurationArgs>

Provides a resource to create a new launch configuration, used for autoscaling groups. !>WARNING: The use of launch configurations is discouraged in favour of launch templates. Read more in the AWS EC2 Documentation.

Note When using aws.ec2.LaunchConfiguration with aws.autoscaling.Group, it is recommended to use the name_prefix (Optional) instead of the name (Optional) attribute.

Example Usage

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.GetAmiArgs;
import com.pulumi.aws.ec2.LaunchConfiguration;
import com.pulumi.aws.ec2.LaunchConfigurationArgs;
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 ubuntu = Ec2Functions.getAmi(GetAmiArgs.builder()
            .mostRecent(true)
            .filters(
                GetAmiFilterArgs.builder()
                    .name("name")
                    .values("ubuntu/images/hvm-ssd/ubuntu-trusty-14.04-amd64-server-*")
                    .build(),
                GetAmiFilterArgs.builder()
                    .name("virtualization-type")
                    .values("hvm")
                    .build())
            .owners("099720109477")
            .build());
        var asConf = new LaunchConfiguration("asConf", LaunchConfigurationArgs.builder()
            .imageId(ubuntu.applyValue(getAmiResult -> getAmiResult.id()))
            .instanceType("t2.micro")
            .build());
    }
}
Content copied to clipboard

Using with AutoScaling Groups

Launch Configurations cannot be updated after creation with the Amazon Web Service API. In order to update a Launch Configuration, this provider will destroy the existing resource and create a replacement. In order to effectively use a Launch Configuration resource with an AutoScaling Group resource, it's recommended to specify create_before_destroy in a lifecycle block. Either omit the Launch Configuration name attribute, or specify a partial name with name_prefix. Example:

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const ubuntu = aws.ec2.getAmi({
    mostRecent: true,
    filters: [
        {
            name: "name",
            values: ["ubuntu/images/hvm-ssd/ubuntu-trusty-14&#46;04-amd64-server-*"],
        },
        {
            name: "virtualization-type",
            values: ["hvm"],
        },
    ],
    owners: ["099720109477"],
});
const asConf = new aws.ec2.LaunchConfiguration("asConf", {
    namePrefix: "lc-example-",
    imageId: ubuntu.then(ubuntu => ubuntu.id),
    instanceType: "t2.micro",
});
const bar = new aws.autoscaling.Group("bar", {
    launchConfiguration: asConf.name,
    minSize: 1,
    maxSize: 2,
});
Content copied to clipboard
import pulumi
import pulumi_aws as aws
ubuntu = aws.ec2.get_ami(most_recent=True,
    filters=[
        aws.ec2.GetAmiFilterArgs(
            name="name",
            values=["ubuntu/images/hvm-ssd/ubuntu-trusty-14&#46;04-amd64-server-*"],
        ),
        aws.ec2.GetAmiFilterArgs(
            name="virtualization-type",
            values=["hvm"],
        ),
    ],
    owners=["099720109477"])
as_conf = aws.ec2.LaunchConfiguration("asConf",
    name_prefix="lc-example-",
    image_id=ubuntu.id,
    instance_type="t2.micro")
bar = aws.autoscaling.Group("bar",
    launch_configuration=as_conf.name,
    min_size=1,
    max_size=2)
Content copied to clipboard
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
    var ubuntu = Aws.Ec2.GetAmi.Invoke(new()
    {
        MostRecent = true,
        Filters = new[]
        {
            new Aws.Ec2.Inputs.GetAmiFilterInputArgs
            {
                Name = "name",
                Values = new[]
                {
                    "ubuntu/images/hvm-ssd/ubuntu-trusty-14.04-amd64-server-*",
                },
            },
            new Aws.Ec2.Inputs.GetAmiFilterInputArgs
            {
                Name = "virtualization-type",
                Values = new[]
                {
                    "hvm",
                },
            },
        },
        Owners = new[]
        {
            "099720109477",
        },
    });
    var asConf = new Aws.Ec2.LaunchConfiguration("asConf", new()
    {
        NamePrefix = "lc-example-",
        ImageId = ubuntu.Apply(getAmiResult => getAmiResult.Id),
        InstanceType = "t2.micro",
    });
    var bar = new Aws.AutoScaling.Group("bar", new()
    {
        LaunchConfiguration = asConf.Name,
        MinSize = 1,
        MaxSize = 2,
    });
});
Content copied to clipboard
package main
import (
	"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/autoscaling"
	"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/ec2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		ubuntu, err := ec2.LookupAmi(ctx, &ec2.LookupAmiArgs{
			MostRecent: pulumi.BoolRef(true),
			Filters: []ec2.GetAmiFilter{
				{
					Name: "name",
					Values: []string{
						"ubuntu/images/hvm-ssd/ubuntu-trusty-14.04-amd64-server-*",
					},
				},
				{
					Name: "virtualization-type",
					Values: []string{
						"hvm",
					},
				},
			},
			Owners: []string{
				"099720109477",
			},
		}, nil)
		if err != nil {
			return err
		}
		asConf, err := ec2.NewLaunchConfiguration(ctx, "asConf", &ec2.LaunchConfigurationArgs{
			NamePrefix:   pulumi.String("lc-example-"),
			ImageId:      *pulumi.String(ubuntu.Id),
			InstanceType: pulumi.String("t2.micro"),
		})
		if err != nil {
			return err
		}
		_, err = autoscaling.NewGroup(ctx, "bar", &autoscaling.GroupArgs{
			LaunchConfiguration: asConf.Name,
			MinSize:             pulumi.Int(1),
			MaxSize:             pulumi.Int(2),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Content copied to clipboard
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.GetAmiArgs;
import com.pulumi.aws.ec2.LaunchConfiguration;
import com.pulumi.aws.ec2.LaunchConfigurationArgs;
import com.pulumi.aws.autoscaling.Group;
import com.pulumi.aws.autoscaling.GroupArgs;
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 ubuntu = Ec2Functions.getAmi(GetAmiArgs.builder()
            .mostRecent(true)
            .filters(
                GetAmiFilterArgs.builder()
                    .name("name")
                    .values("ubuntu/images/hvm-ssd/ubuntu-trusty-14.04-amd64-server-*")
                    .build(),
                GetAmiFilterArgs.builder()
                    .name("virtualization-type")
                    .values("hvm")
                    .build())
            .owners("099720109477")
            .build());
        var asConf = new LaunchConfiguration("asConf", LaunchConfigurationArgs.builder()
            .namePrefix("lc-example-")
            .imageId(ubuntu.applyValue(getAmiResult -> getAmiResult.id()))
            .instanceType("t2.micro")
            .build());
        var bar = new Group("bar", GroupArgs.builder()
            .launchConfiguration(asConf.name())
            .minSize(1)
            .maxSize(2)
            .build());
    }
}
Content copied to clipboard
resources:
  asConf:
    type: aws:ec2:LaunchConfiguration
    properties:
      namePrefix: lc-example-
      imageId: ${ubuntu.id}
      instanceType: t2.micro
  bar:
    type: aws:autoscaling:Group
    properties:
      launchConfiguration: ${asConf.name}
      minSize: 1
      maxSize: 2
variables:
  ubuntu:
    fn::invoke:
      Function: aws:ec2:getAmi
      Arguments:
        mostRecent: true
        filters:
          - name: name
            values:
              - ubuntu/images/hvm-ssd/ubuntu-trusty-14.04-amd64-server-*
          - name: virtualization-type
            values:
              - hvm
        owners:
          - '099720109477'
Content copied to clipboard

With this setup this provider generates a unique name for your Launch Configuration and can then update the AutoScaling Group without conflict before destroying the previous Launch Configuration.

Using with Spot Instances

Launch configurations can set the spot instance pricing to be used for the Auto Scaling Group to reserve instances. Simply specifying the spot_price parameter will set the price on the Launch Configuration which will attempt to reserve your instances at this price. See the [AWS Spot Instance

  • documentation](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-spot-instances.html) for more information or how to launch 3 with this provider.

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const ubuntu = aws.ec2.getAmi({
    mostRecent: true,
    filters: [
        {
            name: "name",
            values: ["ubuntu/images/hvm-ssd/ubuntu-trusty-14&#46;04-amd64-server-*"],
        },
        {
            name: "virtualization-type",
            values: ["hvm"],
        },
    ],
    owners: ["099720109477"],
});
const asConf = new aws.ec2.LaunchConfiguration("asConf", {
    imageId: ubuntu.then(ubuntu => ubuntu.id),
    instanceType: "m4.large",
    spotPrice: "0.001",
});
const bar = new aws.autoscaling.Group("bar", {launchConfiguration: asConf.name});
Content copied to clipboard
import pulumi
import pulumi_aws as aws
ubuntu = aws.ec2.get_ami(most_recent=True,
    filters=[
        aws.ec2.GetAmiFilterArgs(
            name="name",
            values=["ubuntu/images/hvm-ssd/ubuntu-trusty-14&#46;04-amd64-server-*"],
        ),
        aws.ec2.GetAmiFilterArgs(
            name="virtualization-type",
            values=["hvm"],
        ),
    ],
    owners=["099720109477"])
as_conf = aws.ec2.LaunchConfiguration("asConf",
    image_id=ubuntu.id,
    instance_type="m4.large",
    spot_price="0.001")
bar = aws.autoscaling.Group("bar", launch_configuration=as_conf.name)
Content copied to clipboard
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
    var ubuntu = Aws.Ec2.GetAmi.Invoke(new()
    {
        MostRecent = true,
        Filters = new[]
        {
            new Aws.Ec2.Inputs.GetAmiFilterInputArgs
            {
                Name = "name",
                Values = new[]
                {
                    "ubuntu/images/hvm-ssd/ubuntu-trusty-14.04-amd64-server-*",
                },
            },
            new Aws.Ec2.Inputs.GetAmiFilterInputArgs
            {
                Name = "virtualization-type",
                Values = new[]
                {
                    "hvm",
                },
            },
        },
        Owners = new[]
        {
            "099720109477",
        },
    });
    var asConf = new Aws.Ec2.LaunchConfiguration("asConf", new()
    {
        ImageId = ubuntu.Apply(getAmiResult => getAmiResult.Id),
        InstanceType = "m4.large",
        SpotPrice = "0.001",
    });
    var bar = new Aws.AutoScaling.Group("bar", new()
    {
        LaunchConfiguration = asConf.Name,
    });
});
Content copied to clipboard
package main
import (
	"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/autoscaling"
	"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/ec2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		ubuntu, err := ec2.LookupAmi(ctx, &ec2.LookupAmiArgs{
			MostRecent: pulumi.BoolRef(true),
			Filters: []ec2.GetAmiFilter{
				{
					Name: "name",
					Values: []string{
						"ubuntu/images/hvm-ssd/ubuntu-trusty-14.04-amd64-server-*",
					},
				},
				{
					Name: "virtualization-type",
					Values: []string{
						"hvm",
					},
				},
			},
			Owners: []string{
				"099720109477",
			},
		}, nil)
		if err != nil {
			return err
		}
		asConf, err := ec2.NewLaunchConfiguration(ctx, "asConf", &ec2.LaunchConfigurationArgs{
			ImageId:      *pulumi.String(ubuntu.Id),
			InstanceType: pulumi.String("m4.large"),
			SpotPrice:    pulumi.String("0.001"),
		})
		if err != nil {
			return err
		}
		_, err = autoscaling.NewGroup(ctx, "bar", &autoscaling.GroupArgs{
			LaunchConfiguration: asConf.Name,
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Content copied to clipboard
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.GetAmiArgs;
import com.pulumi.aws.ec2.LaunchConfiguration;
import com.pulumi.aws.ec2.LaunchConfigurationArgs;
import com.pulumi.aws.autoscaling.Group;
import com.pulumi.aws.autoscaling.GroupArgs;
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 ubuntu = Ec2Functions.getAmi(GetAmiArgs.builder()
            .mostRecent(true)
            .filters(
                GetAmiFilterArgs.builder()
                    .name("name")
                    .values("ubuntu/images/hvm-ssd/ubuntu-trusty-14.04-amd64-server-*")
                    .build(),
                GetAmiFilterArgs.builder()
                    .name("virtualization-type")
                    .values("hvm")
                    .build())
            .owners("099720109477")
            .build());
        var asConf = new LaunchConfiguration("asConf", LaunchConfigurationArgs.builder()
            .imageId(ubuntu.applyValue(getAmiResult -> getAmiResult.id()))
            .instanceType("m4.large")
            .spotPrice("0.001")
            .build());
        var bar = new Group("bar", GroupArgs.builder()
            .launchConfiguration(asConf.name())
            .build());
    }
}
Content copied to clipboard
resources:
  asConf:
    type: aws:ec2:LaunchConfiguration
    properties:
      imageId: ${ubuntu.id}
      instanceType: m4.large
      spotPrice: '0.001'
  bar:
    type: aws:autoscaling:Group
    properties:
      launchConfiguration: ${asConf.name}
variables:
  ubuntu:
    fn::invoke:
      Function: aws:ec2:getAmi
      Arguments:
        mostRecent: true
        filters:
          - name: name
            values:
              - ubuntu/images/hvm-ssd/ubuntu-trusty-14.04-amd64-server-*
          - name: virtualization-type
            values:
              - hvm
        owners:
          - '099720109477'
Content copied to clipboard

Block devices

Each of the *_block_device attributes controls a portion of the AWS Launch Configuration's "Block Device Mapping". It's a good idea to familiarize yourself with [AWS's Block Device

  • Mapping docs](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-device-mapping-concepts.html) to understand the implications of using these attributes. Each AWS Instance type has a different set of Instance Store block devices available for attachment. AWS [publishes a

  • list](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/InstanceStorage.html#StorageOnInstanceTypes) of which ephemeral devices are available on each type. The devices are always identified by the virtual_name in the format ephemeral{0..N}.

NOTE: Changes to *_block_device configuration of existing resources cannot currently be detected by this provider. After updating to block device configuration, resource recreation can be manually triggered by using the up command with the --replace argument.

ebs_block_device

Modifying any of the ebs_block_device settings requires resource replacement.

  • device_name - (Required) The name of the device to mount.

  • snapshot_id - (Optional) The Snapshot ID to mount.

  • volume_type - (Optional) The type of volume. Can be standard, gp2, gp3, st1, sc1 or io1.

  • volume_size - (Optional) The size of the volume in gigabytes.

  • iops - (Optional) The amount of provisioned IOPS. This must be set with a volume_type of "io1".

  • throughput - (Optional) The throughput (MiBps) to provision for a gp3 volume.

  • delete_on_termination - (Optional) Whether the volume should be destroyed on instance termination (Default: true).

  • encrypted - (Optional) Whether the volume should be encrypted or not. Defaults to false.

  • no_device - (Optional) Whether the device in the block device mapping of the AMI is suppressed.

ephemeral_block_device

  • device_name - (Required) The name of the block device to mount on the instance.

  • no_device - (Optional) Whether the device in the block device mapping of the AMI is suppressed.

  • virtual_name - (Optional) The Instance Store Device Name.

root_block_device

Modifying any of the root_block_device settings requires resource replacement.

  • delete_on_termination - (Optional) Whether the volume should be destroyed on instance termination. Defaults to true.

  • encrypted - (Optional) Whether the volume should be encrypted or not. Defaults to false.

  • iops - (Optional) The amount of provisioned IOPS. This must be set with a volume_type of io1.

  • throughput - (Optional) The throughput (MiBps) to provision for a gp3 volume.

  • volume_size - (Optional) The size of the volume in gigabytes.

  • volume_type - (Optional) The type of volume. Can be standard, gp2, gp3, st1, sc1 or io1.

Import

Launch configurations can be imported using the name, e.g.,

$ pulumi import aws:ec2/launchConfiguration:LaunchConfiguration as_conf lg-123456
Content copied to clipboard

Constructors

Link copied to clipboard
constructor(associatePublicIpAddress: Output<Boolean>? = null, ebsBlockDevices: Output<List<LaunchConfigurationEbsBlockDeviceArgs>>? = null, ebsOptimized: Output<Boolean>? = null, enableMonitoring: Output<Boolean>? = null, ephemeralBlockDevices: Output<List<LaunchConfigurationEphemeralBlockDeviceArgs>>? = null, iamInstanceProfile: Output<String>? = null, imageId: Output<String>? = null, instanceType: Output<String>? = null, keyName: Output<String>? = null, metadataOptions: Output<LaunchConfigurationMetadataOptionsArgs>? = null, name: Output<String>? = null, namePrefix: Output<String>? = null, placementTenancy: Output<String>? = null, rootBlockDevice: Output<LaunchConfigurationRootBlockDeviceArgs>? = null, securityGroups: Output<List<String>>? = null, spotPrice: Output<String>? = null, userData: Output<String>? = null, userDataBase64: Output<String>? = null, vpcClassicLinkId: Output<String>? = null, vpcClassicLinkSecurityGroups: Output<List<String>>? = null)

Properties

Link copied to clipboard
val associatePublicIpAddress: Output<Boolean>? = null

Associate a public ip address with an instance in a VPC.

Link copied to clipboard
val ebsBlockDevices: Output<List<LaunchConfigurationEbsBlockDeviceArgs>>? = null

Additional EBS block devices to attach to the instance. See Block Devices below for details.

Link copied to clipboard
val ebsOptimized: Output<Boolean>? = null

If true, the launched EC2 instance will be EBS-optimized.

Link copied to clipboard
val enableMonitoring: Output<Boolean>? = null

Enables/disables detailed monitoring. This is enabled by default.

Link copied to clipboard
val ephemeralBlockDevices: Output<List<LaunchConfigurationEphemeralBlockDeviceArgs>>? = null

Customize Ephemeral (also known as "Instance Store") volumes on the instance. See Block Devices below for details.

Link copied to clipboard
val iamInstanceProfile: Output<String>? = null

The name attribute of the IAM instance profile to associate with launched instances.

Link copied to clipboard
val imageId: Output<String>? = null

The EC2 image ID to launch.

Link copied to clipboard
val instanceType: Output<String>? = null

The size of instance to launch. The following arguments are optional:

Link copied to clipboard
val keyName: Output<String>? = null

The key name that should be used for the instance.

Link copied to clipboard
val metadataOptions: Output<LaunchConfigurationMetadataOptionsArgs>? = null

The metadata options for the instance.

Link copied to clipboard
val name: Output<String>? = null

The name of the launch configuration. If you leave this blank, this provider will auto-generate a unique name. Conflicts with name_prefix.

Link copied to clipboard
val namePrefix: Output<String>? = null

Creates a unique name beginning with the specified prefix. Conflicts with name.

Link copied to clipboard
val placementTenancy: Output<String>? = null

The tenancy of the instance. Valid values are default or dedicated, see AWS's Create Launch Configuration for more details.

Link copied to clipboard
val rootBlockDevice: Output<LaunchConfigurationRootBlockDeviceArgs>? = null

Customize details about the root block device of the instance. See Block Devices below for details.

Link copied to clipboard
val securityGroups: Output<List<String>>? = null

A list of associated security group IDS.

Link copied to clipboard
val spotPrice: Output<String>? = null

The maximum price to use for reserving spot instances.

Link copied to clipboard
val userData: Output<String>? = null

The user data to provide when launching the instance. Do not pass gzip-compressed data via this argument; see user_data_base64 instead.

Link copied to clipboard
val userDataBase64: Output<String>? = null

Can be used instead of user_data to pass base64-encoded binary data directly. Use this instead of user_data whenever the value is not a valid UTF-8 string. For example, gzip-encoded user data must be base64-encoded and passed via this argument to avoid corruption.

Link copied to clipboard
val vpcClassicLinkId: Output<String>? = null

The ID of a ClassicLink-enabled VPC. Only applies to EC2-Classic instances. (eg. vpc-2730681a)

Link copied to clipboard
val vpcClassicLinkSecurityGroups: Output<List<String>>? = null

The IDs of one or more security groups for the specified ClassicLink-enabled VPC (eg. sg-46ae3d11).

Functions

Link copied to clipboard
open override fun toJava(): LaunchConfigurationArgs