community.aws.cloudfront_distribution_info 模块 – 获取有关 AWS CloudFront 分布的事实信息

注意

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

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

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

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

community.aws 1.0.0 中的新增功能

概要 

获取有关 AWS CloudFront 分布的信息。
在 5.0.0 版本之前，此模块称为 community.aws.cloudfront_info。用法没有改变。

别名：cloudfront_info

要求 

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

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 之后的一个版本中删除。
all_lists 布尔值	获取所有不需要参数的 CloudFront 列表。选项 `false` ← (默认) `true`
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`
distribution 布尔值	获取有关分布的信息。需要指定 distribution_id 或 domain_name_alias。选项 `false` ← (默认) `true`
distribution_config 布尔值	获取有关分布的配置信息。需要指定 distribution_id 或 domain_name_alias。选项 `false` ← (默认) `true`
distribution_id 字符串	CloudFront 分布的 ID。与 distribution、distribution_config、invalidation、streaming_distribution、streaming_distribution_config、list_invalidations 一起使用。
domain_name_alias 字符串	可以代替 distribution_id 使用 - 使用 CloudFront 分布的别名 CNAME 获取所需分布的 ID。
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 之后的一个版本中移除。
invalidation 布尔值	获取有关失效的信息。需要指定 invalidation_id。选项 `false` ← (默认) `true`
invalidation_id 字符串	要获取信息的失效 ID。与 invalidation 一起使用。
list_distributions 布尔值	获取 CloudFront 分布列表。选项 `false` ← (默认) `true`
list_distributions_by_web_acl_id 布尔值	使用 web acl id 作为过滤器获取分布列表。需要设置 web_acl_id。选项 `false` ← (默认) `true`
list_invalidations 布尔值	获取失效列表。需要指定 distribution_id 或 domain_name_alias。选项 `false` ← (默认) `true`
list_origin_access_identities 布尔值	获取 CloudFront 源访问标识列表。需要设置 origin_access_identity_id。选项 `false` ← (默认) `true`
list_streaming_distributions 布尔值	获取流式分布列表。选项 `false` ← (默认) `true`
origin_access_identity 布尔值	获取有关源访问标识的信息。需要指定 origin_access_identity_id。选项 `false` ← (默认) `true`
origin_access_identity_config 布尔值	获取有关源访问标识的配置信息。需要指定 origin_access_identity_id。选项 `false` ← (默认) `true`
origin_access_identity_id 字符串	要获取信息的 CloudFront 源访问标识的 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 选项互斥。在 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 之后的一个版本中移除。
streaming_distribution 布尔值	获取有关指定 RTMP 分布的信息。需要指定 distribution_id 或 domain_name_alias。选项 `false` ← (默认) `true`
streaming_distribution_config 布尔值	获取有关指定 RTMP 分布的配置信息。需要指定 distribution_id 或 domain_name_alias。选项 `false` ← (默认) `true`
summary 布尔值	返回所有分布、流式分布和 origin_access_identities 的摘要。如果未选择任何选项，则这是默认行为。选项 `false` ← (默认) `true`
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。

示例 

# Note: These examples do not set authentication details, see the AWS Guide for details.

- name: Get a summary of distributions
  community.aws.cloudfront_distribution_info:
    summary: true
  register: result

- name: Get information about a distribution
  community.aws.cloudfront_distribution_info:
    distribution: true
    distribution_id: my-cloudfront-distribution-id
  register: result_did
- ansible.builtin.debug:
    msg: "{{ result_did['cloudfront']['my-cloudfront-distribution-id'] }}"

- name: Get information about a distribution using the CNAME of the cloudfront distribution.
  community.aws.cloudfront_distribution_info:
    distribution: true
    domain_name_alias: www.my-website.com
  register: result_website
- ansible.builtin.debug:
    msg: "{{ result_website['cloudfront']['www.my-website.com'] }}"

- name: Get all information about an invalidation for a distribution.
  community.aws.cloudfront_distribution_info:
    invalidation: true
    distribution_id: my-cloudfront-distribution-id
    invalidation_id: my-cloudfront-invalidation-id

- name: Get all information about a CloudFront origin access identity.
  community.aws.cloudfront_distribution_info:
    origin_access_identity: true
    origin_access_identity_id: my-cloudfront-origin-access-identity-id

- name: Get all information about lists not requiring parameters (ie. list_origin_access_identities, list_distributions, list_streaming_distributions)
  community.aws.cloudfront_distribution_info:
    origin_access_identity: true
    origin_access_identity_id: my-cloudfront-origin-access-identity-id

- name: Get all information about lists not requiring parameters (ie. list_origin_access_identities, list_distributions, list_streaming_distributions)
  community.aws.cloudfront_distribution_info:
    all_lists: true

返回值 

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

Key	描述
distribution 字典	有关 CloudFront 分布的事实。需要指定 distribution_id 或 domain_name_alias。需要设置 origin_access_identity_id。返回：仅当 distribution 为 true 时
distribution_config 字典	有关 CloudFront 分布配置的事实。需要指定 distribution_id 或 domain_name_alias。返回：仅当 distribution_config 为 true 时
invalidation 字典	描述分布的失效信息。需要指定 invalidation_id 以及 distribution_id 或 domain_name_alias。返回：仅当 invalidation 为 true 时
origin_access_identity 字典	描述源访问标识信息。需要设置 origin_access_identity_id。返回：仅当 origin_access_identity 为 true 时
origin_access_identity_configuration 字典	描述源访问标识信息配置信息。需要设置 origin_access_identity_id。返回：仅当 origin_access_identity_configuration 为 true 时
result 字典	结果字典未嵌套在 CloudFront ID 下，以便在不知道该 ID 的情况下访问模块的结果，因为确定 DistributionId 通常是使用此模块的原因。返回：始终返回
streaming_distribution 字典	描述分布的流式信息。需要指定 distribution_id 或 domain_name_alias。返回：仅当 streaming_distribution 为 true 时
streaming_distribution_config 字典	描述分布的流式配置信息。需要指定 distribution_id 或 domain_name_alias。返回：仅当 streaming_distribution_config 为 true 时
summary 字典	提供分布、流式分布和源访问标识的摘要。返回：作为默认值或如果 summary 为 true 时

作者

Willem van Ketwich (@wilvk)