community / community.aws / 5.1.0 / module / ec2_launch_template Manage EC2 launch templates | "added in version" 1.0.0 of community.aws" Authors: Ryan Scott Brown (@ryansb)community.aws.ec2_launch_template (5.1.0) — module
Install with ansible-galaxy collection install community.aws:==5.1.0
collections: - name: community.aws version: 5.1.0
Create, modify, and delete EC2 Launch Templates, which can be used to create individual instances or with Autoscaling Groups.
The M(amazon.aws.ec2_instance) and M(community.aws.autoscaling_group) modules can, instead of specifying all parameters on those tasks, be passed a Launch Template which contains settings like instance size, disk type, subnet, and more.
- name: Create an ec2 launch template community.aws.ec2_launch_template: name: "my_template" image_id: "ami-04b762b4289fba92b" key_name: my_ssh_key instance_type: t2.micro iam_instance_profile: myTestProfile disable_api_termination: true
- name: > Create a new version of an existing ec2 launch template with a different instance type, while leaving an older version as the default version community.aws.ec2_launch_template: name: "my_template" default_version: 1 instance_type: c5.4xlarge
- name: Delete an ec2 launch template community.aws.ec2_launch_template: name: "my_template" state: absent
tags: aliases: - resource_tags description: - A set of key-value pairs to be applied to resources when this Launch Template is used. - 'Tag key constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with I(aws:)' - 'Tag value constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.' type: dict state: choices: - present - absent default: present description: - Whether the launch template should exist or not. - Deleting specific versions of a launch template is not supported at this time. type: str region: aliases: - aws_region - ec2_region description: - The AWS region to use. - For global services such as IAM, Route53 and CloudFront, I(region) is ignored. - The C(AWS_REGION) or C(EC2_REGION) environment variables may also be used. - See the Amazon AWS documentation for more information U(http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region). - The C(ec2_region) alias has been deprecated and will be removed in a release after 2024-12-01 - Support for the C(EC2_REGION) environment variable has been deprecated and will be removed in a release after 2024-12-01. type: str profile: aliases: - aws_profile description: - A named AWS profile to use for authentication. - See the AWS documentation for more information about named profiles U(https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html). - The C(AWS_PROFILE) environment variable may also be used. - The I(profile) option is mutually exclusive with the I(aws_access_key), I(aws_secret_key) and I(security_token) options. type: str image_id: description: 'The AMI ID to use for new instances launched with this template. This value is region-dependent since AMIs are not global resources. ' type: str key_name: description: - The name of the key pair. You can create a key pair using M(amazon.aws.ec2_key). - If you do not specify a key pair, you can't connect to the instance unless you choose an AMI that is configured to allow users another way to log in. type: str kernel_id: description: 'The ID of the kernel. We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see U(http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UserProvidedkernels.html) ' type: str placement: description: The placement group settings for the instance. suboptions: affinity: description: The affinity setting for an instance on a Dedicated Host. type: str availability_zone: description: The Availability Zone for the instance. type: str group_name: description: The name of the placement group for the instance. type: str host_id: description: The ID of the Dedicated Host for the instance. type: str tenancy: description: 'The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant hardware. ' type: str type: dict user_data: description: 'The Base64-encoded user data to make available to the instance. For more information, see the Linux U(http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/user-data.html) and Windows U(http://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/ec2-instance-metadata.html#instancedata-add-user-data) documentation on user-data. ' type: str access_key: aliases: - aws_access_key_id - aws_access_key - ec2_access_key description: - AWS access key ID. - See the AWS documentation for more information about access tokens U(https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys). - The C(AWS_ACCESS_KEY_ID), C(AWS_ACCESS_KEY) or C(EC2_ACCESS_KEY) environment variables may also be used in decreasing order of preference. - The I(aws_access_key) and I(profile) options are mutually exclusive. - The I(aws_access_key_id) alias was added in release 5.1.0 for consistency with the AWS botocore SDK. - The I(ec2_access_key) alias has been deprecated and will be removed in a release after 2024-12-01. - Support for the C(EC2_ACCESS_KEY) environment variable has been deprecated and will be removed in a release after 2024-12-01. type: str aws_config: description: - A dictionary to modify the botocore configuration. - Parameters can be found in the AWS documentation U(https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config). type: dict monitoring: description: Settings for instance monitoring. suboptions: enabled: description: Whether to turn on detailed monitoring for new instances. This will incur extra charges. type: bool type: dict secret_key: aliases: - aws_secret_access_key - aws_secret_key - ec2_secret_key description: - AWS secret access key. - See the AWS documentation for more information about access tokens U(https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys). - The C(AWS_SECRET_ACCESS_KEY), C(AWS_SECRET_KEY), or C(EC2_SECRET_KEY) environment variables may also be used in decreasing order of preference. - The I(secret_key) and I(profile) options are mutually exclusive. - The I(aws_secret_access_key) alias was added in release 5.1.0 for consistency with the AWS botocore SDK. - The I(ec2_secret_key) alias has been deprecated and will be removed in a release after 2024-12-01. - Support for the C(EC2_SECRET_KEY) environment variable has been deprecated and will be removed in a release after 2024-12-01. type: str cpu_options: description: - Choose CPU settings for the EC2 instances that will be created with this template. - For more information, see U(http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-optimize-cpu.html) suboptions: core_count: description: The number of CPU cores for the instance. type: int threads_per_core: description: '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. ' type: int type: dict ram_disk_id: description: 'The ID of the RAM disk to launch the instance with. We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see U(http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UserProvidedkernels.html) ' type: str template_id: aliases: - id description: - The ID for the launch template, can be used for all cases except creating a new Launch Template. type: str endpoint_url: aliases: - ec2_url - aws_endpoint_url - s3_url description: - URL to connect to instead of the default AWS endpoints. While this can be used to connection to other AWS-compatible services the amazon.aws and community.aws collections are only tested against AWS. - The C(AWS_URL) or C(EC2_URL) environment variables may also be used, in decreasing order of preference. - The I(ec2_url) and I(s3_url) aliases have been deprecated and will be removed in a release after 2024-12-01. - Support for the C(EC2_URL) environment variable has been deprecated and will be removed in a release after 2024-12-01. type: str aws_ca_bundle: description: - The location of a CA Bundle to use when validating SSL certificates. - The C(AWS_CA_BUNDLE) environment variable may also be used. type: path ebs_optimized: description: 'Indicates whether the instance is optimized for Amazon EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal Amazon EBS I/O performance. This optimization isn''t available with all instance types. Additional usage charges apply when using an EBS-optimized instance. ' type: bool instance_type: description: 'The instance type, such as C(c5.2xlarge). For a full list of instance types, see U(http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html). ' type: str session_token: aliases: - aws_session_token - security_token - aws_security_token - access_token description: - AWS STS session token for use with temporary credentials. - See the AWS documentation for more information about access tokens U(https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys). - The C(AWS_SESSION_TOKEN), C(AWS_SECURITY_TOKEN) or C(EC2_SECURITY_TOKEN) environment variables may also be used in decreasing order of preference. - The I(security_token) and I(profile) options are mutually exclusive. - Aliases I(aws_session_token) and I(session_token) were added in release 3.2.0, with the parameter being renamed from I(security_token) to I(session_token) in release 6.0.0. - The I(security_token), I(aws_security_token), and I(access_token) aliases have been deprecated and will be removed in a release after 2024-12-01. - Support for the C(EC2_SECRET_KEY) and C(AWS_SECURITY_TOKEN) environment variables has been deprecated and will be removed in a release after 2024-12-01. type: str template_name: aliases: - name description: - The template name. This must be unique in the region-account combination you are using. - If no launch template exists with the specified name, a new launch template is created. - If a launch template with the specified name already exists and the configuration has not changed, nothing happens. - If a launch template with the specified name already exists and the configuration has changed, a new version of the launch template is created. type: str source_version: default: latest description: 'The version number of the launch template version on which to base the new version. The new version inherits the same launch parameters as the source version, except for parameters that you explicity specify. Snapshots applied to the block device mapping are ignored when creating a new version unless they are explicitly included. ' type: str version_added: 4.1.0 version_added_collection: community.aws validate_certs: default: true description: - When set to C(false), SSL certificates will not be validated for communication with the AWS APIs. - Setting I(validate_certs=false) is strongly discouraged, as an alternative, consider setting I(aws_ca_bundle) instead. type: bool default_version: default: latest description: - Which version should be the default when users spin up new instances based on this template? By default, the latest version will be made the default. type: str security_groups: description: 'A list of security group names (Default VPC or EC2-Classic) that the new instances will be added to. For any VPC other than Default, you must use I(security_group_ids). ' elements: str type: list metadata_options: description: - Configure EC2 Metadata options. - For more information see the IMDS documentation U(https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/configuring-instance-metadata-service.html). suboptions: http_endpoint: choices: - enabled - disabled default: enabled description: 'This parameter enables or disables the HTTP metadata endpoint on your instances. ' type: str http_protocol_ipv6: choices: - enabled - disabled default: disabled description: '- Wether the instance metadata endpoint is available via IPv6 (C(enabled)) or not (C(disabled)). - Requires botocore >= 1.21.29 ' type: str version_added: 3.1.0 version_added_collection: community.aws http_put_response_hop_limit: default: 1 description: 'The desired HTTP PUT response hop limit for instance metadata requests. The larger the number, the further instance metadata requests can travel. ' type: int http_tokens: choices: - optional - required default: optional description: 'The state of token usage for your instance metadata requests. ' type: str instance_metadata_tags: choices: - enabled - disabled default: disabled description: - Wether the instance tags are availble (C(enabled)) via metadata endpoint or not (C(disabled)). - Requires botocore >= 1.23.30 type: str version_added: 3.1.0 version_added_collection: community.aws type: dict version_added: 1.5.0 version_added_collection: community.aws network_interfaces: description: One or more network interfaces. elements: dict suboptions: associate_public_ip_address: description: Associates a public IPv4 address with eth0 for a new network interface. type: bool delete_on_termination: description: Indicates whether the network interface is deleted when the instance is terminated. type: bool description: description: A description for the network interface. type: str device_index: description: The device index for the network interface attachment. type: int groups: description: List of security group IDs to include on this instance. elements: str type: list ipv6_address_count: description: 'The number of IPv6 addresses to assign to a network interface. Amazon EC2 automatically selects the IPv6 addresses from the subnet range. You can''t use this option if specifying the I(ipv6_addresses) option. ' type: int ipv6_addresses: description: 'A list of one or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet. You can''t use this option if you''re specifying the I(ipv6_address_count) option. ' elements: str type: list network_interface_id: description: The eni ID of a network interface to attach. type: str private_ip_address: description: The primary private IPv4 address of the network interface. type: str subnet_id: description: The ID of the subnet for the network interface. type: str type: list security_group_ids: description: A list of security group IDs (VPC or EC2-Classic) that the new instances will be added to. elements: str type: list credit_specification: description: The credit option for CPU usage of the instance. Valid for T2 or T3 instances only. suboptions: cpu_credits: description: 'The credit option for CPU usage of a T2 or T3 instance. Valid values are C(standard) and C(unlimited). ' type: str type: dict iam_instance_profile: description: 'The name or ARN of an IAM instance profile. Requires permissions to describe existing instance roles to confirm ARN is properly formed. ' type: str block_device_mappings: description: - The block device mapping. Supplying both a snapshot ID and an encryption value as arguments for block-device mapping results in an error. This is because only blank volumes can be encrypted on start, and these are not created from a snapshot. If a snapshot is the basis for the volume, it contains data by definition and its encryption status cannot be changed using this action. elements: dict suboptions: device_name: description: The device name (for example, /dev/sdh or xvdh). type: str ebs: description: Parameters used to automatically set up EBS volumes when the instance is launched. suboptions: delete_on_termination: description: Indicates whether the EBS volume is deleted on instance termination. type: bool encrypted: description: 'Indicates whether the EBS volume is encrypted. Encrypted volumes can only be attached to instances that support Amazon EBS encryption. If you are creating a volume from a snapshot, you can''t specify an encryption value. ' type: bool iops: description: - The number of I/O operations per second (IOPS) that the volume supports. For io1, this represents the number of IOPS that are provisioned for the volume. For gp2, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. For more information about General Purpose SSD baseline performance, I/O credits, and bursting, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide. - 'Condition: This parameter is required for requests to create io1 volumes; it is not used in requests to create gp2, st1, sc1, or standard volumes. ' type: int kms_key_id: description: The ARN of the AWS Key Management Service (AWS KMS) CMK used for encryption. type: str snapshot_id: description: The ID of the snapshot to create the volume from. type: str volume_size: description: - The size of the volume, in GiB. - 'Default: If you''re creating the volume from a snapshot and don''t specify a volume size, the default is the snapshot size.' type: int volume_type: description: The volume type type: str type: dict no_device: description: Suppresses the specified device included in the block device mapping of the AMI. type: str virtual_name: description: 'The virtual device name (ephemeralN). Instance store volumes are numbered starting from 0. An instance type with 2 available instance store volumes can specify mappings for ephemeral0 and ephemeral1. The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume. ' type: str type: list disable_api_termination: description: 'This helps protect instances from accidental termination. If set to true, you can''t terminate the instance using the Amazon EC2 console, CLI, or API. To change this attribute to false after launch, use I(ModifyInstanceAttribute). ' type: bool instance_market_options: description: Options for alternative instance markets, currently only the spot market is supported. suboptions: market_type: description: The market type. This should always be 'spot'. type: str spot_options: description: Spot-market specific settings. suboptions: block_duration_minutes: description: 'The required duration for the Spot Instances (also known as Spot blocks), in minutes. This value must be a multiple of 60 (60, 120, 180, 240, 300, or 360). ' type: int instance_interruption_behavior: choices: - hibernate - stop - terminate description: The behavior when a Spot Instance is interrupted. The default is C(terminate). type: str max_price: description: The highest hourly price you're willing to pay for this Spot Instance. type: str spot_instance_type: choices: - one-time - persistent description: The request type to send. type: str type: dict type: dict elastic_gpu_specifications: description: Settings for Elastic GPU attachments. See U(https://aws.amazon.com/ec2/elastic-gpus/) for details. elements: dict suboptions: type: description: The type of Elastic GPU to attach type: str type: list debug_botocore_endpoint_logs: default: false description: - Use a C(botocore.endpoint) logger to parse the unique (rather than total) C("resource:action") API calls made during a task, outputing the set to the resource_actions key in the task results. Use the C(aws_resource_action) callback to output to total list made during a playbook. - The C(ANSIBLE_DEBUG_BOTOCORE_LOGS) environment variable may also be used. type: bool instance_initiated_shutdown_behavior: choices: - stop - terminate description: 'Indicates whether an instance stops or terminates when you initiate shutdown from the instance using the operating system shutdown command. ' type: str
default_version: description: The version that will be used if only the template name is specified. Often this is the same as the latest version, but not always. returned: when state=present type: int latest_version: description: Latest available version of the launch template returned: when state=present type: int