Try SpotterCreate or delete an AWS CloudFormation stack
| "added in version" 1.1 of ansible.builtin"
Authors: James S. Martin (@jsmartin)
stableinterface | supported by core
pipInstall with pip install ansible==2.9.17
Launches or updates an AWS CloudFormation stack and waits for it complete.
- name: create a cloudformation stack
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: create a stack, specify role that cloudformation assumes
cloudformation:
stack_name: "ansible-cloudformation"
state: "present"
region: "us-east-1"
disable_rollback: true
template: "roles/cloudformation/files/cloudformation-example.json"
role_arn: 'arn:aws:iam::123456789012:role/cloudformation-iam-role'
- name: delete a stack
cloudformation:
stack_name: "ansible-cloudformation-old"
state: "absent"
# Create a stack, pass in template from a URL, disable rollback if stack creation fails,
# pass in some parameters to the template, provide tags for resources created
- name: create a stack, pass in the template via an URL
cloudformation:
stack_name: "ansible-cloudformation"
state: present
region: us-east-1
disable_rollback: true
template_url: https://s3.amazonaws.com/my-bucket/cloudformation.template
template_parameters:
KeyName: jmartin
DiskType: ephemeral
InstanceType: m1.small
ClusterSize: 3
tags:
Stack: ansible-cloudformation
# Create a stack, passing in template body using lookup of Jinja2 template, disable rollback if stack creation fails,
# pass in some parameters to the template, provide tags for resources created
- name: create a stack, pass in the template body via lookup template
cloudformation:
stack_name: "ansible-cloudformation"
state: present
region: us-east-1
disable_rollback: true
template_body: "{{ lookup('template', 'cloudformation.j2') }}"
template_parameters:
KeyName: jmartin
DiskType: ephemeral
InstanceType: m1.small
ClusterSize: 3
tags:
Stack: ansible-cloudformation
# Pass a template parameter which uses Cloudformation's UsePreviousValue attribute
# When use_previous_value is set to True, the given value will be ignored and
# Cloudformation will use the value from a previously submitted template.
# If use_previous_value is set to False (default) the given value is used.
- cloudformation:
stack_name: "ansible-cloudformation"
state: "present"
region: "us-east-1"
template: "files/cloudformation-example.json"
template_parameters:
DBSnapshotIdentifier:
use_previous_value: True
value: arn:aws:rds:es-east-1:000000000000:snapshot:rds:my-db-snapshot
DBName:
use_previous_value: True
tags:
Stack: "ansible-cloudformation"
# Enable termination protection on a stack.
# If the stack already exists, this will update its termination protection
- name: enable termination protection during stack creation
cloudformation:
stack_name: my_stack
state: present
template_url: https://s3.amazonaws.com/my-bucket/cloudformation.template
termination_protection: yes
# Configure TimeoutInMinutes before the stack status becomes CREATE_FAILED
# In this case, if disable_rollback is not set or is set to false, the stack will be rolled back.
- name: enable termination protection during stack creation
cloudformation:
stack_name: my_stack
state: present
template_url: https://s3.amazonaws.com/my-bucket/cloudformation.template
create_timeout: 5
# Configure rollback behaviour on the unsuccessful creation of a stack allowing
# CloudFormation to clean up, or do nothing in the event of an unsuccessful
# deployment
# In this case, if on_create_failure is set to "DELETE", it will clean up the stack if
# it fails to create
- name: create stack which will delete on creation failure
cloudformation:
stack_name: my_stack
state: present
template_url: https://s3.amazonaws.com/my-bucket/cloudformation.template
on_create_failure: DELETE
tags:
description:
- Dictionary of tags to associate with stack and its resources during stack creation.
Can be updated later, updating tags removes previous entries.
version_added: '1.4'
version_added_collection: ansible.builtin
state:
choices:
- present
- absent
default: present
description:
- 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.
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
role_arn:
description:
- The role that AWS CloudFormation assumes to create the stack. See the AWS CloudFormation
Service Role docs U(https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-servicerole.html)
version_added: '2.3'
version_added_collection: ansible.builtin
template:
description:
- 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.
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:
- name of the cloudformation stack
required: true
capabilities:
default:
- CAPABILITY_IAM
- CAPABILITY_NAMED_IAM
description:
- Specify capabilities that stack template contains.
- Valid values are CAPABILITY_IAM, CAPABILITY_NAMED_IAM and CAPABILITY_AUTO_EXPAND.
type: list
version_added: '2.8'
version_added_collection: ansible.builtin
events_limit:
default: 200
description:
- Maximum number of CloudFormation events to fetch from a stack when creating or updating
it.
version_added: '2.7'
version_added_collection: ansible.builtin
stack_policy:
description:
- the path of the cloudformation stack policy. A policy cannot be removed once placed,
but it can be modified. for instance, allow all updates U(https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/protect-stack-resources.html#d0e9051)
version_added: '1.9'
version_added_collection: ansible.builtin
template_url:
description:
- 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.
version_added: '2.0'
version_added_collection: ansible.builtin
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
backoff_delay:
default: 3
description:
- Number of seconds to wait for the next retry.
required: false
type: int
version_added: '2.8'
version_added_collection: ansible.builtin
template_body:
description:
- 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.
version_added: '2.5'
version_added_collection: ansible.builtin
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
changeset_name:
description:
- Name given to the changeset when creating a changeset, only used when create_changeset
is true. By default a name prefixed with Ansible-STACKNAME is generated based on
input parameters. See the AWS Change Sets docs U(https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-changesets.html)
version_added: '2.4'
version_added_collection: ansible.builtin
create_timeout:
description:
- The amount of time (in minutes) that can pass before the stack status becomes CREATE_FAILED
version_added: '2.6'
version_added_collection: ansible.builtin
security_token:
aliases:
- 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.
type: str
validate_certs:
default: true
description:
- When set to "no", SSL certificates will not be validated for communication with
the AWS APIs.
type: bool
backoff_retries:
default: 10
description:
- Number of times to retry operation.
- AWS API throttling mechanism fails Cloudformation module so we have to retry a couple
of times.
required: false
type: int
version_added: '2.8'
version_added_collection: ansible.builtin
template_format:
choices:
- json
- yaml
default: json
description:
- (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.
version_added: '2.0'
version_added_collection: ansible.builtin
create_changeset:
default: 'no'
description:
- 'If stack already exists create a changeset instead of directly applying changes.
See the AWS Change Sets docs U(https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-changesets.html).
WARNING: if the stack does not exist, it will be created without changeset. If the
state is absent, the stack will be deleted immediately with no changeset.'
type: bool
version_added: '2.4'
version_added_collection: ansible.builtin
disable_rollback:
default: 'no'
description:
- If a stacks fails to form, rollback will remove the stack
type: bool
backoff_max_delay:
default: 30
description:
- Maximum amount of time to wait between retries.
required: false
type: int
version_added: '2.8'
version_added_collection: ansible.builtin
notification_arns:
description:
- The Simple Notification Service (SNS) topic ARNs to publish stack related events.
version_added: '2.0'
version_added_collection: ansible.builtin
on_create_failure:
choices:
- DO_NOTHING
- ROLLBACK
- DELETE
description:
- Action to take upon failure of stack creation. Incompatible with the disable_rollback
option.
version_added: '2.8'
version_added_collection: ansible.builtin
template_parameters:
default: {}
description:
- 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).
termination_protection:
description:
- enable or disable termination protection on the stack. Only works with botocore
>= 1.7.18.
type: bool
version_added: '2.5'
version_added_collection: ansible.builtin
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
events:
description: Most recent events in Cloudformation's event log. This may be from
a previous run in some cases.
returned: always
sample:
- StackEvent AWS::CloudFormation::Stack stackname UPDATE_COMPLETE
- StackEvent AWS::CloudFormation::Stack stackname UPDATE_COMPLETE_CLEANUP_IN_PROGRESS
type: list
log:
description: Debugging logs. Useful when modifying or finding an error.
returned: always
sample:
- updating stack
type: list
stack_outputs:
description: A key:value dictionary of all the stack outputs currently defined.
If there are no stack outputs, it is an empty dictionary.
returned: state == present
sample:
MySg: AnsibleModuleTestYAML-CFTestSg-C8UVS567B6NS
type: dict
stack_resources:
description: AWS stack resources and their status. List of dictionaries, one dict
per resource.
returned: state == present
sample:
- last_updated_time: '2016-10-11T19:40:14.979000+00:00'
logical_resource_id: CFTestSg
physical_resource_id: cloudformation2-CFTestSg-16UQ4CYQ57O9F
resource_type: AWS::EC2::SecurityGroup
status: UPDATE_COMPLETE
status_reason: null
type: list