amazon.aws.ec2_vpc_peering_info 模块 – 使用 AWS 方法检索 AWS VPC 对等连接详细信息

注意

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

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

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

要在剧本中使用它，请指定：amazon.aws.ec2_vpc_peering_info。

community.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。
debug_botocore_endpoint_logs 布尔值	使用 botocore.endpoint 记录器来解析任务期间发出的唯一（而不是总数）"resource:action" API 调用，将集合输出到任务结果中的 resource_actions 键。使用 aws_resource_action 回调来输出剧本期间生成的总列表。 也可以使用 ANSIBLE_DEBUG_BOTOCORE_LOGS 环境变量。 选项 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 之后的版本中删除。
filters 字典	要应用的过滤器字典。每个字典项都包含一个过滤器键和一个过滤器值。有关可能的过滤器，请参阅 https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeVpcPeeringConnections.html。 默认： {}
peer_connection_ids 列表 / 元素=字符串	要获取其详细信息的特定 VPC 对等 ID 的列表。
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 选项互斥。
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 之后的版本中删除。
validate_certs 布尔值	设置为 false 时，与 AWS API 通信时将不验证 SSL 证书。 强烈建议不要设置 validate_certs=false，作为替代方案，请考虑设置 aws_ca_bundle。 选项 false true ← (默认)

注释

注意

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

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

示例

- name: List all EC2 VPC Peering Connections
  amazon.aws.ec2_vpc_peering_info:
    region: ap-southeast-2
  register: all_vpc_peers

- name: Debugging the result
  ansible.builtin.debug:
    msg: "{{ all_vpc_peers.result }}"

- name: Get details on specific EC2 VPC Peering Connection
  amazon.aws.ec2_vpc_peering_info:
    peer_connection_ids:
      - "pcx-12345678"
      - "pcx-87654321"
    region: "ap-southeast-2"
  register: all_vpc_peers

- name: Get all EC2 VPC Peering Connections with specific filters
  amazon.aws.ec2_vpc_peering_info:
    region: "ap-southeast-2"
    filters:
      status-code: ["pending-acceptance"]
  register: pending_vpc_peers

返回值

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

键	描述
结果 列表 / elements=字典	描述的结果。 返回：成功
accepter_vpc_info 字典	有关接受连接的 VPC 的信息。 返回：成功
cidr_block 字符串	VPC 的主要 CIDR。 返回：当连接处于接受状态时。 示例："10.10.10.0/23"
cidr_block_set 列表 / elements=字典	VPC 的所有 CIDR 的列表。 返回：当连接处于接受状态时。
cidr_block 字符串	VPC 使用的 CIDR 块。 返回：成功 示例："10.10.10.0/23"
owner_id 字符串	拥有 VPC 的 AWS 账户。 返回：成功 示例："123456789012"
peering_options 字典	其他对等配置。 返回：当连接处于接受状态时。
allow_dns_resolution_from_remote_vpc 布尔值	指示从对等 VPC 中的实例查询时，VPC 是否可以将公共 DNS 主机名解析为私有 IP 地址。 返回：成功
allow_egress_from_local_classic_link_to_remote_vpc 布尔值	指示本地 ClassicLink 连接是否可以通过 VPC 对等连接与对等 VPC 通信。 返回：成功
allow_egress_from_local_vpc_to_remote_classic_link 布尔值	指示本地 VPC 是否可以通过 VPC 对等连接与对等 VPC 中的 ClassicLink 连接通信。 返回：成功
region 字符串	VPC 所在的 AWS 区域。 返回：成功 示例："us-east-1"
vpc_id 字符串	VPC 的 ID 返回：成功 示例："vpc-0123456789abcdef0"
requester_vpc_info 字典	有关请求连接的 VPC 的信息。 返回：成功
cidr_block 字符串	VPC 的主要 CIDR。 返回：当连接未处于删除状态时。 示例："10.10.10.0/23"
cidr_block_set 列表 / elements=字典	VPC 的所有 CIDR 的列表。 返回：当连接未处于删除状态时。
cidr_block 字符串	VPC 使用的 CIDR 块 返回：成功 示例："10.10.10.0/23"
owner_id 字符串	拥有 VPC 的 AWS 账户。 返回：成功 示例："123456789012"
peering_options 字典	其他对等配置。 返回：当连接未处于删除状态时。
allow_dns_resolution_from_remote_vpc 布尔值	指示从对等 VPC 中的实例查询时，VPC 是否可以将公共 DNS 主机名解析为私有 IP 地址。 返回：成功
allow_egress_from_local_classic_link_to_remote_vpc 布尔值	指示本地 ClassicLink 连接是否可以通过 VPC 对等连接与对等 VPC 通信。 返回：成功
allow_egress_from_local_vpc_to_remote_classic_link 布尔值	指示本地 VPC 是否可以通过 VPC 对等连接与对等 VPC 中的 ClassicLink 连接通信。 返回：成功
region 字符串	VPC 所在的 AWS 区域。 返回：成功 示例："us-east-1"
vpc_id 字符串	VPC 的 ID 返回：成功 示例："vpc-0123456789abcdef0"
status 字典	连接当前状态的详细信息。 返回：成功
code 字符串	描述连接状态的简短代码。 返回：成功 示例："active"
message 字符串	有关连接状态的其他信息。 返回：成功 示例："Pending Acceptance by 123456789012"
tags 字典	应用于连接的标签。 返回：成功
vpc_peering_connection_id 字符串	VPC 对等连接的 ID。 返回：成功 示例："pcx-0123456789abcdef0"
vpc_peering_connections 列表 / elements=字典	匹配的 VPC 对等连接的详细信息。 返回：成功
accepter_vpc_info 字典	有关接受连接的 VPC 的信息。 返回：成功
cidr_block 字符串	VPC 的主要 CIDR。 返回：当连接处于接受状态时。 示例："10.10.10.0/23"
cidr_block_set 列表 / elements=字典	VPC 的所有 CIDR 的列表。 返回：当连接处于接受状态时。
cidr_block 字符串	VPC 使用的 CIDR 块。 返回：成功 示例："10.10.10.0/23"
owner_id 字符串	拥有 VPC 的 AWS 账户。 返回：成功 示例："123456789012"
peering_options 字典	其他对等配置。 返回：当连接处于接受状态时。
allow_dns_resolution_from_remote_vpc 布尔值	指示从对等 VPC 中的实例查询时，VPC 是否可以将公共 DNS 主机名解析为私有 IP 地址。 返回：成功
allow_egress_from_local_classic_link_to_remote_vpc 布尔值	指示本地 ClassicLink 连接是否可以通过 VPC 对等连接与对等 VPC 通信。 返回：成功
allow_egress_from_local_vpc_to_remote_classic_link 布尔值	指示本地 VPC 是否可以通过 VPC 对等连接与对等 VPC 中的 ClassicLink 连接通信。 返回：成功
region 字符串	VPC 所在的 AWS 区域。 返回：成功 示例："us-east-1"
vpc_id 字符串	VPC 的 ID 返回：成功 示例："vpc-0123456789abcdef0"
requester_vpc_info 字典	有关请求连接的 VPC 的信息。 返回：成功
cidr_block 字符串	VPC 的主要 CIDR。 返回：当连接未处于删除状态时。 示例："10.10.10.0/23"
cidr_block_set 列表 / elements=字典	VPC 的所有 CIDR 的列表。 返回：当连接未处于删除状态时。
cidr_block 字符串	VPC 使用的 CIDR 块 返回：成功 示例："10.10.10.0/23"
owner_id 字符串	拥有 VPC 的 AWS 账户。 返回：成功 示例："123456789012"
peering_options 字典	其他对等配置。 返回：当连接未处于删除状态时。
allow_dns_resolution_from_remote_vpc 布尔值	指示从对等 VPC 中的实例查询时，VPC 是否可以将公共 DNS 主机名解析为私有 IP 地址。 返回：成功
allow_egress_from_local_classic_link_to_remote_vpc 布尔值	指示本地 ClassicLink 连接是否可以通过 VPC 对等连接与对等 VPC 通信。 返回：成功
allow_egress_from_local_vpc_to_remote_classic_link 布尔值	指示本地 VPC 是否可以通过 VPC 对等连接与对等 VPC 中的 ClassicLink 连接通信。 返回：成功
region 字符串	VPC 所在的 AWS 区域。 返回：成功 示例："us-east-1"
vpc_id 字符串	VPC 的 ID 返回：成功 示例："vpc-0123456789abcdef0"
status 字典	连接当前状态的详细信息。 返回：成功
code 字符串	描述连接状态的简短代码。 返回：成功 示例："active"
message 字符串	有关连接状态的其他信息。 返回：成功 示例："Pending Acceptance by 123456789012"
tags 字典	应用于连接的标签。 返回：成功
vpc_peering_connection_id 字符串	VPC 对等连接的 ID。 返回：成功 示例："pcx-0123456789abcdef0"

作者

• Karen Cheng (@Etherdaemon)

• Alina Buzachis (@alinabuzachis)

集合链接

• 问题跟踪器
• 存储库（源）
• 通信