community.aws.lightsail 模块 – 管理 AWS Lightsail 中的实例
注意
此模块是 community.aws 集合（版本 9.0.0）的一部分。
如果您正在使用 ansible 包，您可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。
要安装它，请使用：ansible-galaxy collection install community.aws。您需要进一步的要求才能使用此模块，有关详细信息，请参阅 要求。
要在 playbook 中使用它，请指定：community.aws.lightsail。
community.aws 1.0.0 中的新增功能
概要
管理 AWS Lightsail 中的实例。
此模块尚不支持实例标记。
要求
执行此模块的主机需要以下要求。
python >= 3.6
boto3 >= 1.28.0
botocore >= 1.31.0
参数
参数 |
注释 |
|---|---|
AWS 访问密钥 ID。 有关访问令牌的更多信息，请参阅 AWS 文档 https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys。 还可以使用 aws_access_key 和 profile 选项是互斥的。 为了与 AWS botocore SDK 保持一致，在 5.1.0 版本中添加了 aws_access_key_id 别名。 ec2_access_key 别名已弃用，将在 2024-12-01 之后的版本中删除。 对 |
|
验证 SSL 证书时要使用的 CA 捆绑包的位置。 也可以使用 |
|
一个字典，用于修改 botocore 配置。 可以在 AWS 文档中找到参数 https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config。 |
|
实例蓝图映像的 ID。 当 state=present 时为必需 |
|
实例的规范信息捆绑包。 当 state=present 时为必需。 |
|
使用 也可以使用 选项
|
|
要连接到的 URL，而不是默认的 AWS 端点。虽然这可以用于连接到其他 AWS 兼容服务，但 amazon.aws 和 community.aws 集合仅针对 AWS 进行了测试。 也可以使用 ec2_url 和 s3_url 别名已弃用，将在 2024-12-01 之后的版本中删除。 对 |
|
要与实例一起使用的密钥对的名称。 如果 state=present 且未提供 key_pair_name，则将使用该区域的默认密钥对。 |
|
实例的名称。 |
|
用于身份验证的命名 AWS 配置文件。 有关命名配置文件的更多信息，请参阅 AWS 文档 https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html。 也可以使用 profile 选项与 aws_access_key、aws_secret_key 和 security_token 选项互斥。 |
|
用于描述为指定实例打开的端口的字典列表。 |
|
允许通过端口连接到实例的 IPv4 地址或 IPv4 地址范围（采用 CIDR 表示法），以及协议。 必须指定 cidrs 或 ipv6_cidrs 之一。 |
|
实例上打开的端口范围中的第一个端口。 |
|
允许通过端口连接到实例的 IPv6 地址或 IPv6 地址范围（采用 CIDR 表示法），以及协议。 必须指定 cidrs 或 ipv6_cidrs 之一。 |
|
为定义的开放端口范围接受的 IP 协议名称。 选项
|
|
实例上开放端口范围的最后一个端口。 |
|
要使用的 AWS 区域。 对于诸如 IAM、Route53 和 CloudFront 等全局服务，region 将被忽略。 也可以使用 有关更多信息，请参阅 Amazon AWS 文档 http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region。
对 |
|
AWS secret access key。 有关访问令牌的更多信息，请参阅 AWS 文档 https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys。 也可以使用 secret_key 和 profile 选项互斥。 为了与 AWS botocore SDK 保持一致，在 5.1.0 版本中添加了 aws_secret_access_key 别名。 ec2_secret_key 别名已被弃用，将在 2024-12-01 之后的版本中删除。 对 |
|
用于临时凭证的 AWS STS 会话令牌。 有关访问令牌的更多信息，请参阅 AWS 文档 https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys。 也可以使用 security_token 和 profile 选项互斥。 别名 aws_session_token 和 session_token 在 3.2.0 版本中添加，参数在 6.0.0 版本中从 security_token 重命名为 session_token。 security_token、aws_security_token 和 access_token 别名已被弃用，将在 2024-12-01 之后的版本中删除。 对 |
|
指示目标所需的状态。 rebooted 和 restarted 是别名。 选项
|
|
启动脚本，可以使用其他数据配置实例。 默认值： |
|
设置为 强烈建议不要设置 validate_certs=false，作为替代方案，请考虑设置 aws_ca_bundle。 选项
|
|
等待实例处于“运行”状态，然后再返回。 如果 wait=false，则可能不会返回 ip_address。 当 state=rebooted 或 state=absent 时不起作用。 选项
|
|
wait 超时放弃之前的时间，以秒为单位。 默认值： |
|
用于启动实例的 AWS 可用区。 当 state=present 时为必需 |
备注
注意
注意：对于模块，环境变量和配置文件是从 Ansible“主机”上下文中读取的，而不是从“控制器”上下文中读取的。因此，可能需要将文件显式复制到“主机”。对于查找和连接插件，环境变量和配置文件是从 Ansible“控制器”上下文中读取的，而不是从“主机”上下文中读取的。
Ansible 使用的 AWS SDK (boto3) 也可能从 Ansible“主机”上下文中的配置文件（通常是
~/.aws/credentials）读取凭据和其他设置（例如区域）的默认值。有关更多信息，请参阅 https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html。
示例
- 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
返回值
常见的返回值记录在此处，以下是此模块特有的字段
键 |
描述 |
|---|---|
如果快照已修改/创建 返回： 总是 示例： |
|
实例数据 返回： 总是 示例： |