Documentation

cloudformation - Create or delete an AWS CloudFormation stack

Synopsis

  • Launches or updates an AWS CloudFormation stack and waits for it complete.

Options

parameter required default choices comments
aws_access_key
no
    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
    no
      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
      disable_rollback
      no false
      • true
      • false
      If a stacks fails to form, rollback will remove the stack
      ec2_url
      no
        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.
        notification_arns
        (added in 2.0)
        no
          The Simple Notification Service (SNS) topic ARNs to publish stack related events.
          profile
          (added in 1.6)
          no
            Uses a boto profile. Only works with boto >= 2.24.0.
            region
            no
              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
              role_arn
              (added in 2.3)
              no
                The role that AWS CloudFormation assumes to create the stack. See the AWS CloudFormation Service Role docs http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-servicerole.html
                security_token
                (added in 1.6)
                no
                  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_name
                  yes
                    name of the cloudformation stack
                    stack_policy
                    (added in 1.9)
                    no
                      the path of the cloudformation stack policy. A policy cannot be removed once placed, but it can be modified. (for instance, [allow all updates](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/protect-stack-resources.html#d0e9051)
                      state
                      yes
                        If state is "present", stack will be created. If state is "present" and if stack exists and template has changed, it will be updated. If state is "absent", stack will be removed.
                        tags
                        (added in 1.4)
                        no
                          Dictionary of tags to associate with stack and its resources during stack creation. Can be updated later, updating tags removes previous entries.
                          template
                          no
                            The local path of the cloudformation template.
                            This must be the full path to the file, relative to the working directory. If using roles this may look like "roles/cloudformation/files/cloudformation-example.json".
                            If 'state' is 'present' and the stack does not exist yet, either 'template' or 'template_url' must be specified (but not both). If 'state' is present, the stack does exist, and neither 'template' nor 'template_url' are specified, the previous template will be reused.
                            template_format
                            (added in 2.0)
                            no json
                            • json
                            • yaml
                            (deprecated) For local templates, allows specification of json or yaml format. Templates are now passed raw to CloudFormation regardless of format. This parameter is ignored since Ansible 2.3.
                            template_parameters
                            no
                              a list of hashes of all the template variables for the stack
                              template_url
                              (added in 2.0)
                              no
                                Location of file containing the template body. The URL must point to a template (max size 307,200 bytes) located in an S3 bucket in the same region as the stack.
                                If 'state' is 'present' and the stack does not exist yet, either 'template' or 'template_url' must be specified (but not both). If 'state' is present, the stack does exist, and neither 'template' nor 'template_url' are specified, the previous template will be reused.
                                validate_certs
                                (added in 1.5)
                                no yes
                                • yes
                                • no
                                When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.

                                Examples

                                # Basic task example
                                - name: launch ansible cloudformation example
                                  cloudformation:
                                    stack_name: "ansible-cloudformation"
                                    state: "present"
                                    region: "us-east-1"
                                    disable_rollback: true
                                    template: "files/cloudformation-example.json"
                                    template_parameters:
                                      KeyName: "jmartin"
                                      DiskType: "ephemeral"
                                      InstanceType: "m1.small"
                                      ClusterSize: 3
                                    tags:
                                      Stack: "ansible-cloudformation"
                                
                                # Basic role example
                                - name: launch ansible cloudformation example
                                  cloudformation:
                                    stack_name: "ansible-cloudformation"
                                    state: "present"
                                    region: "us-east-1"
                                    disable_rollback: true
                                    template: "roles/cloudformation/files/cloudformation-example.json"
                                    template_parameters:
                                      KeyName: "jmartin"
                                      DiskType: "ephemeral"
                                      InstanceType: "m1.small"
                                      ClusterSize: 3
                                    tags:
                                      Stack: "ansible-cloudformation"
                                
                                # Removal example
                                - name: tear down old deployment
                                  cloudformation:
                                    stack_name: "ansible-cloudformation-old"
                                    state: "absent"
                                
                                # Use a template from a URL
                                - name: launch ansible cloudformation example
                                  cloudformation:
                                    stack_name: "ansible-cloudformation"
                                    state: present
                                    region: us-east-1
                                    disable_rollback: true
                                    template_url: https://s3.amazonaws.com/my-bucket/cloudformation.template
                                  args:
                                    template_parameters:
                                      KeyName: jmartin
                                      DiskType: ephemeral
                                      InstanceType: m1.small
                                      ClusterSize: 3
                                    tags:
                                      Stack: ansible-cloudformation
                                
                                # Use a template from a URL, and assume a role to execute
                                - name: launch ansible cloudformation example with role assumption
                                  cloudformation:
                                    stack_name: "ansible-cloudformation"
                                    state: present
                                    region: us-east-1
                                    disable_rollback: true
                                    template_url: https://s3.amazonaws.com/my-bucket/cloudformation.template
                                    role_arn: 'arn:aws:iam::123456789012:role/cloudformation-iam-role'
                                  args:
                                    template_parameters:
                                      KeyName: jmartin
                                      DiskType: ephemeral
                                      InstanceType: m1.small
                                      ClusterSize: 3
                                    tags:
                                      Stack: ansible-cloudformation
                                

                                Return Values

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

                                name description returned type sample
                                stack_resources AWS stack resources and their status. List of dictionaries, one dict per resource. list [{'status': 'UPDATE_COMPLETE', 'physical_resource_id': 'cloudformation2-CFTestSg-16UQ4CYQ57O9F', 'logical_resource_id': 'CFTestSg', 'status_reason': None, 'last_updated_time': '2016-10-11T19:40:14.979000+00:00', 'resource_type': 'AWS::EC2::SecurityGroup'}]
                                stack_outputs A key:value dictionary of all the stack outputs currently defined. If there are no stack outputs, it is an empty dictionary. always dict {'MySg': 'AnsibleModuleTestYAML-CFTestSg-C8UVS567B6NS'}
                                events Most recent events in Cloudformation's event log. This may be from a previous run in some cases. always list ['StackEvent AWS::CloudFormation::Stack stackname UPDATE_COMPLETE', 'StackEvent AWS::CloudFormation::Stack stackname UPDATE_COMPLETE_CLEANUP_IN_PROGRESS']
                                log Debugging logs. Useful when modifying or finding an error. always list ['updating stack']


                                Notes

                                Note

                                • As of version 2.3, migrated to boto3 to enable new features. To match existing behavior, YAML parsing is done in the module, not given to AWS as YAML. This will change (in fact, it may change before 2.3 is out).
                                • 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 http://boto.readthedocs.org/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

                                Status

                                This module is flagged as stableinterface which means that the maintainers for this module guarantee that no backward incompatible interface changes will be made.

                                Support

                                This module is supported mainly by the community and is curated by core committers.

                                For more information on what this means please read Module Support

                                For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Helping Testing PRs and Developing Modules.