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
参数
参数 |
注释 |
---|---|
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 和 profile 选项是互斥的。 为与 AWS botocore SDK 保持一致,在 5.1.0 版本中添加了 aws_access_key_id 别名。 ec2_access_key 别名已弃用,将在 2024-12-01 之后的一个版本中删除。
|
|
获取堆栈的所有堆栈信息。 选项
|
|
验证 SSL 证书时使用的 CA 捆绑包的位置。 还可以使用 |
|
用于修改 botocore 配置的字典。 可以在 AWS 文档中找到参数 https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config。 |
|
使用 还可以使用 选项
|
|
连接到的 URL,而不是默认的 AWS 端点。虽然这可以用于连接到其他与 AWS 兼容的服务,但 amazon.aws 和 community.aws 集合仅针对 AWS 进行测试。 还可以按优先级递减的顺序使用 ec2_url 和 s3_url 别名已弃用,将在 2024-12-01 之后的一个版本中删除。
|
|
用于身份验证的命名 AWS 配置文件。 有关命名配置文件的更多信息,请参见 AWS 文档 https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html。 还可以使用 profile 选项与 aws_access_key、aws_secret_key 和 security_token 选项互斥。 |
|
要使用的 AWS 区域。 对于诸如 IAM、Route53 和 CloudFront 之类的全球服务,将忽略 region。 也可以使用 更多信息请参见 Amazon AWS 文档 http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region。
对 |
|
AWS 密钥访问密钥。 有关访问令牌的更多信息,请参见 AWS 文档 https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys。 也可以使用 secret_key 和 profile 选项互斥。 为与 AWS botocore SDK 保持一致,aws_secret_access_key 别名在 5.1.0 版本中添加。 ec2_secret_key 别名已弃用,将于2024-12-01之后的发行版中移除。 对 |
|
用于临时凭证的 AWS STS 会话令牌。 有关访问令牌的更多信息,请参见 AWS 文档 https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys。 也可以使用 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之后的发行版中移除。 对 |
|
获取堆栈的更改集。 选项
|
|
获取堆栈的事件。 选项
|
|
CloudFormation 堆栈的名称或 ID。默认情况下会收集所有堆栈的信息。 |
|
获取堆栈的策略。 选项
|
|
获取堆栈的资源。 选项
|
|
获取堆栈的模板正文。 选项
|
|
设置为 强烈建议不要设置validate_certs=false,作为替代方案,请考虑设置aws_ca_bundle。 选项
|
注释
注意
注意:对于模块,环境变量和配置文件是从 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
返回值
常用的返回值已在 此处 记录,以下是此模块特有的字段
键 |
描述 |
---|---|
包含堆栈信息的字典的字典。 键是堆栈名称。 返回:始终 |
|
堆栈更改集列表。列表中的每个项目都表示特定更改集的详细信息。 返回:只有当 |
|
关于堆栈的摘要信息。 返回:如果堆栈存在 |
|
堆栈中允许的功能。 返回:始终 |
|
创建堆栈的时间。 返回:如果堆栈存在 |
|
删除堆栈的时间。 返回:如果堆栈已删除 |
|
与堆栈关联的用户定义描述。 返回:始终 |
|
是否启用堆栈创建失败时的回滚。 返回:始终 |
|
关于堆栈的实际配置是否与预期配置(在堆栈模板和任何指定为模板参数的值中定义)不同的信息,即是否发生漂移。 返回:始终 |
|
最近一次在堆栈或其任何支持漂移检测的单个资源上启动漂移检测操作的时间。 返回:如果检测到漂移 |
|
堆栈的实际配置与其预期模板配置相比的状态。 返回:始终 |
|
是否为堆栈启用了终止保护。 返回:始终 |
|
发布堆栈相关事件的 Amazon SNS 主题 ARN。 返回:始终 |
|
输出字典列表。 返回:始终 |
|
与输出关联的键。 返回:始终 |
|
与输出关联的值。 返回:始终 |
|
参数字典列表。 返回:始终 |
|
与参数关联的键。 返回:始终 |
|
与参数关联的值。 返回:始终 |
|
CloudFormation 在堆栈创建和更新操作期间监视的回滚触发器。 返回:始终 |
|
在堆栈创建或更新操作期间监视的触发器。 返回:当存在回滚触发器时 |
|
回滚触发器的 ARN。 返回:始终 |
|
回滚触发器的资源类型。 返回:始终 |
|
堆栈的唯一 ID。 返回:始终 |
|
堆栈的名称。 返回:始终 |
|
堆栈的状态。 返回:始终 |
|
与堆栈关联的标签列表。 返回:始终 |
|
标签的键。 返回:始终 |
|
标签的值。 返回:始终 |
|
堆栈的所有事件。 返回:只有当 |
|
堆栈输出的字典,以每个输出“OutputKey”参数的值为键,以及每个输出“OutputValue”参数的相应值为值。 返回:如果堆栈存在 示例: |
|
堆栈参数的字典,以每个参数“ParameterKey”参数的值为键,以及每个参数“ParameterValue”参数的相应值为值。 返回:如果堆栈存在 示例: |
|
描述堆栈的策略。 返回:只有当 |
|
描述堆栈的资源。 返回:只有当 |
|
堆栈资源的字典,以每个资源“LogicalResourceId”参数的值为键,以及每个资源“PhysicalResourceId”参数的相应值为值。 返回:只有当 示例: |
|
描述堆栈的模板。 返回:只有当 |