lightsail - Create or delete a virtual machine instance in AWS Lightsail

New in version 2.4.

Synopsis

  • Creates or instances in AWS Lightsail and optionally wait for it to be ‘running’.

Requirements (on host that executes module)

  • boto
  • boto3
  • python >= 2.6

Options

parameter required default choices comments
aws_access_key
 no
AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
aliases: ec2_access_key, access_key
aws_secret_key
 no
AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
aliases: ec2_secret_key, secret_key
blueprint_id
 no
ID of the instance blueprint image. Required when state='present'
bundle_id
 no
Bundle of specification info for the instance. Required when state='present'
ec2_url
 no
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.
key_pair_name
 no
Name of the key pair to use with the instance
name
 yes
Name of the instance
profile
(added in 1.6)
 no
Uses a boto profile. Only works with boto >= 2.24.0.
security_token
(added in 1.6)
 no
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
aliases: access_token
state
 no present
  • present
  • absent
  • running
  • restarted
  • stopped
Indicate desired state of the target.
user_data
 no
Launch script that can configure the instance with additional data
validate_certs
(added in 1.5)
 no yes
  • yes
  • no
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
wait
 no yes
  • yes
  • no
Wait for the instance to be in state 'running' before returning. If wait is "no" an ip_address may not be returned
wait_timeout
 no 300
How long before wait gives up, in seconds.
zone
 no
AWS availability zone in which to launch the instance. Required when state='present'

Examples

# 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.publicIpAddress }}"

# Delete an instance if present
- lightsail:
    state: absent
    region: us-east-1
    name: myinstance

Return Values

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

name description returned type sample
changed
if a snapshot has been modified/created
 always bool {'changed': True}
instance
instance data
 always dict {'username': 'ubuntu', 'blueprint_name': 'Ubuntu', 'public_ip_address': '34.207.152.202', 'blueprint_id': 'ubuntu_16_04', 'hardware': {'cpu_count': 1, 'ram_size_in_gb': 0.5}, 'bundle_id': 'nano_1_0', 'arn': 'arn:aws:lightsail:us-east-1:448830907657:Instance/1fef0175-d6c8-480e-84fa-214f969cda87', 'support_code': '588307843083/i-0997c97831ee21e33', 'networking': {'ports': [{'access_direction': 'inbound', 'common_name': '', 'access_from': 'Anywhere (0.0.0.0/0)', 'from_port': 80, 'protocol': 'tcp', 'to_port': 80, 'access_type': 'public'}, {'access_direction': 'inbound', 'common_name': '', 'access_from': 'Anywhere (0.0.0.0/0)', 'from_port': 22, 'protocol': 'tcp', 'to_port': 22, 'access_type': 'public'}], 'monthly_transfer': {'gb_per_month_allocated': 1024}}, 'name': 'my_instance', 'created_at': '2017-03-27T08:38:59.714000-04:00', 'state': {'code': 16, 'name': 'running'}, 'is_static_ip': False, 'ssh_key_name': 'keypair', 'location': {'region_name': 'us-east-1', 'availability_zone': 'us-east-1a'}, 'private_ip_address': '172.26.8.14', 'resource_type': 'Instance'}

Notes

Note

  • If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence AWS_URL or EC2_URL, AWS_ACCESS_KEY_ID or AWS_ACCESS_KEY or EC2_ACCESS_KEY, AWS_SECRET_ACCESS_KEY or AWS_SECRET_KEY or EC2_SECRET_KEY, AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN, AWS_REGION or EC2_REGION
  • Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See http://boto.readthedocs.org/en/latest/boto_config_tut.html
  • AWS_REGION or EC2_REGION can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file

Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/lightsail_module.html