amazon.aws.ec2_vpc_endpoint_service_info 模块 – 获取 AWS VPC 端点服务详情

注意

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

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

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

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

amazon.aws 1.5.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

字符串

连接到非默认 AWS 端点的 URL。虽然这可以用于连接到其他与 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_DescribeVpcEndpointServices.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 保持一致，在 5.1.0 版本中添加了 aws_secret_access_key 别名。

已弃用 ec2_secret_key 别名，它将在 2024-12-01 之后的一个版本中移除。

已弃用对 EC2_SECRET_KEY 环境变量的支持，它将在 2024-12-01 之后的一个版本中移除。

service_names

列表 / 元素=字符串

可用于缩小搜索结果的服务名称列表。

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 选项互斥。

在 3.2.0 版本中添加了 aws_session_token 和 session_token 别名，在 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。

示例

# Simple example of listing all supported AWS services for VPC endpoints
- name: List supported AWS endpoint services
  amazon.aws.ec2_vpc_endpoint_service_info:
    region: ap-southeast-2
  register: supported_endpoint_services

返回值

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

键

描述

service_details

复杂

有关 AWS VPC 端点服务的详细信息。

返回：成功

acceptance_required

布尔值

VPC 端点连接请求是否必须由服务所有者接受。

返回：成功

availability_zones

列表 / 元素=字符串

服务可用的可用区。

返回：成功

base_endpoint_dns_names

列表 / 元素=字符串

服务的 DNS 名称。

返回：成功

manages_vpc_endpoints

布尔值

服务是否管理其 VPC 端点。

返回：成功

owner

字符串

服务所有者的 AWS 账户 ID。

返回：成功

private_dns_name

字符串

服务的私有 DNS 名称。

返回：成功

private_dns_name_verification_state

字符串

VPC 端点服务的验证状态。

当状态不是 verified 时，端点服务的使用者无法使用私有名称。

返回：成功

private_dns_names

列表 / 元素=字符串

分配给 VPC 端点服务的私有 DNS 名称。

返回：成功

service_id

字符串

端点服务的 ID。

返回：成功

service_name

字符串

端点服务的 ARN。

返回：成功

service_type

列表 / 元素=字符串

服务的类型

返回：成功

supported_ip_address_types

字符串

支持的 IP 地址类型。

返回：成功

tags

字典

与服务关联的标签字典

返回：成功

vpc_endpoint_policy_supported

布尔值

服务是否支持端点策略。

返回：成功

service_names

列表 / 元素=字符串

支持的 AWS VPC 端点服务名称列表。

返回：成功

示例： {"service_names": ["com.amazonaws.ap-southeast-2.s3"]}

作者

  • Mark Chappell (@tremble)