amazon.aws.ec2_vpc_net 模块 – 配置 AWS 虚拟私有云

注意

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

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

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

要在 Playbook 中使用它，请指定：amazon.aws.ec2_vpc_net。

amazon.aws 1.0.0 中的新增功能

概要

• 创建、修改和终止 AWS 虚拟私有云 (VPC)。

要求

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

• python >= 3.6

• boto3 >= 1.28.0

• botocore >= 1.31.0

参数

参数	注释
access_key 别名: aws_access_key_id, aws_access_key, ec2_access_key 字符串	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 botocore SDK 保持一致，在 5.1.0 版本中添加了 aws_access_key_id 别名。 ec2_access_key 别名已弃用，将在 2024-12-01 之后的版本中删除。 对 EC2_ACCESS_KEY 环境变量的支持已弃用，将在 2024-12-01 之后的版本中删除。
aws_ca_bundle 路径	验证 SSL 证书时要使用的 CA 包的位置。 也可以使用 AWS_CA_BUNDLE 环境变量。
aws_config 字典	用于修改 botocore 配置的字典。 可以在 AWS 文档中找到参数 https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config。
cidr_block 列表 / elements=字符串	VPC 的主要 CIDR。 列表中的第一个将用作主要 CIDR，并与 name 一起使用，以确保幂等性。 当未设置 vpc_id 时，此参数是必需的。
debug_botocore_endpoint_logs 布尔值	使用 botocore.endpoint 记录器解析任务期间进行的唯一（而不是总计）"resource:action" API 调用，并将该集合输出到任务结果中的 resource_actions 键。使用 aws_resource_action 回调输出在 playbook 期间制作的总列表。 也可以使用 ANSIBLE_DEBUG_BOTOCORE_LOGS 环境变量。 选项 false ←（默认） true
dhcp_opts_id 字符串	要用于此 VPC 的 DHCP 选项的 ID。
dns_hostnames 布尔值	是否启用 AWS 主机名支持。 创建新的 VPC 时，默认值为 true。 选项 false true
dns_support 布尔值	是否启用 AWS DNS 支持。 创建新的 VPC 时，默认值为 true。 选项 false true
endpoint_url 别名：ec2_url, aws_endpoint_url, s3_url 字符串	要连接的 URL，而不是默认的 AWS 端点。虽然这可以用于连接到其他 AWS 兼容服务，但 amazon.aws 和 community.aws 集合仅针对 AWS 进行测试。 也可以按优先级降序使用 AWS_URL 或 EC2_URL 环境变量。 ec2_url 和 s3_url 别名已弃用，将在 2024-12-01 之后的版本中删除。 对 EC2_URL 环境变量的支持已弃用，将在 2024-12-01 之后的版本中删除。
ipv6_cidr 布尔值	请求带有 /56 前缀长度的 Amazon 提供的 IPv6 CIDR 块。您不能指定 IPv6 地址的范围或 CIDR 块的大小。 创建新的 VPC 时，默认值为 false。 选项 false true
multi_ok 布尔值	默认情况下，如果存在另一个具有相同名称和 CIDR 块的 VPC，该模块将不会创建另一个 VPC。如果希望创建重复的 VPC，请指定 multi_ok=true。 选项 false ←（默认） true
name 字符串	为您的 VPC 指定的名称。此名称与 cidr_block 结合使用，以确定 VPC 是否已存在。 name 的值会覆盖 tags 参数中 Name 所设置的任何值。 必须指定 name 和 vpc_id 中的至少一个。 创建新的 VPC 时，必须指定 name。
profile 别名: aws_profile 字符串	用于身份验证的已命名的 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_cidrs 布尔值	删除与 VPC 关联且未在 cidr_block 中指定的 CIDR。 选项 false ←（默认） true
purge_tags 布尔值	如果 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 字符串	要使用的 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 字符串	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 字符串	用于临时凭证的 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 字符串	VPC 的状态。可以是 absent 或 present。 选项 "present" ← (默认) "absent"
tags 别名: resource_tags 字典	一个字典，表示要应用于资源的标签。 如果未设置 tags 参数，则不会修改标签。
tenancy 字符串	是要使用 default 还是 dedicated 租赁。 VPC 创建后无法更改此项。 选项 "default" ← (默认) "dedicated"
validate_certs 布尔值	设置为 false 时，将不验证与 AWS API 通信的 SSL 证书。 强烈建议不要设置 validate_certs=false，作为替代方案，请考虑设置 aws_ca_bundle。 选项 false true ← (默认)
vpc_id 字符串 在 amazon.aws 4.0.0 中添加	VPC 的 ID。 必须指定 name 和 vpc_id 中的至少一个。 必须指定 name 和 cidr_block 中的至少一个。

说明

注意

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

• Ansible 使用的 AWS SDK (boto3) 也可能会从 Ansible “host” 上下文中的配置文件（通常是 ~/.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 a VPC with dedicated tenancy and a couple of tags
  amazon.aws.ec2_vpc_net:
    name: Module_dev2
    cidr_block: 10.10.0.0/16
    region: us-east-1
    tags:
      module: ec2_vpc_net
      this: works
    tenancy: dedicated

- name: create a VPC with dedicated tenancy and request an IPv6 CIDR
  amazon.aws.ec2_vpc_net:
    name: Module_dev2
    cidr_block: 10.10.0.0/16
    ipv6_cidr: true
    region: us-east-1
    tenancy: dedicated

- name: Delete an existing VPC
  amazon.aws.ec2_vpc_net:
    vpc_id: vpc-0123456789abcdef0
    state: absent

返回值

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

键	描述
vpc 复杂	有关已创建或删除的 VPC 的信息。 返回: 总是
cidr_block 字符串	VPC 的 CIDR。 返回: 总是 示例: "10.0.0.0/16"
cidr_block_association_set 列表 / elements=字符串	与 VPC 关联的 IPv4 CIDR 块。 返回: 成功 示例: {"cidr_block_association_set": [{"association_id": "vpc-cidr-assoc-97aeeefd", "cidr_block": "10.0.0.0/24", "cidr_block_state": {"state": "associated"}}]}
dhcp_options_id 字符串	与此 VPC 关联的 DHCP 选项的 ID。 返回: 总是 示例: "dopt-12345678"
id 字符串	VPC 资源 ID。 返回: 总是 示例: "vpc-12345678"
instance_tenancy 字符串	指示 VPC 是否使用默认或专用租赁。 返回: 总是 示例: "default"
ipv6_cidr_block_association_set 列表 / elements=字符串	与 VPC 关联的 IPv6 CIDR 块。 返回: 成功 示例: {"ipv6_cidr_block_association_set": [{"association_id": "vpc-cidr-assoc-97aeeefd", "ipv6_cidr_block": "2001:db8::/56", "ipv6_cidr_block_state": {"state": "associated"}}]}
is_default 布尔值	指示这是否为默认 VPC。 返回: 总是 示例: false
name 字符串 在 amazon.aws 4.0.0 中添加	VPC 的 Name 标签。 返回值: 当 VPC 设置了 Name 标签时返回。 示例: "MyVPC"
owner_id 字符串	拥有该 VPC 的 AWS 账户。 返回: 总是 示例: "123456789012"
state 字符串	VPC 的状态。 返回: 总是 示例: "available"
tags 复杂	附加到 VPC 的标签，包括名称。 返回: 总是
Name 字符串	VPC 的 Name 标签。 返回: 总是 示例: "pk_vpc4"

作者

• Jonathan Davila (@defionscode)

• Sloane Hertel (@s-hertel)

合集链接

• 问题跟踪器
• 代码仓库 (源代码)
• 通信