community.aws.lightsail – Manage instances in AWS Lightsail
Note
This plugin is part of the community.aws collection (version 1.5.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
.
To use it in a playbook, specify: community.aws.lightsail
.
New in version 1.0.0: of community.aws
Requirements
The below requirements are needed on the host that executes this module.
boto
boto3
python >= 2.6
Parameters
Parameter |
Comments |
---|---|
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. If profile is set this parameter is ignored. Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01. |
|
The location of a CA Bundle to use when validating SSL certificates. Only used for boto3 based modules. Note: The CA Bundle is read ‘module’ side and may need to be explicitly copied from the controller if not run locally. |
|
A dictionary to modify the botocore configuration. Parameters can be found at 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 http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto for more boto configuration. |
|
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. If profile is set this parameter is ignored. Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01. |
|
ID of the instance blueprint image. Required when state=present |
|
Bundle of specification info for the instance. Required when state=present. |
|
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:
|
|
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. |
|
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 of the instance. |
|
Uses a boto profile. Only works with boto >= 2.24.0. Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated. aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01. |
|
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 http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region |
|
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used. If profile is set this parameter is ignored. Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01. |
|
Indicate desired state of the target. rebooted and restarted are aliases. Choices:
|
|
Launch script that can configure the instance with additional data. |
|
When set to “no”, SSL certificates will not be validated for boto versions >= 2.6.0. Choices:
|
|
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:
|
|
How long before wait gives up, in seconds. Default: 300 |
|
AWS availability zone in which to launch the instance. Required when state=present |
Notes
Note
If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence
AWS_URL
orEC2_URL
,AWS_PROFILE
orAWS_DEFAULT_PROFILE
,AWS_ACCESS_KEY_ID
orAWS_ACCESS_KEY
orEC2_ACCESS_KEY
,AWS_SECRET_ACCESS_KEY
orAWS_SECRET_KEY
orEC2_SECRET_KEY
,AWS_SECURITY_TOKEN
orEC2_SECURITY_TOKEN
,AWS_REGION
orEC2_REGION
,AWS_CA_BUNDLE
Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html
AWS_REGION
orEC2_REGION
can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file
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"
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 |
---|---|
if a snapshot has been modified/created Returned: always Sample: {“changed”: true} |
|
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”} |
Authors
Nick Ball (@nickball)
Prasad Katti (@prasadkatti)