amazon.aws.cloudformation_info 模块 – 获取有关 AWS CloudFormation 堆栈的信息

注意

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

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

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

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

amazon.aws 1.0.0 中的新增功能

概要

• 获取有关 AWS CloudFormation 堆栈的信息。

要求

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

• 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_facts 布尔值	获取堆栈的所有堆栈信息。 选项 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 回调输出到 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 之后的版本中删除。
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 之后的版本中删除。
stack_change_sets 布尔值	获取堆栈的堆栈更改集 选项 false ←（默认） true
stack_events 布尔值	获取堆栈的堆栈事件。 选项 false ←（默认） true
stack_name 字符串	CloudFormation 堆栈的名称或 ID。默认情况下收集有关所有堆栈的信息。
stack_policy 布尔值	获取堆栈的堆栈策略。 选项 false ←（默认） true
stack_resources 布尔值	获取堆栈的堆栈资源。 选项 false ←（默认） true
stack_template 布尔值	获取堆栈的堆栈模板主体。 选项 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 information on all stacks
  amazon.aws.cloudformation_info:
  register: all_stacks_output

- name: Get summary information about a stack
  amazon.aws.cloudformation_info:
    stack_name: my-cloudformation-stack
  register: output

- debug:
    msg: "{{ output['cloudformation']['my-cloudformation-stack'] }}"

# Get stack outputs, when you have the stack name available as a fact
- set_fact:
    stack_name: my-awesome-stack

- amazon.aws.cloudformation_info:
    stack_name: "{{ stack_name }}"
  register: my_stack

- debug:
    msg: "{{ my_stack.cloudformation[stack_name].stack_outputs }}"

# Get all stack information about a stack
- amazon.aws.cloudformation_info:
    stack_name: my-cloudformation-stack
    all_facts: true

# Get stack resource and stack policy information about a stack
- amazon.aws.cloudformation_info:
    stack_name: my-cloudformation-stack
    stack_resources: true
    stack_policy: true

# Fail if the stack doesn't exist
- name: try to get info about a stack but fail if it doesn't exist
  amazon.aws.cloudformation_info:
    stack_name: nonexistent-stack
    all_facts: true
  failed_when: cloudformation['nonexistent-stack'] is undefined

返回值

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

键	描述
cloudformation 字典	包含堆栈信息的字典的字典。 键是 stack_name(s)。 返回： 总是
stack_change_sets list / elements=string	堆栈更改集列表。列表中的每一项都表示特定更改集的详细信息。 返回： 仅当 all_facts 或 stack_policy 为 true 且堆栈存在时
stack_description 字典	有关堆栈的摘要信息。 返回： 如果堆栈存在
capabilities list / elements=string	堆栈中允许的功能。 返回： 总是
creation_time 字符串	创建堆栈的时间。 返回： 如果堆栈存在
deletion_time 字符串	删除堆栈的时间。 返回： 如果堆栈已删除
description 字符串	与堆栈关联的用户定义的描述。 返回： 总是
disable_rollback 布尔值	是否启用在堆栈创建失败时回滚。 返回： 总是
drift_information 字典	有关堆栈的实际配置是否与预期配置（在堆栈模板中定义以及指定为模板参数的任何值）不同或已漂移的信息。 返回： 总是
last_check_timestamp 字符串	最近一次在堆栈或任何支持漂移检测的单个资源上启动漂移检测操作的时间。 返回： 如果检测到漂移
stack_drift_status 字符串	堆栈的实际配置与其预期的模板配置相比的状态。 返回： 总是
enable_termination_protection 布尔值	是否为堆栈启用了终止保护。 返回： 总是
notification_arns list / elements=string	发布与堆栈相关事件的 Amazon SNS 主题 ARN。 返回： 总是
outputs list / elements=dictionary	输出字典的列表。 返回： 总是
output_key 字符串	与输出关联的键。 返回： 总是
output_value 字符串	与输出关联的值。 返回： 总是
parameters list / elements=dictionary	参数字典的列表。 返回： 总是
parameter_key 字符串	与参数关联的键。 返回： 总是
parameter_value 字符串	与参数关联的值。 返回： 总是
rollback_configuration 字典	CloudFormation 在堆栈创建和更新操作期间监视的回滚触发器。 返回： 总是
rollback_triggers list / elements=dictionary	在堆栈创建或更新操作期间监视的触发器。 返回： 当回滚触发器存在时
arn 字符串	回滚触发器的 ARN。 返回： 总是
type 字符串	回滚触发器的资源类型。 返回： 总是
stack_id 字符串	堆栈的唯一 ID。 返回： 总是
stack_name 字符串	堆栈的名称。 返回： 总是
stack_status 字符串	堆栈的状态。 返回： 总是
tags list / elements=dictionary	与堆栈关联的标签列表。 返回： 总是
key 字符串	标签的键。 返回： 总是
value 字符串	标签的值。 返回： 总是
stack_events list / elements=string	堆栈的所有堆栈事件。 返回： 仅当 all_facts 或 stack_events 为 true 且堆栈存在时
stack_outputs 字典	堆栈输出字典，键是每个输出的“OutputKey”参数值，值是每个输出的“OutputValue”参数值。 返回： 如果堆栈存在 示例： {"ApplicationDatabaseName": "dazvlpr01xj55a.ap-southeast-2.rds.amazonaws.com"}
stack_parameters 字典	堆栈参数字典，键是每个参数的“ParameterKey”参数值，值是每个参数的“ParameterValue”参数值。 返回： 如果堆栈存在 示例： {"DatabaseEngine": "mysql", "DatabasePassword": "***"}
stack_policy 字典	描述堆栈的堆栈策略。 返回： 仅当 all_facts 或 stack_policy 为 true 且堆栈存在时
stack_resource_list list / elements=string	描述堆栈的堆栈资源。 返回： 仅当 all_facts 或 stack_policy 为 true 且堆栈存在时
stack_resources 字典	堆栈资源字典，键是每个资源的“LogicalResourceId”参数值，值是每个资源的“PhysicalResourceId”参数值。 返回： 仅当 all_facts 或 stack_policy 为 true 且堆栈存在时 示例: {"ApplicationDatabase": "dazvlpr01xj55a", "AutoScalingGroup": "dev-someapp-AutoscalingGroup-1SKEXXBCAN0S7", "AutoScalingSecurityGroup": "sg-abcd1234"}
stack_tags 字典	标签的键值对字典。 返回： 仅当 all_facts 或 stack_policy 为 true 且堆栈存在时 示例: {"TagOne": "ValueOne", "TagTwo": "ValueTwo"}
stack_template 字典	描述堆栈的堆栈模板。 返回： 仅当 all_facts 或 stack_policy 为 true 且堆栈存在时

作者

• Justin Menga (@jmenga)

• Kevin Coming (@waffie1)

集合链接

• 问题跟踪器
• 存储库（源代码）
• 沟通