community.aws.lightsail module – Manage instances in AWS Lightsail

Note

This module is part of the community.aws collection (version 6.4.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 community.aws. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: community.aws.lightsail.

New in community.aws 1.0.0

Synopsis

  • Manage instances in AWS Lightsail.

  • Instance tagging is not yet supported in this module.

Requirements

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

  • python >= 3.6

  • boto3 >= 1.22.0

  • botocore >= 1.25.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.

blueprint_id

string

ID of the instance blueprint image.

Required when state=present

bundle_id

string

Bundle of specification info for the instance.

Required when state=present.

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.

key_pair_name

string

Name of the key pair to use with the instance.

If state=present and a key_pair_name is not provided, the default keypair from the region will be used.

name

string / required

Name of the instance.

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.

public_ports

list / elements=dictionary

added in community.aws 6.0.0

A list of dictionaries to describe the ports to open for the specified instance.

cidrs

list / elements=string

The IPv4 address, or range of IPv4 addresses (in CIDR notation) that are allowed to connect to the instance through the ports, and the protocol.

One of cidrs or ipv6_cidrs must be specified.

from_port

integer / required

The first port in a range of open ports on the instance.

ipv6_cidrs

list / elements=string

The IPv6 address, or range of IPv6 addresses (in CIDR notation) that are allowed to connect to the instance through the ports, and the protocol.

One of cidrs or ipv6_cidrs must be specified.

protocol

string / required

The IP protocol name accepted for the defined range of open ports.

Choices:

  • "tcp"

  • "all"

  • "udp"

  • "icmp"

to_port

integer / required

The last port in a range of open ports on the instance.

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.

state

string

Indicate desired state of the target.

rebooted and restarted are aliases.

Choices:

  • "present" ← (default)

  • "absent"

  • "running"

  • "restarted"

  • "rebooted"

  • "stopped"

user_data

string

Launch script that can configure the instance with additional data.

Default: ""

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)

wait

boolean

Wait for the instance to be in state ‘running’ before returning.

If wait=false an ip_address may not be returned.

Has no effect when state=rebooted or state=absent.

Choices:

  • false

  • true ← (default)

wait_timeout

integer

How long before wait gives up, in seconds.

Default: 300

zone

string

AWS availability zone in which to launch the instance.

Required when state=present

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

- name: Create a new Lightsail instance
  community.aws.lightsail:
    state: present
    name: my_instance
    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"
    public_ports:
      - from_port: 22
        to_port: 22
        protocol: "tcp"
        cidrs: ["0.0.0.0/0"]
        ipv6_cidrs: ["::/0"]
  register: my_instance

- name: Delete an instance
  community.aws.lightsail:
    state: absent
    region: us-east-1
    name: my_instance

Return Values

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

Key

Description

changed

boolean

if a snapshot has been modified/created

Returned: always

Sample: {"changed": true}

instance

dictionary

instance data

Returned: always

Sample: {"arn": "arn:aws:lightsail:us-east-1:123456789012: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": "123456789012/i-0997c97831ee21e33", "username": "ubuntu"}

Authors

  • Nick Ball (@nickball)

  • Prasad Katti (@prasadkatti)