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

注意

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

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

要安装它,请使用:ansible-galaxy collection install amazon.aws。要使用此模块,您需要满足其他要求,请参阅 Requirements 获取详细信息。

要在剧本中使用它,请指定: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_IDAWS_ACCESS_KEYEC2_ACCESS_KEY 环境变量。

aws_access_keyprofile 选项是互斥的。

为与 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 回调将输出到在剧本期间执行的总列表。

还可以使用 ANSIBLE_DEBUG_BOTOCORE_LOGS 环境变量。

选项

  • false ← (默认)

  • true

endpoint_url

别名:ec2_url、aws_endpoint_url、s3_url

字符串

连接到的 URL,而不是默认的 AWS 端点。虽然这可以用于连接到其他与 AWS 兼容的服务,但 amazon.aws 和 community.aws 集合仅针对 AWS 进行测试。

还可以按优先级递减的顺序使用 AWS_URLEC2_URL 环境变量。

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

region

别名:aws_region、ec2_region

字符串

要使用的 AWS 区域。

对于诸如 IAM、Route53 和 CloudFront 之类的全球服务,将忽略 region

也可以使用AWS_REGIONEC2_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_KEYAWS_SECRET_KEYEC2_SECRET_KEY环境变量,优先级依次递减。

secret_keyprofile 选项互斥。

为与 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_TOKENAWS_SECURITY_TOKENEC2_SECURITY_TOKEN环境变量,优先级依次递减。

security_tokenprofile 选项互斥。

别名 aws_session_tokensession_token 在 3.2.0 版本中添加,参数名称在 6.0.0 版本中从 security_token 重命名为 session_token

security_tokenaws_security_tokenaccess_token 别名已弃用,将于2024-12-01之后的发行版中移除。

EC2_SECRET_KEYAWS_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_change_sets

列表 / 元素=字符串

堆栈更改集列表。列表中的每个项目都表示特定更改集的详细信息。

返回:只有当all_factsstack_policytrue且堆栈存在时

stack_description

字典

关于堆栈的摘要信息。

返回:如果堆栈存在

capabilities

列表 / 元素=字符串

堆栈中允许的功能。

返回:始终

creation_time

字符串

创建堆栈的时间。

返回:如果堆栈存在

deletion_time

字符串

删除堆栈的时间。

返回:如果堆栈已删除

description

字符串

与堆栈关联的用户定义描述。

返回:始终

disable_rollback

布尔值

是否启用堆栈创建失败时的回滚。

返回:始终

drift_information

字典

关于堆栈的实际配置是否与预期配置(在堆栈模板和任何指定为模板参数的值中定义)不同的信息,即是否发生漂移。

返回:始终

last_check_timestamp

字符串

最近一次在堆栈或其任何支持漂移检测的单个资源上启动漂移检测操作的时间。

返回:如果检测到漂移

stack_drift_status

字符串

堆栈的实际配置与其预期模板配置相比的状态。

返回:始终

enable_termination_protection

布尔值

是否为堆栈启用了终止保护。

返回:始终

notification_arns

列表 / 元素=字符串

发布堆栈相关事件的 Amazon SNS 主题 ARN。

返回:始终

outputs

列表 / 元素=字典

输出字典列表。

返回:始终

output_key

字符串

与输出关联的键。

返回:始终

output_value

字符串

与输出关联的值。

返回:始终

parameters

列表 / 元素=字典

参数字典列表。

返回:始终

parameter_key

字符串

与参数关联的键。

返回:始终

parameter_value

字符串

与参数关联的值。

返回:始终

rollback_configuration

字典

CloudFormation 在堆栈创建和更新操作期间监视的回滚触发器。

返回:始终

rollback_triggers

列表 / 元素=字典

在堆栈创建或更新操作期间监视的触发器。

返回:当存在回滚触发器时

arn

字符串

回滚触发器的 ARN。

返回:始终

type

字符串

回滚触发器的资源类型。

返回:始终

stack_id

字符串

堆栈的唯一 ID。

返回:始终

stack_name

字符串

堆栈的名称。

返回:始终

stack_status

字符串

堆栈的状态。

返回:始终

tags

列表 / 元素=字典

与堆栈关联的标签列表。

返回:始终

key

字符串

标签的键。

返回:始终

value

字符串

标签的值。

返回:始终

stack_events

列表 / 元素=字符串

堆栈的所有事件。

返回:只有当all_factsstack_eventstrue且堆栈存在时

stack_outputs

字典

堆栈输出的字典,以每个输出“OutputKey”参数的值为键,以及每个输出“OutputValue”参数的相应值为值。

返回:如果堆栈存在

示例:{"ApplicationDatabaseName": "dazvlpr01xj55a.ap-southeast-2.rds.amazonaws.com"}

stack_parameters

字典

堆栈参数的字典,以每个参数“ParameterKey”参数的值为键,以及每个参数“ParameterValue”参数的相应值为值。

返回:如果堆栈存在

示例:{"DatabaseEngine": "mysql", "DatabasePassword": "***"}

stack_policy

字典

描述堆栈的策略。

返回:只有当all_factsstack_policytrue且堆栈存在时

stack_resource_list

列表 / 元素=字符串

描述堆栈的资源。

返回:只有当all_factsstack_policytrue且堆栈存在时

stack_resources

字典

堆栈资源的字典,以每个资源“LogicalResourceId”参数的值为键,以及每个资源“PhysicalResourceId”参数的相应值为值。

返回:只有当all_factsstack_policytrue且堆栈存在时

示例:{"ApplicationDatabase": "dazvlpr01xj55a", "AutoScalingGroup": "dev-someapp-AutoscalingGroup-1SKEXXBCAN0S7", "AutoScalingSecurityGroup": "sg-abcd1234"}

stack_tags

字典

键值对标签的字典。

返回:只有当all_factsstack_policytrue且堆栈存在时

示例:{"TagOne": "ValueOne", "TagTwo": "ValueTwo"}

stack_template

字典

描述堆栈的模板。

返回:只有当all_factsstack_policytrue且堆栈存在时

作者

  • Justin Menga (@jmenga)

  • Kevin Coming (@waffie1)