amazon.aws.ec2_spot_instance module – Request, stop, reboot or cancel spot instance

Note

This module is part of the amazon.aws collection (version 5.2.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install amazon.aws. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: amazon.aws.ec2_spot_instance.

New in amazon.aws 2.0.0

Synopsis

  • Creates or cancels spot instance requests.

Requirements

The below requirements are needed on the host that executes this module.

  • python >= 3.6

  • boto3 >= 1.18.0

  • botocore >= 1.21.0

Parameters

Parameter

Comments

access_key

aliases: aws_access_key_id, aws_access_key, ec2_access_key

string

AWS access key ID.

See the AWS documentation for more information about access tokens https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys.

The AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variables may also be used in decreasing order of preference.

The aws_access_key and profile options are mutually exclusive.

The aws_access_key_id alias was added in release 5.1.0 for consistency with the AWS botocore SDK.

The ec2_access_key alias has been deprecated and will be removed in a release after 2024-12-01.

Support for the EC2_ACCESS_KEY environment variable has been deprecated and will be removed in a release after 2024-12-01.

aws_ca_bundle

path

The location of a CA Bundle to use when validating SSL certificates.

The AWS_CA_BUNDLE environment variable may also be used.

aws_config

dictionary

A dictionary to modify the botocore configuration.

Parameters can be found in the AWS documentation https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config.

client_token

string

The idempotency token you provided when you launched the instance, if applicable.

count

integer

Number of instances to launch.

Default: 1

debug_botocore_endpoint_logs

boolean

Use a botocore.endpoint logger to parse the unique (rather than total) "resource:action" API calls made during a task, outputing the set to the resource_actions key in the task results. Use the aws_resource_action callback to output to total list made during a playbook.

The ANSIBLE_DEBUG_BOTOCORE_LOGS environment variable may also be used.

Choices:

  • false ← (default)

  • true

endpoint_url

aliases: ec2_url, aws_endpoint_url, s3_url

string

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 AWS_URL or EC2_URL environment variables may also be used, in decreasing order of preference.

The ec2_url and s3_url aliases have been deprecated and will be removed in a release after 2024-12-01.

Support for the EC2_URL environment variable has been deprecated and will be removed in a release after 2024-12-01.

interruption

string

The behavior when a Spot Instance is interrupted.

Choices:

  • "hibernate"

  • "stop"

  • "terminate" ← (default)

launch_group

string

launch_specification

dictionary

The launch specification.

block_device_mappings

list / elements=dictionary

A list of hash/dictionaries of volumes to add to the new instance.

device_name

string

The device name (for example, /dev/sdh or xvdh ).

ebs

dictionary

Parameters used to automatically set up EBS volumes when the instance is launched, see https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ec2.html#EC2.Client.request_spot_instances

no_device

string

To omit the device from the block device mapping, specify an empty string.

virtual_name

string

The virtual device name

ebs_optimized

boolean

Whether instance is using optimized EBS volumes, see https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSOptimized.html.

Choices:

  • false ← (default)

  • true

iam_instance_profile

dictionary

The IAM instance profile.

arn

string

The Amazon Resource Name (ARN) of the instance profile.

Only one of arn or name may be specified.

name

string

The name of the instance profile.

Only one of arn or name may be specified.

image_id

string

The ID of the AMI.

instance_type

string

Instance type to use for the instance, see https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html.

Required when creating a new instance.

kernel_id

string

The ID of the kernel.

key_name

string

Key to use on the instance.

The SSH key must already exist in AWS in order to use this argument.

Keys can be created / deleted using the amazon.aws.ec2_key module.

monitoring

dictionary

Indicates whether basic or detailed monitoring is enabled for the instance.

enabled

boolean

Indicates whether detailed monitoring is enabled. Otherwise, basic monitoring is enabled.

Choices:

  • false ← (default)

  • true

network_interfaces

list / elements=dictionary

One or more network interfaces. If you specify a network interface, you must specify subnet IDs and security group IDs using the network interface.

associate_carrier_ip_address

boolean

Indicates whether to assign a carrier IP address to the network interface.

Choices:

  • false

  • true

associate_public_ip_address

boolean

Indicates whether to assign a public IPv4 address to an instance you launch in a VPC.

Choices:

  • false

  • true

delete_on_termination

boolean

If set to true , the interface is deleted when the instance is terminated. You can specify true only if creating a new network interface when launching an instance.

Choices:

  • false

  • true

description

string

The description of the network interface. Applies only if creating a network interface when launching an instance.

device_index

integer

The position of the network interface in the attachment order. A primary network interface has a device index of 0.

If you specify a network interface when launching an instance, you must specify the device index.

groups

list / elements=string

The IDs of the security groups for the network interface. Applies only if creating a network interface when launching an instance.

interface_type

string

The type of network interface.

Choices:

  • "interface"

  • "efa"

ipv4_prefix_count

integer

The number of IPv4 delegated prefixes to be automatically assigned to the network interface

ipv4_prefixes

list / elements=dictionary

One or more IPv4 delegated prefixes to be assigned to the network interface.

ipv6_address_count

integer

A number of IPv6 addresses to assign to the network interface

ipv6_addresses

list / elements=dictionary

One or more IPv6 addresses to assign to the network interface.

ipv6address

string

The IPv6 address.

ipv6_prefix_count

integer

The number of IPv6 delegated prefixes to be automatically assigned to the network interface

ipv6_prefixes

list / elements=dictionary

One or more IPv6 delegated prefixes to be assigned to the network interface

network_card_index

integer

The index of the network card.

network_interface_id

string

The ID of the network interface.

private_ip_address

string

The private IPv4 address of the network interface

private_ip_addresses

list / elements=dictionary

One or more private IPv4 addresses to assign to the network interface

secondary_private_ip_address_count

integer

The number of secondary private IPv4 addresses.

subnet_id

string

The ID of the subnet associated with the network interface

placement

dictionary

The placement information for the instance.

availability_zone

string

The Availability Zone.

group_name

string

The name of the placement group.

tenancy

string

the tenancy of the host

Choices:

  • "default" ← (default)

  • "dedicated"

  • "host"

ramdisk_id

string

The ID of the RAM disk.

security_group_ids

list / elements=string

Security group id (or list of ids) to use with the instance.

security_groups

list / elements=string

Security group name (or list of group names) to use with the instance.

Only supported with EC2 Classic. To launch in a VPC, use group_id

subnet_id

string

The ID of the subnet in which to launch the instance.

user_data

string

The base64-encoded user data for the instance. User data is limited to 16 KB.

profile

aliases: aws_profile

string

A named AWS profile to use for authentication.

See the AWS documentation for more information about named profiles https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html.

The AWS_PROFILE environment variable may also be used.

The profile option is mutually exclusive with the aws_access_key, aws_secret_key and security_token options.

region

aliases: aws_region, ec2_region

string

The AWS region to use.

For global services such as IAM, Route53 and CloudFront, region is ignored.

The AWS_REGION or EC2_REGION environment variables may also be used.

See the Amazon AWS documentation for more information http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region.

The ec2_region alias has been deprecated and will be removed in a release after 2024-12-01

Support for the EC2_REGION environment variable has been deprecated and will be removed in a release after 2024-12-01.

secret_key

aliases: aws_secret_access_key, aws_secret_key, ec2_secret_key

string

AWS secret access key.

See the AWS documentation for more information about access tokens https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys.

The AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variables may also be used in decreasing order of preference.

The secret_key and profile options are mutually exclusive.

The aws_secret_access_key alias was added in release 5.1.0 for consistency with the AWS botocore SDK.

The ec2_secret_key alias has been deprecated and will be removed in a release after 2024-12-01.

Support for the EC2_SECRET_KEY environment variable has been deprecated and will be removed in a release after 2024-12-01.

session_token

aliases: aws_session_token, security_token, aws_security_token, access_token

string

AWS STS session token for use with temporary credentials.

See the AWS documentation for more information about access tokens https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys.

The AWS_SESSION_TOKEN, AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variables may also be used in decreasing order of preference.

The security_token and profile options are mutually exclusive.

Aliases aws_session_token and session_token were added in release 3.2.0, with the parameter being renamed from security_token to session_token in release 6.0.0.

The security_token, aws_security_token, and access_token aliases have been deprecated and will be removed in a release after 2024-12-01.

Support for the EC2_SECRET_KEY and AWS_SECURITY_TOKEN environment variables has been deprecated and will be removed in a release after 2024-12-01.

spot_instance_request_ids

list / elements=string

List of strings with IDs of spot requests to be cancelled

Default: []

spot_price

string

Maximum spot price to bid. If not set, a regular on-demand instance is requested.

A spot request is made with this maximum bid. When it is filled, the instance is started.

spot_type

string

The type of spot request.

After being interrupted a persistent spot instance will be started once there is capacity to fill the request again.

Choices:

  • "one-time" ← (default)

  • "persistent"

state

string

Whether the spot request should be created or removed.

When state=present, launch_specification is required.

When state=absent, spot_instance_request_ids is required.

Choices:

  • "absent"

  • "present" ← (default)

tags

dictionary

A dictionary of key-value pairs for tagging the Spot Instance request on creation.

validate_certs

boolean

When set to false, SSL certificates will not be validated for communication with the AWS APIs.

Setting validate_certs=false is strongly discouraged, as an alternative, consider setting aws_ca_bundle instead.

Choices:

  • false

  • true ← (default)

zone_group

string

Name for logical grouping of spot requests.

All spot instances in the request are launched in the same availability zone.

Notes

Note

  • 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.

Examples

# Note: These examples do not set authentication details, see the AWS Guide for details.

- name: Simple Spot Request Creation
  amazon.aws.ec2_spot_instance:
    launch_specification:
      image_id: ami-123456789
      key_name: my-keypair
      instance_type: t2.medium

- name: Spot Request Creation with more options
  amazon.aws.ec2_spot_instance:
    launch_specification:
      image_id: ami-123456789
      key_name: my-keypair
      instance_type: t2.medium
      subnet_id: subnet-12345678
      block_device_mappings:
        - device_name: /dev/sdb
          ebs:
            delete_on_termination: True
            volume_type: gp3
            volume_size: 5
        - device_name: /dev/sdc
          ebs:
            delete_on_termination: True
            volume_type: io2
            volume_size: 30
      network_interfaces:
        - associate_public_ip_address: False
          delete_on_termination: True
          device_index: 0
      placement:
        availability_zone: us-west-2a
      monitoring:
        enabled: False
    spot_price: 0.002
    tags:
      Environment: Testing

- name: Spot Request Termination
  amazon.aws.ec2_spot_instance:
    spot_instance_request_ids: ['sir-12345678', 'sir-abcdefgh']
    state: absent

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

cancelled_spot_request

string

The spot instance request details that has been cancelled

Returned: always

Sample: "Spot requests with IDs: sir-1234abcd have been cancelled"

spot_request

dictionary

The spot instance request details after creation

Returned: when success

Sample: {"create_time": "2021-08-23T22:59:12+00:00", "instance_interruption_behavior": "terminate", "launch_specification": {"block_device_mappings": [{"device_name": "/dev/sdb", "ebs": {"delete_on_termination": true, "volume_size": 5, "volume_type": "gp3"}}], "ebs_optimized": false, "iam_instance_profile": {"arn": "arn:aws:iam::EXAMPLE:instance-profile/myinstanceprofile"}, "image_id": "ami-083ac7c7ecf9bb9b0", "instance_type": "t2.small", "key_name": "mykey", "monitoring": {"enabled": false}, "network_interfaces": [{"associate_public_ip_address": false, "delete_on_termination": true, "device_index": 0}], "placement": {"availability_zone": "us-west-2a", "tenancy": "default"}, "security_groups": [{"group_name": "default"}]}, "product_description": "Linux/UNIX", "spot_instance_request_id": "sir-1234abcd", "spot_price": "0.00600", "state": "open", "status": {"code": "pending-evaluation", "message": "Your Spot request has been submitted for review, and is pending evaluation.", "update_time": "2021-08-23T22:59:12+00:00"}, "type": "one-time"}

Authors

  • Sri Rachana Achyuthuni (@srirachanaachyuthuni)