- unmigrated-wiki-markup
Documentation for Tasks for AWS 2.6 – other releases are available in the Tasks for AWS Documentation Directory.
View
or visit the current documentation home.
Using the AWS CloudFormation Stack task in Bamboo
Configuration
To ease common scenarios, the Create action allows to Update [the] stack, if it already exists, similarly the Update action allows to Create [the] stack, if it does not already exist.
To configure an AWS CloudFormation task:
- Navigate to the Tasks configuration tab for the job (this will be the default job if creating a new plan).
- Click the name of an existing AWS CloudFormation task, or click Add Task and then AWS CloudFormation Task to create a new task.
Complete the following settings:
Common to all tasks
Task Description (Optional) Identify the purpose of the task. Disable this task Check, or clear, to selectively run this task.
Action Each task supports one or more actions depending on the target AWS resource. Select the desired action and configure the action specific parameters below.
Region Select the desired AWS Region from the preconfigured list. Alternatively, select [Use region variable ...] to supply the region dynamically via Bamboo variables for example (needs to be a region code such as ap-southeast-2
) .... Configure task/action specific parameters, see below ... AWS Credentials Source Select the source for the required AWS Security Credentials - can be either Inline, an IAM Role for EC2 or a shared Identity Federation for AWS Connector. Actions supported by this task:
Create
Update stack, if it already exists Check to apply the Update action, if the stack already exists. Clear to trigger a build failure otherwise. Stack Name Specify a stack name.
Template Source Specify the stack template source as an S3 URL or inline in JSON format. Insert fragments from the inline Examples dialog to get started.
- Refer to AWS CloudFormation Sample Templates for more examples and snippets.
Parameters (Optional) Specify parameters in JSON format. Insert fragments from the inline Examples dialog to get started. Advanced Options Tags (Optional) Tag the stack. Notification ARN (Optional) Specify the Amazon SNS topic ARN stack related events should be published to. Creation Timeout (minutes) Specify how much time can pass before the stack creation is considered failed. On failure action Select the action that will be taken if stack creation fails.
Stack Rollback
Stack rollback is currently handled as follows, hopefully covering the majority of use cases (please let us know otherwise):
- A stack rolled back successfully by CloudFormation is treated as a failed build by Bamboo.
- A stack not rolled back due to rollback being disabled explicitly is still treated as a failed build by Bamboo.
Enable IAM (Optional) Check if the stack should be allowed to access IAM resources.
- Enabling IAM requires the AWS Security Credentials source to be either 'Inline', or 'IAM Role for EC2 (Agent)', or a shared 'Identity Federation for AWS' connector with principal type 'Assume Role'.
Stack Policy Source (Optional) Specify which update actions users can do and which resources they can take action on. See the Stack Policy Reference and Sample Stack Policies for details. Update
Create stack, if it does not already exist Check to apply the Create action, if the stack does not already exists. Clear to trigger a build failure otherwise.
Don't fail for no-op update Check to not fail the build, if the update does not have affect any resource. Clear to trigger a build failure otherwise. Stack Name or ID Specify the target stack. You can use its name or ID. Stack Template Source see Create above Parameters see Create above Advanced Options Notification ARN see Create above Enable IAM see Create above Stack Policy Source see Update above Stack Policy During Update Source (Optional) Override which update actions users can do and which resources they can take action on. See the Stack Policy Reference and Sample Stack Policies for details.
Delete
Stack Name or ID see Update above
Validate
The Validate action operates on a template rather than a stack. It has been included in this task for ease of use.
Stack Template Source see Create above