cloudformation_info – Obtain information about an AWS CloudFormation stack — Ansible Documentation

- AnsibleFest
- Products
- Community
- Webinars & Training
- Blog

Documentation

# cloudformation_info – Obtain information about an AWS CloudFormation stack

- Synopsis
- Requirements
- Parameters
- Notes
- Examples
- Return Values
- Status

## Synopsis

- Gets information about an AWS CloudFormation stack
- This module was called `cloudformation_facts` before Ansible 2.9, returning `ansible_facts`. Note that the cloudformation_info module no longer returns `ansible_facts`!

Aliases: cloudformation_facts

## Requirements

The below requirements are needed on the host that executes this module.

- boto
- boto3 >= 1.0.0
- python >= 2.6

## Parameters

Parameter | Choices/Defaults | Comments
--- | --- | ---
all_facts boolean | Choices: no ← yes | Get all stack information for the stack
aws_access_key string |  | AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used. aliases: ec2_access_key, access_key
aws_secret_key string |  | AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used. aliases: ec2_secret_key, secret_key
debug_botocore_endpoint_logs boolean added in 2.8 | Choices: no ← yes | 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.
ec2_url string |  | 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.
profile string |  | Uses a boto profile. Only works with boto >= 2.24.0.
region string |  | 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 http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region aliases: aws_region, ec2_region
security_token string |  | AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used. aliases: access_token
stack_events boolean | Choices: no ← yes | Get stack events for the stack
stack_name - |  | The name or id of the CloudFormation stack. Gathers information on all stacks by default.
stack_policy boolean | Choices: no ← yes | Get stack policy for the stack
stack_resources boolean | Choices: no ← yes | Get stack resources for the stack
stack_template boolean | Choices: no ← yes | Get stack template body for the stack
validate_certs boolean | Choices: no yes ← | When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.

## Notes

Note

- If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence `AWS_URL` or `EC2_URL`, `AWS_ACCESS_KEY_ID` or `AWS_ACCESS_KEY` or `EC2_ACCESS_KEY`, `AWS_SECRET_ACCESS_KEY` or `AWS_SECRET_KEY` or `EC2_SECRET_KEY`, `AWS_SECURITY_TOKEN` or `EC2_SECURITY_TOKEN`, `AWS_REGION` or `EC2_REGION`
- Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html
- `AWS_REGION` or `EC2_REGION` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file

## Examples

    # 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

    # Example dictionary outputs for stack_outputs, stack_parameters and stack_resources:
    # "stack_outputs": {
    #     "ApplicationDatabaseName": "dazvlpr01xj55a.ap-southeast-2.rds.amazonaws.com",
    #     ...
    # },
    # "stack_parameters": {
    #     "DatabaseEngine": "mysql",
    #     "DatabasePassword": "****",
    #     ...
    # },
    # "stack_resources": {
    #     "AutoscalingGroup": "dev-someapp-AutoscalingGroup-1SKEXXBCAN0S7",
    #     "AutoscalingSecurityGroup": "sg-abcd1234",
    #     "ApplicationDatabase": "dazvlpr01xj55a",
    #     "EcsTaskDefinition": "arn:aws:ecs:ap-southeast-2:123456789:task-definition/dev-someapp-EcsTaskDefinition-1F2VM9QB0I7K9:1"
    #     ...
    # }

## Return Values

Common return values are documented here, the following are the fields unique to this module:

Key | Returned | Description
--- | --- | ---
stack_description dictionary | if the stack exists | Summary facts about the stack
stack_events list | only if all_facts or stack_events is true and the stack exists | All stack events for the stack
stack_outputs dictionary | if the stack exists | Dictionary of stack outputs keyed by the value of each output 'OutputKey' parameter and corresponding value of each output 'OutputValue' parameter
stack_parameters dictionary | if the stack exists | Dictionary of stack parameters keyed by the value of each parameter 'ParameterKey' parameter and corresponding value of each parameter 'ParameterValue' parameter
stack_policy dictionary | only if all_facts or stack_policy is true and the stack exists | Describes the stack policy for the stack
stack_resource_list list | only if all_facts or stack_resourses is true and the stack exists | Describes stack resources for the stack
stack_resources dictionary | only if all_facts or stack_resourses is true and the stack exists | Dictionary of stack resources keyed by the value of each resource 'LogicalResourceId' parameter and corresponding value of each resource 'PhysicalResourceId' parameter
stack_template dictionary | only if all_facts or stack_template is true and the stack exists | Describes the stack template for the stack

## Status

- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]

### Authors

- Justin Menga (@jmenga)

Hint

If you notice any issues in this documentation, you can edit this document to improve it.