Documentation

cloudformation_stack_set - Manage groups of CloudFormation stacks

New in version 2.7.

Synopsis

  • Launches/updates/deletes AWS CloudFormation Stack Sets

Requirements

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

  • boto
  • boto3>=1.6
  • botocore>=1.10.26
  • python >= 2.6

Parameters

Parameter Choices/Defaults Comments
accounts
A list of AWS accounts in which to create instance of CloudFormation stacks.
At least one region must be specified to create a stack set. On updates, if fewer regions are specified only the specified regions will have their stack instances updated.
administration_role_arn
ARN of the administration role, meaning the role that CloudFormation Stack Sets use to assume the roles in your child accounts.
This defaults to arn:aws:iam::{{ account ID }}:role/AWSCloudFormationStackSetAdministrationRole where {{ account ID }} is replaced with the account number of the current IAM role/user/STS credentials.

aliases: admin_role_arn, admin_role, administration_role
aws_access_key
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
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
capabilities
    Choices:
  • CAPABILITY_IAM
  • CAPABILITY_NAMED_IAM
Capabilities allow stacks to create and modify IAM resources, which may include adding users or roles.
Currently the only available values are 'CAPABILITY_IAM' and 'CAPABILITY_NAMED_IAM'. Either or both may be provided.
The following resources require that one or both of these parameters is specified: AWS::IAM::AccessKey, AWS::IAM::Group, AWS::IAM::InstanceProfile, AWS::IAM::Policy, AWS::IAM::Role, AWS::IAM::User, AWS::IAM::UserToGroupAddition
description
A description of what this stack set creates
ec2_url
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.
execution_role_name
ARN of the execution role, meaning the role that CloudFormation Stack Sets assumes in your child accounts.
This MUST NOT be an ARN, and the roles must exist in each child account specified.
The default name for the execution role is AWSCloudFormationStackSetExecutionRole

aliases: exec_role_name, exec_role, execution_role
failure_tolerance
Settings to change what is considered "failed" when running stack instance updates, and how many to do at a time.
name
required
name of the cloudformation stack set
parameters Default:
{}
A list of hashes of all the template variables for the stack. The value can be a string or a dict.
Dict can be used to set additional template parameter attributes like UsePreviousValue (see example).
profile
(added in 1.6)
Uses a boto profile. Only works with boto >= 2.24.0.
purge_stacks
bool
    Choices:
  • no
  • yes ←
Only applicable when state=absent. Sets whether, when deleting a stack set, the stack instances should also be deleted.
By default, instances will be deleted. Set to 'no' or 'false' to keep stacks when stack set is deleted.
region
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
regions
A list of AWS regions to create instances of a stack in. The region parameter chooses where the Stack Set is created, and regions specifies the region for stack instances.
At least one region must be specified to create a stack set. On updates, if fewer regions are specified only the specified regions will have their stack instances updated.
security_token
(added in 1.6)
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
state
    Choices:
  • present ←
  • absent
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
Dictionary of tags to associate with stack and its resources during stack creation. Can be updated later, updating tags removes previous entries.
template
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', 'template_body' or 'template_url' must be specified (but only one of them). If 'state' is present, the stack does exist, and neither 'template', 'template_body' nor 'template_url' are specified, the previous template will be reused.
template_body
Template body. Use this to pass in the actual body of the Cloudformation template.
If 'state' is 'present' and the stack does not exist yet, either 'template', 'template_body' or 'template_url' must be specified (but only one of them). If 'state' is present, the stack does exist, and neither 'template', 'template_body' nor 'template_url' are specified, the previous template will be reused.
template_url
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', 'template_body' or 'template_url' must be specified (but only one of them). If 'state' is present, the stack does exist, and neither 'template', 'template_body' nor 'template_url' are specified, the previous template will be reused.
validate_certs
bool

(added in 1.5)
    Choices:
  • no
  • yes ←
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
wait
bool
    Choices:
  • no ←
  • yes
Whether or not to wait for stack operation to complete. This includes waiting for stack instances to reach UPDATE_COMPLETE status.
If you choose not to wait, this module will not notify when stack operations fail because it will not wait for them to finish.
wait_timeout Default:
900
How long to wait (in seconds) for stacks to complete create/update/delete operations.

Notes

Note

  • To make an individual stack, you want the cloudformation module.
  • 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

- name: Create a stack set with instances in two accounts
  cloudformation_stack_set:
    name: my-stack
    description: Test stack in two accounts
    state: present
    template_url: https://s3.amazonaws.com/my-bucket/cloudformation.template
    accounts: [1234567890, 2345678901]
    regions:
    - us-east-1

- name: on subsequent calls, templates are optional but parameters and tags can be altered
  cloudformation_stack_set:
    name: my-stack
    state: present
    parameters:
      InstanceName: my_stacked_instance
    tags:
      foo: bar
      test: stack
    accounts: [1234567890, 2345678901]
    regions:
    - us-east-1

- name: The same type of update, but wait for the update to complete in all stacks
  cloudformation_stack_set:
    name: my-stack
    state: present
    wait: true
    parameters:
      InstanceName: my_restacked_instance
    tags:
      foo: bar
      test: stack
    accounts: [1234567890, 2345678901]
    regions:
    - us-east-1

Return Values

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

Key Returned Description
operations
list
always
All operations initiated by this run of the cloudformation_stack_set module

Sample:
[{'status': 'FAILED', 'operation_preferences': {'region_order': ['us-east-1', 'us-east-2']}, 'execution_role_name': 'AWSCloudFormationStackSetExecutionRole', 'action': 'CREATE', 'operation_id': 'Ansible-StackInstance-Create-0ff2af5b-251d-4fdb-8b89-1ee444eba8b8', 'administration_role_arn': 'arn:aws:iam::1234567890:role/AWSCloudFormationStackSetAdministrationRole', 'end_timestamp': '2018-06-18T17:41:24.560000+00:00', 'creation_timestamp': '2018-06-18T17:40:46.372000+00:00', 'stack_set_id': 'TestStackPrime:19f3f684-aae9-4e67-ba36-e09f92cf5929'}]
operations_log
list
always
Most recent events in Cloudformation's event log. This may be from a previous run in some cases.

Sample:
[{'status': 'FAILED', 'action': 'CREATE', 'operation_id': 'Ansible-StackInstance-Create-0ff2af5b-251d-4fdb-8b89-1ee444eba8b8', 'creation_timestamp': '2018-06-18T17:40:46.372000+00:00', 'stack_instances': [{'status': 'OUTDATED', 'account': '1234567890', 'status_reason': "Account 1234567890 should have 'AWSCloudFormationStackSetAdministrationRole' role with trust relationship to CloudFormation service.", 'region': 'us-east-1', 'stack_set_id': 'TestStackPrime:19f3f684-aae9-4e67-ba36-e09f92cf5929'}], 'end_timestamp': '2018-06-18T17:41:24.560000+00:00'}]
stack_instances
list
state == present
CloudFormation stack instances that are members of this stack set. This will also include their region and account ID.

Sample:
[{'status': 'OUTDATED', 'account': '1234567890', 'status_reason': "Account 1234567890 should have 'AWSCloudFormationStackSetAdministrationRole' role with trust relationship to CloudFormation service.\n", 'region': 'us-east-1', 'stack_set_id': 'TestStackPrime:19f3f684-aae9-4e67-ba36-e09f92cf5929'}, {'status': 'OUTDATED', 'account': '1234567890', 'status_reason': 'Cancelled since failure tolerance has exceeded', 'region': 'us-east-2', 'stack_set_id': 'TestStackPrime:19f3f684-aae9-4e67-ba36-e09f92cf5929'}]
stack_set
dict
state == present
Facts about the currently deployed stack set, its parameters, and its tags

Sample:
{'status': 'ACTIVE', 'template_body': 'AWSTemplateFormatVersion: "2010-09-09"\nParameters: {}\nResources:\n Bukkit:\n Type: "AWS::S3::Bucket"\n Properties: {}\n other:\n Type: "AWS::SNS::Topic"\n Properties: {}\n', 'stack_set_arn': 'arn:aws:cloudformation:us-east-1:1234567890:stackset/TestStackPrime:19f3f684-aae9-467-ba36-e09f92cf5929', 'description': 'test stack PRIME', 'parameters': [], 'tags': {'Some': 'Thing', 'an': 'other'}, 'stack_set_name': 'TestStackPrime', 'capabilities': [], 'execution_role_name': 'AWSCloudFormationStackSetExecutionRole', 'administration_role_arn': 'arn:aws:iam::1234567890:role/AWSCloudFormationStackSetAdministrationRole', 'stack_set_id': 'TestStackPrime:19f3f684-aae9-4e67-ba36-e09f92cf5929'}


Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Maintenance

This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.

For a list of other modules that are also maintained by the Ansible Community, see here.

Author

  • Ryan Scott Brown (@ryansb)

Hint

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