amazon.aws.ec2_vpc_subnet 模块 – 管理 AWS 虚拟私有云中的子网

注意

此模块是 amazon.aws 集合（版本 9.0.0）的一部分。

如果您正在使用 ansible 包，您可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install amazon.aws。您需要其他要求才能使用此模块，请参阅 要求 了解详细信息。

要在 playbook 中使用它，请指定：amazon.aws.ec2_vpc_subnet。

amazon.aws 1.0.0 中的新增功能

概要

• 管理 AWS 虚拟私有云中的子网。

要求

执行此模块的主机需要满足以下要求。

• python >= 3.6

• boto3 >= 1.28.0

• botocore >= 1.31.0

参数

参数	注释
access_key 别名：aws_access_key_id、aws_access_key、ec2_access_key string	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_ID、AWS_ACCESS_KEY 或 EC2_ACCESS_KEY 环境变量，优先级依次降低。 aws_access_key 和 profile 选项是互斥的。 aws_access_key_id 别名在 5.1.0 版本中添加，与 AWS botocore SDK 保持一致。 ec2_access_key 别名已被弃用，将在 2024-12-01 之后的版本中删除。 对 EC2_ACCESS_KEY 环境变量的支持已被弃用，将在 2024-12-01 之后的版本中删除。
assign_instances_ipv6 boolean	是否应默认将启动到子网中的实例自动分配 IPv6 地址。 如果 assign_instances_ipv6=true，则还必须指定 ipv6_cidr。 选择 false ← (默认) true
aws_ca_bundle path	用于验证 SSL 证书时使用的 CA 包的位置。 也可以使用 AWS_CA_BUNDLE 环境变量。
aws_config dictionary	用于修改 botocore 配置的字典。 参数可以在 AWS 文档中找到 https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config。
az string	子网的可用区。 如果设置了 outpost_arn，则为必需。
cidr string / required	子网的 CIDR 块。例如，192.0.2.0/24。
debug_botocore_endpoint_logs boolean	使用 botocore.endpoint 记录器来解析任务期间发出的唯一的（而不是总的）"resource:action" API 调用，将集合输出到任务结果中的 resource_actions 键。使用 aws_resource_action 回调输出 playbook 期间创建的总列表。 也可以使用 ANSIBLE_DEBUG_BOTOCORE_LOGS 环境变量。 选择 false ← (默认) true
endpoint_url 别名：ec2_url、aws_endpoint_url、s3_url string	连接到而不是默认 AWS 终端节点的 URL。虽然这可以用于连接到其他与 AWS 兼容的服务，但 amazon.aws 和 community.aws 集合仅针对 AWS 进行测试。 也可以使用 AWS_URL 或 EC2_URL 环境变量，优先级依次降低。 ec2_url 和 s3_url 别名已被弃用，将在 2024-12-01 之后的版本中删除。 对 EC2_URL 环境变量的支持已被弃用，将在 2024-12-01 之后的版本中删除。
ipv6_cidr string	子网的 IPv6 CIDR 块。 VPC 必须分配一个 /56 块，并且此值必须是 VPC 范围内的有效 IPv6 /64。 如果 assign_instances_ipv6=true，则为必需 默认值： ""
map_public boolean	是否应将启动到子网中的实例默认分配公有 IP 地址。 选择 false ← (默认) true
outpost_arn string	Outpost 的亚马逊资源名称 (ARN)。 如果设置，则允许在 Outpost 中创建子网。 如果设置了 outpost_arn，则还必须指定 az。 默认值： ""
profile 别名：aws_profile string	用于身份验证的已命名的 AWS 配置文件。 有关已命名配置文件的更多信息，请参阅 AWS 文档 https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html。 也可以使用 AWS_PROFILE 环境变量。 profile 选项与 aws_access_key、aws_secret_key 和 security_token 选项互斥。
purge_tags boolean	如果 purge_tags=true 并且设置了 tags，则将从资源中清除现有标签，以完全匹配 tags 参数定义的标签。 如果未设置 tags 参数，则不会修改标签，即使 purge_tags=True。 以 aws: 开头的标签键由 Amazon 保留，无法修改。因此，它们将被忽略，不影响 purge_tags 参数。有关更多信息，请参阅 Amazon 文档 https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html#tag-conventions。 选择 false true ← (默认)
region 别名：aws_region, ec2_region string	要使用的 AWS 区域。 对于 IAM、Route53 和 CloudFront 等全局服务，将忽略 region。 也可以使用 AWS_REGION 或 EC2_REGION 环境变量。 有关更多信息，请参阅 Amazon AWS 文档 http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region。 ec2_region 别名已弃用，将在 2024-12-01 之后的版本中删除 对 EC2_REGION 环境变量的支持已弃用，将在 2024-12-01 之后的版本中删除。
secret_key 别名：aws_secret_access_key, aws_secret_key, ec2_secret_key string	AWS 私有访问密钥。 有关访问令牌的更多信息，请参阅 AWS 文档 https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys。 也可以按优先级递减的顺序使用 AWS_SECRET_ACCESS_KEY、AWS_SECRET_KEY 或 EC2_SECRET_KEY 环境变量。 secret_key 和 profile 选项互斥。 为了与 AWS botocore SDK 保持一致，在 5.1.0 版本中添加了 aws_secret_access_key 别名。 ec2_secret_key 别名已弃用，将在 2024-12-01 之后的版本中删除。 对 EC2_SECRET_KEY 环境变量的支持已弃用，将在 2024-12-01 之后的版本中删除。
session_token 别名：aws_session_token, security_token, aws_security_token, access_token string	用于临时凭证的 AWS STS 会话令牌。 有关访问令牌的更多信息，请参阅 AWS 文档 https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys。 也可以按优先级递减的顺序使用 AWS_SESSION_TOKEN、AWS_SECURITY_TOKEN 或 EC2_SECURITY_TOKEN 环境变量。 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 之后的版本中删除。 对 EC2_SECRET_KEY 和 AWS_SECURITY_TOKEN 环境变量的支持已弃用，将在 2024-12-01 之后的版本中删除。
state string	创建或删除子网。 选择 "present" ← (默认) "absent"
tags 别名：resource_tags dictionary	一个表示要应用于资源的标签的字典。 如果未设置 tags 参数，则不会修改标签。
validate_certs boolean	设置为 false 时，将不会验证与 AWS API 通信的 SSL 证书。 强烈建议不要设置 validate_certs=false，作为替代方法，请考虑设置 aws_ca_bundle。 选择 false true ← (默认)
vpc_id string / required	-“要在其中创建或删除子网的 VPC 的 VPC ID。
wait boolean	是否等待更改完成。 选择 false true ← (默认)
wait_timeout 整数	等待更改完成的秒数 除非 wait=true，否则将被忽略。 默认值： 300

注释

注意

• 注意： 对于模块，环境变量和配置文件是从 Ansible “主机”上下文而不是“控制器”上下文读取的。因此，可能需要将文件显式复制到“主机”。对于查找和连接插件，环境变量和配置文件是从 Ansible “控制器”上下文而不是“主机”上下文读取的。

• Ansible 使用的 AWS SDK (boto3) 也可能会从 Ansible “主机”上下文（通常为 ~/.aws/credentials）中的配置文件中读取凭证和其他设置（如区域）的默认值。有关更多信息，请参阅 https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html。

示例

# Note: These examples do not set authentication details, see the AWS Guide for details.

- name: Create subnet for database servers
  amazon.aws.ec2_vpc_subnet:
    state: present
    vpc_id: vpc-123456
    cidr: 10.0.1.16/28
    tags:
      Name: Database Subnet
  register: database_subnet

- name: Remove subnet for database servers
  amazon.aws.ec2_vpc_subnet:
    state: absent
    vpc_id: vpc-123456
    cidr: 10.0.1.16/28

- name: Create subnet with IPv6 block assigned
  amazon.aws.ec2_vpc_subnet:
    state: present
    vpc_id: vpc-123456
    cidr: 10.1.100.0/24
    ipv6_cidr: 2001:db8:0:102::/64

- name: Remove IPv6 block assigned to subnet
  amazon.aws.ec2_vpc_subnet:
    state: present
    vpc_id: vpc-123456
    cidr: 10.1.100.0/24
    ipv6_cidr: ''

返回值

常见返回值记录在此处，以下是此模块独有的字段

键	描述
subnet 复杂	子网值字典。 已返回： state=present
assign_ipv6_address_on_creation boolean	是否将 IPv6 地址自动分配给新实例。 已返回： state=present 示例： false
availability_zone string	子网的可用区。 已返回： state=present 示例： "us-east-1a"
availability_zone_id string	子网的可用区 ID。 已返回： state=present 示例： "use1-az6"
available_ip_address_count string	可用 IPv4 地址的数量。 已返回： state=present 示例： "251"
cidr_block string	子网的 IPv4 CIDR。 已返回： state=present 示例： "10.0.0.0/16"
default_for_az boolean	指示这是否为该可用区的默认子网。 已返回： state=present 示例： false
enable_dns64 boolean	指示发出的 DNS 查询是否应为仅限 IPv4 的目标返回合成 IPv6 地址。 已返回：成功 示例： false
id string	子网资源 ID。 已返回： state=present 示例： "subnet-b883b2c4"
ipv6_association_id string	当前关联的 CIDR 的 IPv6 关联 ID。 已返回： state=present 示例： "subnet-cidr-assoc-b85c74d2"
ipv6_cidr_block string	与子网主动关联的 IPv6 CIDR 块。 已返回： state=present 示例： "2001:db8:0:102::/64"
ipv6_cidr_block_association_set 复杂	IPv6 cidr 块关联集信息的数组。 已返回： state=present
association_id string	关联 ID。 已返回：始终
ipv6_cidr_block string	与子网关联的 IPv6 CIDR 块。 已返回：始终
ipv6_cidr_block_state dictionary	一个包含单个项的哈希/字典。cidr 块关联的状态。 已返回：始终
state string	CIDR 块关联状态。 已返回：始终
ipv6_native boolean	指示这是否为仅限 IPv6 的子网。 已返回：成功 示例： false
map_customer_owned_ip_on_launch boolean	指示网络接口是否接收客户拥有的 IPv4 地址。 已返回：成功 示例： "flase"
map_public_ip_on_launch boolean	是否将公有 IP 自动分配给新实例。 已返回： state=present 示例： false
owner_id string	拥有子网的 Amazon Web Services 账户的 ID。 已返回：成功 示例： "12344567"
private_dns_name_options_on_launch dictionary	在启动时分配给子网中实例的主机名类型。 实例主机名基于实例的 IPv4 地址或 ID。 已返回：成功 示例： {"enable_resource_name_dns_a_record": false, "enable_resource_name_dns_aaaa_record": false, "hostname_type": "ip-name"}
state string	子网的状态。 已返回： state=present 示例： "available"
subnet_arn string	子网的 Amazon 资源名称 (ARN)。 已返回：成功 示例： "arn:aws:ec2:us-east-1:xxx:subnet/subnet-xxx"
标签 dictionary	附加到子网的标签，包括名称。 已返回： state=present 示例： {"Name": "My Subnet", "env": "staging"}
vpc_id string	此子网所在的 VPC 的 ID。 已返回： state=present 示例： "vpc-67236184"

作者

• Robert Estelle (@erydo)

• Brad Davidson (@brandond)

集合链接

• 问题跟踪器
• 存储库（源代码）
• 沟通