amazon.aws.ec2_vpc_peering 模块 – 创建、删除、接受和拒绝两个 VPC 之间的 VPC 对等连接。

注意

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

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

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

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

community.aws 1.0.0 中的新增功能

摘要

• 阅读 AWS 关于 VPC 对等连接的文档 https://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/vpc-peering.html。

别名：ec2_vpc_peer

要求

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

• 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 回调将输出到 playbook 期间进行的全部列表。 也可以使用 ANSIBLE_DEBUG_BOTOCORE_LOGS 环境变量。 选项 false ← (默认) true
endpoint_url 别名：ec2_url, aws_endpoint_url, s3_url 字符串	连接到非默认 AWS 端点的 URL。虽然这可以用于连接到其他与 AWS 兼容的服务，但 amazon.aws 和 community.aws 集合仅针对 AWS 进行测试。 也可以按优先级递减的顺序使用 AWS_URL 或 EC2_URL 环境变量。 ec2_url 和 s3_url 别名已被弃用，将在 2024-12-01 之后的一个版本中删除。 EC2_URL 环境变量的支持已被弃用，将在 2024-12-01 之后的一个版本中删除。
peer_owner_id 字符串	跨账户对等连接的 AWS 账户号码。
peer_region 字符串	接受 VPC 的区域。
peer_vpc_id 字符串	接受 VPC 的 VPC ID。
peering_id 字符串	对等连接 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 选项是互斥的。
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) 字符串	创建、删除、接受、拒绝对等连接。 选项 "present" ← (默认) "absent" "accept" "reject"
标签 (tags) 别名: resource_tags 字典	表示要应用于资源的标签的字典。 如果未设置tags参数，则不会修改标签。
验证证书 (validate_certs) 布尔值	设置为false时，不会验证与AWS API通信的SSL证书。 强烈建议不要设置validate_certs=false，作为替代方案，请考虑设置aws_ca_bundle。 选项 false true ← (默认)
VPC ID (vpc_id) 字符串	请求VPC的VPC ID。
等待 (wait) 布尔值	等待对等状态更改完成。 选项 false ← (默认) true

注释

注意

• 在2.0.0版本中添加了对purge_tags的支持。

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

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

示例

# Complete example to create and accept a local peering connection.
- name: Create local account EC2 VPC Peering Connection
  amazon.aws.ec2_vpc_peering:
    region: "ap-southeast-2"
    vpc_id: "vpc-12345678"
    peer_vpc_id: "vpc-87654321"
    state: "present"
    tags:
      Name: "Peering connection for VPC 21 to VPC 22"
      CostCode: "CC1234"
      Project: "phoenix"
  register: vpc_peer

- name: Accept local EC2 VPC Peering request
  amazon.aws.ec2_vpc_peering:
    region: "ap-southeast-2"
    peering_id: "{{ vpc_peer.peering_id }}"
    state: "accept"
  register: action_peer

# Complete example to delete a local peering connection.
- name: Create local account EC2 VPC Peering Connection
  amazon.aws.ec2_vpc_peering:
    region: "ap-southeast-2"
    vpc_id: "vpc-12345678"
    peer_vpc_id: "vpc-87654321"
    state: "present"
    tags:
      Name: "Peering connection for VPC 21 to VPC 22"
      CostCode: "CC1234"
      Project: "phoenix"
  register: vpc_peer

- name: Delete a local EC2 VPC Peering Connection
  amazon.aws.ec2_vpc_peering:
    region: "ap-southeast-2"
    peering_id: "{{ vpc_peer.peering_id }}"
    state: "absent"
  register: vpc_peer

  # Complete example to create and accept a cross account peering connection.
- name: Create cross account EC2 VPC Peering Connection
  amazon.aws.ec2_vpc_peering:
    region: "ap-southeast-2"
    vpc_id: "vpc-12345678"
    peer_vpc_id: "vpc-12345678"
    peer_owner_id: "123456789012"
    state: "present"
    tags:
      Name: "Peering connection for VPC 21 to VPC 22"
      CostCode: "CC1234"
      Project: "phoenix"
  register: vpc_peer

- name: Accept EC2 VPC Peering Connection from remote account
  amazon.aws.ec2_vpc_peering:
    region: "ap-southeast-2"
    peering_id: "{{ vpc_peer.peering_id }}"
    profile: "bot03_profile_for_cross_account"
    state: "accept"
  register: vpc_peer

# Complete example to create and accept an intra-region peering connection.
- name: Create intra-region EC2 VPC Peering Connection
  amazon.aws.ec2_vpc_peering:
    region: "us-east-1"
    vpc_id: "vpc-12345678"
    peer_vpc_id: "vpc-87654321"
    peer_region: "us-west-2"
    state: "present"
    tags:
      Name: "Peering connection for us-east-1 VPC to us-west-2 VPC"
      CostCode: "CC1234"
      Project: "phoenix"
  register: vpc_peer

- name: Accept EC2 VPC Peering Connection from peer region
  amazon.aws.ec2_vpc_peer:
    region: "us-west-2"
    peering_id: "{{ vpc_peer.peering_id }}"
    state: "accept"
  register: vpc_peer

# Complete example to create and reject a local peering connection.
- name: Create local account EC2 VPC Peering Connection
  amazon.aws.ec2_vpc_peering:
    region: "ap-southeast-2"
    vpc_id: "vpc-12345678"
    peer_vpc_id: "vpc-87654321"
    state: "present"
    tags:
      Name: "Peering connection for VPC 21 to VPC 22"
      CostCode: "CC1234"
      Project: "phoenix"
  register: vpc_peer

- name: Reject a local EC2 VPC Peering Connection
  amazon.aws.ec2_vpc_peering:
    region: "ap-southeast-2"
    peering_id: "{{ vpc_peer.peering_id }}"
    state: "reject"

# Complete example to create and accept a cross account peering connection.
- name: Create cross account EC2 VPC Peering Connection
  amazon.aws.ec2_vpc_peering:
    region: "ap-southeast-2"
    vpc_id: "vpc-12345678"
    peer_vpc_id: "vpc-12345678"
    peer_owner_id: "123456789012"
    state: "present"
    tags:
      Name: "Peering connection for VPC 21 to VPC 22"
      CostCode: "CC1234"
      Project: "phoenix"
  register: vpc_peer

- name: Accept a cross account EC2 VPC Peering Connection request
  amazon.aws.ec2_vpc_peering:
    region: "ap-southeast-2"
    peering_id: "{{ vpc_peer.peering_id }}"
    profile: "bot03_profile_for_cross_account"
    state: "accept"
    tags:
      Name: "Peering connection for VPC 21 to VPC 22"
      CostCode: "CC1234"
      Project: "phoenix"

# Complete example to create and reject a cross account peering connection.
- name: Create cross account EC2 VPC Peering Connection
  amazon.aws.ec2_vpc_peering:
    region: "ap-southeast-2"
    vpc_id: "vpc-12345678"
    peer_vpc_id: "vpc-12345678"
    peer_owner_id: "123456789012"
    state: "present"
    tags:
      Name: "Peering connection for VPC 21 to VPC 22"
      CostCode: "CC1234"
      Project: "phoenix"
  register: vpc_peer

- name: Reject a cross account EC2 VPC Peering Connection
  amazon.aws.ec2_vpc_peeriing:
    region: "ap-southeast-2"
    peering_id: "{{ vpc_peer.peering_id }}"
    profile: "bot03_profile_for_cross_account"
    state: "reject"

返回值

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

键 (Key)	描述
peering_id 字符串	创建/删除的VPC对等连接的ID。 返回：始终 示例："pcx-034223d7c0aec3cde"
VPC对等连接 (vpc_peering_connection) 字典	VPC对等连接的详细信息。 返回：成功
接受者VPC信息 (accepter_vpc_info) 字典	关于接受连接的VPC的信息。 返回：成功
CIDR块 (cidr_block) 字符串	VPC的主CIDR。 返回：连接处于已接受状态时。 示例："10.10.10.0/23"
CIDR块集 (cidr_block_set) 列表 / 元素=字典	VPC的所有CIDR的列表。 返回：连接处于已接受状态时。
CIDR块 (cidr_block) 字符串	VPC使用的CIDR块。 返回：成功 示例："10.10.10.0/23"
所有者ID (owner_id) 字符串	拥有VPC的AWS账户。 返回：成功 示例："123456789012"
对等选项 (peering_options) 字典	其他对等配置。 返回：连接处于已接受状态时。
允许从远程VPC解析DNS (allow_dns_resolution_from_remote_vpc) 布尔值	指示从对等VPC中的实例查询时，VPC是否可以将公共DNS主机名解析为私有IP地址。 返回：成功
允许从本地经典链接到远程VPC的出站流量 (allow_egress_from_local_classic_link_to_remote_vpc) 布尔值	指示本地ClassicLink连接是否可以通过VPC对等连接与对等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的ID 返回：成功 示例："vpc-0123456789abcdef0"
过期时间 (expiration_time) 字符串	未接受的VPC对等连接将过期的截止时间。 返回：成功 示例："2024-10-01T12:11:12+00:00"
请求者VPC信息 (requester_vpc_info) 字典	关于请求连接的VPC的信息。 返回：成功
CIDR块 (cidr_block) 字符串	VPC的主CIDR。 返回：连接未处于已删除状态时。 示例："10.10.10.0/23"
CIDR块集 (cidr_block_set) 列表 / 元素=字典	VPC的所有CIDR的列表。 返回：连接未处于已删除状态时。
CIDR块 (cidr_block) 字符串	VPC使用的CIDR块 返回：成功 示例："10.10.10.0/23"
所有者ID (owner_id) 字符串	拥有VPC的AWS账户。 返回：成功 示例："123456789012"
对等选项 (peering_options) 字典	其他对等配置。 返回：连接未处于已删除状态时。
允许从远程VPC解析DNS (allow_dns_resolution_from_remote_vpc) 布尔值	指示从对等VPC中的实例查询时，VPC是否可以将公共DNS主机名解析为私有IP地址。 返回：成功
允许从本地经典链接到远程VPC的出站流量 (allow_egress_from_local_classic_link_to_remote_vpc) 布尔值	指示本地ClassicLink连接是否可以通过VPC对等连接与对等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的ID 返回：成功 示例："vpc-0123456789abcdef0"
状态 (status) 复杂 (complex)	连接当前状态的详细信息。 返回：成功
代码 (code) 字符串	简短代码，描述连接的状态。 返回：成功 示例："active"
消息 (message) 字符串	关于连接状态的其他信息。 返回：成功 示例："Pending Acceptance by 123456789012"
标签 (tags) 字典	应用于连接的标签。 返回：成功
VPC对等连接ID (vpc_peering_connection_id) 字符串	VPC对等连接的ID。 返回：成功 示例："pcx-0123456789abcdef0"

作者

• Mike Mochan (@mmochan)

• Alina Buzachis (@alinabuzachis)

集合链接

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