device_name
string
-The device name (for example, /dev/sdh or xvdh).
+The device name (for example, /dev/sdh or xvdh).
The throughput to provision for a gp3 volume, with a maximum of 1,000 MiB/s. Valid Range - Minimum value of 125. Maximum value of 1000.
The volume type
Suppresses the specified device included in the block device mapping of the AMI.
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.
The number of CPU cores for the instance.
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.
+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.
The credit option for CPU usage of the instance. Valid for T2 or T3 instances only.
The credit option for CPU usage of a T2 or T3 instance. Valid values are standard and unlimited.
"latest"
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 ModifyInstanceAttribute.
+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.
Choices:
false
Settings for Elastic GPU attachments. See https://aws.amazon.com/ec2/elastic-gpus/ for details.
The type of Elastic GPU to attach
The name or ARN of an IAM instance profile. Requires permissions to describe existing instance roles to confirm ARN is properly formed.
The AMI ID to use for new instances launched with this template. This value is region-dependent since AMIs are not global resources.
Options for alternative instance markets, currently only the spot market is supported.
The market type. This should always be ‘spot’.
+The market type. This should always be spot.
Spot-market specific settings.
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).
+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).
The behavior when a Spot Instance is interrupted. The default is terminate.
The behavior when a Spot Instance is interrupted. The default is terminate.
Choices:
"hibernate"
The highest hourly price you’re willing to pay for this Spot Instance.
The instance type, such as c5.2xlarge. For a full list of instance types, see http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html.
The instance type, such as c5.2xlarge. For a full list of instance types, see http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html.
The ID of the kernel. We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UserProvidedkernels.html
+The ID of the kernel.
+We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UserProvidedkernels.html
metadata_options
dictionary
added in community.aws 1.5.0
@@ -534,7 +545,7 @@Wether the instance metadata endpoint is available via IPv6 (enabled) or not (disabled).
Whether the instance metadata endpoint is available via IPv6.
Choices:
"enabled"
The desired HTTP PUT response hop limit for instance metadata requests. The larger the number, the further instance metadata requests can travel.
+The desired HTTP PUT response hop limit for instance metadata requests.
+The larger the number, the further instance metadata requests can travel.
Default: 1
Wether the instance tags are availble (enabled) via metadata endpoint or not (disabled).
Whether the instance tags are availble (enabled) via metadata endpoint or not (disabled).
Choices:
"enabled"
Settings for instance monitoring.
One or more network interfaces.
A description for the network interface.
The device index for the network interface attachment.
List of security group IDs to include on this instance.
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 ipv6_addresses option.
+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 network_interfaces.ipv6_addresses option.
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 ipv6_address_count option.
+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 network_interfaces.ipv6_address_count option.
The eni ID of a network interface to attach.
The primary private IPv4 address of the network interface.
The ID of the subnet for the network interface.
The placement group settings for the instance.
The affinity setting for an instance on a Dedicated Host.
The Availability Zone for the instance.
The name of the placement group for the instance.
The ID of the Dedicated Host for the instance.
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.
profile
aliases: aws_profile
@@ -754,6 +767,20 @@If purge_tags=true and tags is set, existing tags will be purged from the resource to match exactly what is defined by tags parameter.
If the tags parameter is not set then tags will not be modified, even if purge_tags=True.
Tag keys beginning with aws: are reserved by Amazon and can not be modified. As such they will be ignored for the purposes of the purge_tags parameter. See the Amazon documentation for more information https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html#tag-conventions.
Choices:
+false
true ← (default)
security_groups
list / elements=string
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 security_group_ids.
+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 security_group_ids.
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.
+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_mappings are ignored when creating a new version unless they are explicitly included.
Default: "latest"
The tags to apply to the resources when this Launch template is used.
+The type of resource to tag.
+If the instance does not include the resource type that you specify, the instance launch fails.
+Choices:
+"instance" ← (default)
"volume"
"network-interface"
"spot-instances-request"
A set of key-value pairs to be applied to the resource type.
+Tag key constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:
+Tag value constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
+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 aws:
-Tag value constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
+A dictionary representing the tags to be applied to the resource.
+If the tags parameter is not set then tags will not be modified.
The ID for the launch template, can be used for all cases except creating a new Launch Template.
+At least one of template_id and template_name must be specified.
template_name
aliases: name
@@ -877,16 +938,17 @@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.
+At least one of template_id and template_name must be specified.
The Base64-encoded user data to make available to the instance. For more information, see the Linux http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/user-data.html and Windows http://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/ec2-instance-metadata.html#instancedata-add-user-data documentation on user-data.
The version numbers of a launch template versions to delete.
+Use default_version to specify a new default version when deleting the current default version.
By default, the latest version will be made the default.
+Ignored when state=present.
Note
The tags option used has been in release 9.0.0 to be applied to the launch template resource instead of launch template resource.
Use tag_specifications to define tags to be applied to resources when this Launch Template is used.
Support for purge_tags was added in release 9.0.0.
Caution: For modules, environment variables and configuration files are read from the Ansible ‘host’ context and not the ‘controller’ context. As such, files may need to be explicitly copied to the ‘host’. For lookup and connection plugins, environment variables and configuration files are read from the Ansible ‘controller’ context and not the ‘host’ context.
The AWS SDK (boto3) that Ansible uses may also read defaults for credentials and other settings, such as the region, from its configuration files in the Ansible ‘host’ context (typically ~/.aws/credentials). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information.
The launch template 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
The time launch template was created.
+Returned: always
+The principal that created the launch template.
+Returned: always
+The version number of the default version of the launch template.
+Returned: always
+The version number of the latest version of the launch template.
+Returned: always
+The ID of the launch template.
+Returned: always
+The name of the launch template.
+Returned: always
+A dictionary of tags assigned to image.
+Returned: when AMI is created or already exists
+Sample: {"Env": "devel", "Name": "nat-server"}
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
+Returned: when default_template has a version number.
information about a launch template deleted.
+Returned: when state=absent
The time launch template was created.
+Returned: always
+The principal that created the launch template.
+Returned: always
+The version number of the default version of the launch template.
+Returned: always
+The version number of the latest version of the launch template.
+Returned: always
+The ID of the launch template.
+Returned: always
+The name of the launch template.
+Returned: always
+A dictionary of tags assigned to image.
+Returned: when AMI is created or already exists
+Sample: {"Env": "devel", "Name": "nat-server"}
Information about deleted launch template versions.
+Returned: when state=absent
The ID of the launch template.
+Returned: always
+The name of the launch template.
+Returned: always
+The version number of the launch template.
+Returned: always
+The latest available version of the launch template.
+Returned: when state=present
The time launch template was created.
+Returned: always
+The principal that created the launch template.
+Returned: always
+The version number of the default version of the launch template.
+Returned: always
+The version number of the latest version of the launch template.
+Returned: always
+The ID of the launch template.
+Returned: always
+The name of the launch template.
+Returned: always
+A dictionary of tags assigned to image.
+Returned: when AMI is created or already exists
+Sample: {"Env": "devel", "Name": "nat-server"}
The latest available version number of the launch template.
+Returned: when latest_template has a version number.
Latest available version of the launch template.
+Returned: when state=present
The time launch template was created.
+Returned: always
+The principal that created the launch template.
+Returned: always
+The version number of the default version of the launch template.
+Returned: always
+The version number of the latest version of the launch template.
+Returned: always
+The ID of the launch template.
+Returned: always
+The name of the launch template.
+Returned: always
+A dictionary of tags assigned to image.
+Returned: when AMI is created or already exists
+Sample: {"Env": "devel", "Name": "nat-server"}
All available versions of the launch template.
+Returned: when state=present
The time the version was created.
+Returned: always
+The principal that created the version.
+Returned: always
+Indicates whether the version is the default version.
+Returned: always
+Information about the launch template.
+Returned: always
+Sample: {"block_device_mappings": [{"device_name": "/dev/sdb", "ebs": {"delete_on_termination": true, "encrypted": true, "volumeSize": 5}}], "ebs_optimized": false, "image_id": "ami-0231217be14a6f3ba", "instance_type": "t2.micro", "network_interfaces": [{"associate_public_ip_address": false, "device_index": 0, "ipv6_addresses": [{"ipv6_address": "2001:0:130F:0:0:9C0:876A:130B"}]}]}
The block device mappings.
+Returned: if applicable
+The device name.
+Returned: always
+Information about the block device for an EBS volume.
+Returned: if applicable
+Indicates whether the EBS volume is deleted on instance termination.
+Returned: always
+Indicates whether the EBS volume is encrypted.
+Returned: always
+The number of I/O operations per second (IOPS) that the volume supports.
+Returned: always
+The ARN of the Key Management Service (KMS) CMK used for encryption.
+Returned: always
+The ID of the snapshot.
+Returned: always
+The throughput that the volume supports, in MiB/s.
+Returned: always
+The size of the volume, in GiB.
+Returned: always
+The volume type.
+Returned: always
+To omit the device from the block device mapping, specify an empty string.
+Returned: success
+The virtual device name.
+Returned: always
+The CPU options for the instance.
+Returned: if applicable
+Indicates whether the instance is enabled for AMD SEV-SNP.
+Returned: if applicable
+The number of CPU cores for the instance.
+Returned: if applicable
+The number of threads per CPU core.
+Returned: if applicable
+If set to true, indicates that the instance cannot be terminated using the Amazon EC2 console, command line tool, or API.
+Returned: if applicable
+Indicates whether the instance is optimized for Amazon EBS I/O.
+Returned: always
+Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves.
+Returned: if applicable
+If this parameter is set to true, the instance is enabled for Amazon Web Services Nitro Enclaves.
+Returned: always
+The IAM instance profile.
+Returned: if application
+The Amazon Resource Name (ARN) of the instance profile.
+Returned: always
+The name of the instance profile.
+Returned: always
+The ID of the AMI or a Systems Manager parameter.
+Returned: if applicable
+Indicates whether an instance stops or terminates when you initiate shutdown from the instance.
+Returned: if applicable
+The instance type.
+Returned: if applicable
+The ID of the kernel.
+Returned: if applicable
+The name of the key pair.
+Returned: if applicable
+The metadata options for the instance.
+Returned: if applicable
+Enables or disables the HTTP metadata endpoint on your instances.
+Returned: if applicable
+Enables or disables the IPv6 endpoint for the instance metadata service.
+Returned: if applicable
+The desired HTTP PUT response hop limit for instance metadata requests.
+Returned: if applicable
+Indicates whether IMDSv2 is required.
+Returned: if applicable
+Set to enabled to allow access to instance tags from the instance metadata.
+Returned: if applicable
+The state of the metadata option changes.
+Returned: if applicable
+The monitoring for the instance.
+Returned: if applicable
+Indicates whether detailed monitoring is enabled. Otherwise, basic monitoring is enabled.
+Returned: always
+The network interfaces.
+Returned: if applicable
+Indicates whether to associate a Carrier IP address with eth0 for a new network interface.
+Returned: always
+Indicates whether to associate a public IPv4 address with eth0 for a new network interface.
+Returned: always
+A security group connection tracking specification that enables you to set the timeout for connection tracking on an Elastic network interface.
+Returned: if applicable
+Timeout (in seconds) for idle TCP connections in an established state.
+Returned: always
+Timeout (in seconds) for idle UDP flows classified as streams which have seen more than one request-response transaction.
+Returned: always
+Timeout (in seconds) for idle UDP flows that have seen traffic only in a single direction or a single request-response transaction.
+Returned: always
+Indicates whether the network interface is deleted when the instance is terminated.
+Returned: always
+A description for the network interface.
+Returned: always
+The device index for the network interface attachment.
+Returned: always
+Contains the ENA Express settings for instances launched from your launch template.
+Returned: if applicable
+Indicates whether ENA Express is enabled for the network interface.
+Returned: always
+Configures ENA Express for UDP network traffic.
+Returned: always
+Indicates whether UDP traffic to and from the instance uses ENA Express.
+Returned: always
+The IDs of one or more security groups.
+Returned: if applicable
+The type of network interface.
+Returned: always
+The number of IPv4 prefixes that Amazon Web Services automatically assigned to the network interface.
+Returned: if applicable
+A list of IPv4 prefixes assigned to the network interface.
+Returned: if applicable
+The IPv4 delegated prefixes assigned to the network interface.
+Returned: always
+The number of IPv6 addresses for the network interface.
+Returned: if applicable
+The IPv6 addresses for the network interface.
+Returned: if applicable
+The IPv6 address.
+Returned: always
+Determines if an IPv6 address associated with a network interface is the primary IPv6 address.
+Returned: always
+The number of IPv6 prefixes that Amazon Web Services automatically assigned to the network interface.
+Returned: if applicable
+A list of IPv6 prefixes assigned to the network interface.
+Returned: if applicable
+The IPv6 delegated prefixes assigned to the network interface.
+Returned: always
+The index of the network card.
+Returned: if applicable
+The ID of the network interface.
+Returned: always
+The primary IPv6 address of the network interface.
+Returned: if applicable
+The primary private IPv4 address of the network interface.
+Returned: if applicable
+A list of private IPv4 addresses.
+Returned: if applicable
+Indicates whether the private IPv4 address is the primary private IPv4 address.
+Returned: always
+The private IPv4 address.
+Returned: always
+The number of secondary private IPv4 addresses for the network interface.
+Returned: if applicable
+The ID of the subnet for the network interface.
+Returned: always
+The placement of the instance.
+Returned: if applicable
+The affinity setting for the instance on the Dedicated Host.
+Returned: if applicable
+The Availability Zone of the instance.
+Returned: if applicable
+The Group ID of the placement group.
+Returned: if applicable
+The name of the placement group for the instance.
+Returned: if applicable
+The ID of the Dedicated Host for the instance.
+Returned: if applicable
+The ARN of the host resource group in which to launch the instances.
+Returned: if applicable
+The number of the partition the instance should launch in.
+Returned: if applicable
+The tenancy of the instance.
+Returned: if applicable
+The ID of the RAM disk, if applicable.
+Returned: if applicable
+The security group IDs.
+Returned: if applicable
+The security group names.
+Returned: if applicable
+The tags that are applied to the resources that are created during instance launch.
+Returned: if applicable
+The type of resource to tag.
+Returned: always
+The tags for the resource.
+Returned: success
+The key of the tag.
+Returned: always
+The value of the tag.
+Returned: always
+The user data for the instance.
+Returned: if applicable
+The ID of the launch template.
+Returned: always
+The name of the launch template.
+Returned: always
+The description for the version.
+Returned: always
+Latest available version of the launch template
-Returned: when state=present
+The version number.
+Returned: always