ansible / ansible.builtin / v2.9.0 / module / cloudformation_info Obtain information about an AWS CloudFormation stack | "added in version" 2.2 of ansible.builtin" Authors: Justin Menga (@jmenga) preview | supported by communityansible.builtin.cloudformation_info (v2.9.0) — module
pip
Install with pip install ansible==2.9.0
Gets information about an AWS CloudFormation stack
This module was called C(cloudformation_facts) before Ansible 2.9, returning C(ansible_facts). Note that the M(cloudformation_info) module no longer returns C(ansible_facts)!
# Note: These examples do not set authentication details, see the AWS Guide for details. # Get summary information about a stack - cloudformation_info: stack_name: my-cloudformation-stack register: output
- debug: msg: "{{ output['cloudformation']['my-cloudformation-stack'] }}"
# When the module is called as cloudformation_facts, return values are published # in ansible_facts['cloudformation'][<stack_name>] and can be used as follows. # Note that this is deprecated and will stop working in Ansible 2.13. - cloudformation_facts: stack_name: my-cloudformation-stack
- debug: msg: "{{ ansible_facts['cloudformation']['my-cloudformation-stack'] }}"
# Get stack outputs, when you have the stack name available as a fact - set_fact: stack_name: my-awesome-stack
- 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 - cloudformation_info: stack_name: my-cloudformation-stack all_facts: true
# Get stack resource and stack policy information about a stack - cloudformation_info: stack_name: my-cloudformation-stack stack_resources: true stack_policy: true
# Fail if the stack doesn't exist - name: try to get facts about a stack but fail if it doesn't exist cloudformation_info: stack_name: nonexistent-stack all_facts: yes failed_when: cloudformation['nonexistent-stack'] is undefined
region: aliases: - aws_region - ec2_region description: - The AWS region to use. If not specified then the value of the AWS_REGION or EC2_REGION environment variable, if any, is used. See U(http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region) type: str ec2_url: aliases: - aws_endpoint_url - endpoint_url description: - URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used. type: str profile: aliases: - aws_profile description: - Using I(profile) will override I(aws_access_key), I(aws_secret_key) and I(security_token) and support for passing them at the same time as I(profile) has been deprecated. - I(aws_access_key), I(aws_secret_key) and I(security_token) will be made mutually exclusive with I(profile) after 2022-06-01. type: str all_facts: default: 'no' description: - Get all stack information for the stack type: bool aws_config: description: - A dictionary to modify the botocore configuration. - Parameters can be found at U(https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config). - Only the 'user_agent' key is used for boto modules. See U(http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto) for more boto configuration. type: dict stack_name: description: - The name or id of the CloudFormation stack. Gathers information on all stacks by default. stack_events: default: 'no' description: - Get stack events for the stack type: bool stack_policy: default: 'no' description: - Get stack policy for the stack type: bool aws_ca_bundle: description: - The location of a CA Bundle to use when validating SSL certificates. - Not used by boto 2 based modules. - 'Note: The CA Bundle is read ''module'' side and may need to be explicitly copied from the controller if not run locally.' type: path aws_access_key: aliases: - ec2_access_key - access_key description: - C(AWS access key). If not set then the value of the C(AWS_ACCESS_KEY_ID), C(AWS_ACCESS_KEY) or C(EC2_ACCESS_KEY) environment variable is used. - If I(profile) is set this parameter is ignored. - Passing the I(aws_access_key) and I(profile) options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01. type: str aws_secret_key: aliases: - ec2_secret_key - secret_key description: - C(AWS secret key). If not set then the value of the C(AWS_SECRET_ACCESS_KEY), C(AWS_SECRET_KEY), or C(EC2_SECRET_KEY) environment variable is used. - If I(profile) is set this parameter is ignored. - Passing the I(aws_secret_key) and I(profile) options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01. type: str security_token: aliases: - aws_session_token - session_token - aws_security_token - access_token description: - C(AWS STS security token). If not set then the value of the C(AWS_SECURITY_TOKEN) or C(EC2_SECURITY_TOKEN) environment variable is used. - If I(profile) is set this parameter is ignored. - Passing the I(security_token) and I(profile) options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01. - Aliases I(aws_session_token) and I(session_token) have been added in version 3.2.0. type: str stack_template: default: 'no' description: - Get stack template body for the stack type: bool validate_certs: default: true description: - When set to "no", SSL certificates will not be validated for communication with the AWS APIs. type: bool stack_resources: default: 'no' description: - Get stack resources for the stack type: bool debug_botocore_endpoint_logs: default: 'no' description: - Use a botocore.endpoint logger to parse the unique (rather than total) "resource:action" API calls made during a task, outputing the set to the resource_actions key in the task results. Use the aws_resource_action callback to output to total list made during a playbook. The ANSIBLE_DEBUG_BOTOCORE_LOGS environment variable may also be used. type: bool
stack_description: description: Summary facts about the stack returned: if the stack exists type: dict stack_events: description: All stack events for the stack returned: only if all_facts or stack_events is true and the stack exists type: list stack_outputs: description: Dictionary of stack outputs keyed by the value of each output 'OutputKey' parameter and corresponding value of each output 'OutputValue' parameter returned: if the stack exists type: dict stack_parameters: description: Dictionary of stack parameters keyed by the value of each parameter 'ParameterKey' parameter and corresponding value of each parameter 'ParameterValue' parameter returned: if the stack exists type: dict stack_policy: description: Describes the stack policy for the stack returned: only if all_facts or stack_policy is true and the stack exists type: dict stack_resource_list: description: Describes stack resources for the stack returned: only if all_facts or stack_resourses is true and the stack exists type: list stack_resources: description: Dictionary of stack resources keyed by the value of each resource 'LogicalResourceId' parameter and corresponding value of each resource 'PhysicalResourceId' parameter returned: only if all_facts or stack_resourses is true and the stack exists type: dict stack_template: description: Describes the stack template for the stack returned: only if all_facts or stack_template is true and the stack exists type: dict