Try SpotterCreate or delete a virtual machine instance in AWS Lightsail
| "added in version" 2.4 of ansible.builtin"
Authors: Nick Ball (@nickball)
preview | supported by community
pipInstall with pip install ansible==2.9.17
Creates or instances in AWS Lightsail and optionally wait for it to be 'running'.
# Create a new Lightsail instance, register the instance details
- lightsail:
state: present
name: myinstance
region: us-east-1
zone: us-east-1a
blueprint_id: ubuntu_16_04
bundle_id: nano_1_0
key_pair_name: id_rsa
user_data: " echo 'hello world' > /home/ubuntu/test.txt"
wait_timeout: 500
register: my_instance
- debug:
msg: "Name is {{ my_instance.instance.name }}"
- debug:
msg: "IP is {{ my_instance.instance.public_ip_address }}"
# Delete an instance if present
- lightsail:
state: absent
region: us-east-1
name: myinstance
name:
description:
- Name of the instance
required: true
wait:
default: 'yes'
description:
- Wait for the instance to be in state 'running' before returning. If wait is "no"
an ip_address may not be returned
type: bool
zone:
description:
- AWS availability zone in which to launch the instance. Required when state='present'
state:
choices:
- present
- absent
- running
- restarted
- stopped
default: present
description:
- Indicate desired state of the target.
region:
aliases:
- aws_region
- ec2_region
description:
- The AWS region to use. If not specified then the value of the AWS_REGION or EC2_REGION
environment variable, if any, is used. See U(http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region)
type: str
ec2_url:
aliases:
- aws_endpoint_url
- endpoint_url
description:
- URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will
use EC2 endpoints). Ignored for modules where region is required. Must be specified
for all other modules if region is not used. If not set then the value of the EC2_URL
environment variable, if any, is used.
type: str
profile:
aliases:
- aws_profile
description:
- Using I(profile) will override I(aws_access_key), I(aws_secret_key) and I(security_token)
and support for passing them at the same time as I(profile) has been deprecated.
- I(aws_access_key), I(aws_secret_key) and I(security_token) will be made mutually
exclusive with I(profile) after 2022-06-01.
type: str
bundle_id:
description:
- Bundle of specification info for the instance. Required when state='present'
user_data:
description:
- Launch script that can configure the instance with additional data
aws_config:
description:
- A dictionary to modify the botocore configuration.
- Parameters can be found at U(https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config).
- Only the 'user_agent' key is used for boto modules. See U(http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto)
for more boto configuration.
type: dict
blueprint_id:
description:
- ID of the instance blueprint image. Required when state='present'
wait_timeout:
default: 300
description:
- How long before wait gives up, in seconds.
aws_ca_bundle:
description:
- The location of a CA Bundle to use when validating SSL certificates.
- Not used by boto 2 based modules.
- 'Note: The CA Bundle is read ''module'' side and may need to be explicitly copied
from the controller if not run locally.'
type: path
key_pair_name:
description:
- Name of the key pair to use with the instance
aws_access_key:
aliases:
- ec2_access_key
- access_key
description:
- C(AWS access key). If not set then the value of the C(AWS_ACCESS_KEY_ID), C(AWS_ACCESS_KEY)
or C(EC2_ACCESS_KEY) environment variable is used.
- If I(profile) is set this parameter is ignored.
- Passing the I(aws_access_key) and I(profile) options at the same time has been deprecated
and the options will be made mutually exclusive after 2022-06-01.
type: str
aws_secret_key:
aliases:
- ec2_secret_key
- secret_key
description:
- C(AWS secret key). If not set then the value of the C(AWS_SECRET_ACCESS_KEY), C(AWS_SECRET_KEY),
or C(EC2_SECRET_KEY) environment variable is used.
- If I(profile) is set this parameter is ignored.
- Passing the I(aws_secret_key) and I(profile) options at the same time has been deprecated
and the options will be made mutually exclusive after 2022-06-01.
type: str
security_token:
aliases:
- aws_security_token
- access_token
description:
- C(AWS STS security token). If not set then the value of the C(AWS_SECURITY_TOKEN)
or C(EC2_SECURITY_TOKEN) environment variable is used.
- If I(profile) is set this parameter is ignored.
- Passing the I(security_token) and I(profile) options at the same time has been deprecated
and the options will be made mutually exclusive after 2022-06-01.
type: str
validate_certs:
default: true
description:
- When set to "no", SSL certificates will not be validated for communication with
the AWS APIs.
type: bool
debug_botocore_endpoint_logs:
default: 'no'
description:
- 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.
type: bool
changed:
description: if a snapshot has been modified/created
returned: always
sample:
changed: true
type: bool
instance:
description: instance data
returned: always
sample:
arn: arn:aws:lightsail:us-east-1:448830907657:Instance/1fef0175-d6c8-480e-84fa-214f969cda87
blueprint_id: ubuntu_16_04
blueprint_name: Ubuntu
bundle_id: nano_1_0
created_at: '2017-03-27T08:38:59.714000-04:00'
hardware:
cpu_count: 1
ram_size_in_gb: 0.5
is_static_ip: false
location:
availability_zone: us-east-1a
region_name: us-east-1
name: my_instance
networking:
monthly_transfer:
gb_per_month_allocated: 1024
ports:
- access_direction: inbound
access_from: Anywhere (0.0.0.0/0)
access_type: public
common_name: ''
from_port: 80
protocol: tcp
to_port: 80
- access_direction: inbound
access_from: Anywhere (0.0.0.0/0)
access_type: public
common_name: ''
from_port: 22
protocol: tcp
to_port: 22
private_ip_address: 172.26.8.14
public_ip_address: 34.207.152.202
resource_type: Instance
ssh_key_name: keypair
state:
code: 16
name: running
support_code: 588307843083/i-0997c97831ee21e33
username: ubuntu
type: dict