amazon.aws.ec2_vpc_endpoint_info 模块 – 使用 AWS 方法检索 AWS VPC 终端节点详细信息

注意

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

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

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

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

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 中找到。

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

字符串

要连接的 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_DescribeVpcEndpoints.html。

默认值： {}

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 保持一致，aws_secret_access_key 别名已在 5.1.0 版本中添加。

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 ← (默认)

vpc_endpoint_ids

list / elements=string

要检索其详细信息的特定终端节点的 ID。

注意

注意

  • query 参数的支持已在 6.0.0 版本中删除。此模块现在仅查询终端节点。有关终端节点服务的信息可以使用 amazon.aws.ec2_vpc_endpoint_service_info 模块检索。

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

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

示例

# Simple example of listing all support AWS services for VPC endpoints
- name: Get all endpoints in ap-southeast-2 region
  amazon.aws.ec2_vpc_endpoint_info:
    region: ap-southeast-2
  register: existing_endpoints

- name: Get all endpoints with specific filters
  amazon.aws.ec2_vpc_endpoint_info:
    region: ap-southeast-2
    filters:
      vpc-id:
        - vpc-12345678
        - vpc-87654321
      vpc-endpoint-state:
        - available
        - pending
  register: existing_endpoints

- name: Get details on specific endpoint
  amazon.aws.ec2_vpc_endpoint_info:
    region: ap-southeast-2
    vpc_endpoint_ids:
      - vpce-12345678
  register: endpoint_details

返回值

常用返回值记录在这里，以下是此模块独有的字段

键

描述

vpc_endpoints

list / elements=dictionary

匹配的终端节点列表。

返回: 总是

示例: {"vpc_endpoints": [{"creation_timestamp": "2017-02-16T11:06:48+00:00", "policy_document": "\"{\\\"Version\\\":\\\"2012-10-17\\\",\\\"Id\\\":\\\"Policy1450910922815\\\", \\\"Statement\\\":[{\\\"Sid\\\":\\\"Stmt1450910920641\\\",\\\"Effect\\\":\\\"Allow\\\", \\\"Principal\\\":\\\"*\\\",\\\"Action\\\":\\\"s3:*\\\",\\\"Resource\\\":[\\\"arn:aws:s3:::*/*\\\",\\\"arn:aws:s3:::*\\\"]}]}\"\n", "route_table_ids": ["rtb-abcd1234"], "service_name": "com.amazonaws.ap-southeast-2.s3", "state": "available", "vpc_endpoint_id": "vpce-abbad0d0", "vpc_id": "vpc-1111ffff"}]}

creation_timestamp

字符串

创建终端节点的日期和时间。

返回: 总是

dns_entries

list / elements=dictionary

终端节点的 DNS 条目列表。

返回: 总是

dns_name

字符串

DNS 名称。

返回: 总是

hosted_zone_id

字符串

私有托管区域的 ID。

返回: 成功

groups

list / elements=dictionary

与网络接口关联的安全组列表。

返回: 总是

group_id

字符串

安全组的 ID。

返回: 总是

group_name

字符串

安全组的名称。

返回: 总是

ip_address_type

字符串

终端节点的 IP 地址类型。

返回: 成功

network_interface_ids

list / elements=string

终端节点的网络接口列表。

返回: 总是

owner_id

字符串

拥有终端节点的 AWS 账户的 ID。

返回: 总是

policy_document

字符串

与终端节点关联的策略文档。

返回: 总是

private_dns_enabled

布尔值

指示 VPC 是否与私有托管区域关联。

返回: 总是

requester_managed

布尔值

指示终端节点是否由其服务管理。

返回: 总是

route_table_ids

list / elements=string

与终端节点关联的路由表 ID 列表。

返回: 总是

service_name

字符串

终端节点关联的服务名称。

返回: 总是

state

字符串

终端节点的状态。

返回: 总是

subnet_ids

list / elements=string

与终端节点关联的子网列表。

返回: 总是

tags

list / elements=dictionary

与终端节点关联的标签列表。

返回: 总是

vpc_endpoint_id

字符串

终端节点的 ID。

返回: 总是

vpc_endpoint_type

字符串

终端节点的类型。

返回: 总是

vpc_id

字符串

VPC 的 ID。

返回: 总是

作者

  • Karen Cheng (@Etherdaemon)