Page Comparison

Excerpt

Div

style	float:left

You can use the AWS Credentials Variables task to provide managed temporary AWS security credentials for other tools by injecting them into AWS unaware tasks like the Bamboo Script task. This improves versatility for using tools that are not directly integrated with Identity Federation for AWS, but accept AWS credentials via the command line, environment variables or the Bamboo task configuration interface.

Include Page

	_TasksForAWSNote
	_TasksForAWSNote

Panel

borderColor	#bbb
bgColor	#eeeeee

On this page:

Table of Contents

exclude	(Popular.\|Recent.)

Panel

borderColor	#bbb
bgColor	#eeeeee

Related Pages:

Identity Federation for AWS
- Administrator's Guide
Tasks for AWS
- AWS Security Credentials
- User's Guide
Atlassian Bamboo
- Configure a Bamboo task to use a script executable
- Configure a Bamboo task to inject variables

Configuration

Tip

title	Address limitations with the AWS CLI

The most frequent use case for the AWS Credentials Variables task is to address scenarios not (yet) covered by dedicated tasks, see How to work around limitations with the AWS Command Line Interface (AWS CLI) for details.

To configure an AWS Credentials Variables 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 Credentials Variables task, or click Add Task and then AWS Credentials Variables to create a new task.

Complete the following settings:

Task Description	(Optional) Identify the purpose of the task.
Disable this task	Check, or clear, to selectively run this task.
Add Caller Identity	Check to add variables with details about the IAM identity whose credentials are used to call the API (see get-caller-identity). Clear to skip the additional API call required to retrieve these details.
Source	Select the AWS Credentials Source (see below). Can be either Identity Federation for AWS or an IAM Role for EC2.
Connector	(Conditional) Select the shared Identity Federation for AWS Connector. Alternatively, select [Use connector variable ...] to supply the connector dynamically via Bamboo variables (needs to be a connector id such as `f24e81bc-7aff-42db-86a2-7cf82e24d871`) - refer to How to parametrize the AWS connector via a Bamboo variable for details.
Role ARN	(Conditional \| Optional) Specify the ARN of another role that the agent's IAM role for EC2 should assume.

AWS Credentials Sources

Tipinfo

title	IAM Policy

The AWS Credentials Variables task requires IAM permissions to retrieve temporary security credentials via the AWS Security Token Service (STS) - an all-encompassing policy might look as follows:

Code Block

language	js
collapse	true

{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Effect": "Allow",
            "Action": [
                "sts:AssumeRole",
                "sts:GetFederationToken",
                "sts:GetSessionToken"
            ],
            "Resource": [
                "*"
            ]
        }
    ]
}

Refer to Granting Permissions to Create Temporary Security Credentials for details on how to create more granular/secure policies, for example:

you can remove permissions for unused principal types.
you can further restrict permissions via more specific resource declarations

You have the following options to provide AWS Security Credentials:

Include Page

	_IdentityFederationForAWSConnector
	_IdentityFederationForAWSConnector

Include Page

	_IAMRolesForEC2
	_IAMRolesForEC2

Usage

Bamboo variables

This task generates the following Bamboo variables for reuse in subsequent tasks without native integration with Identity Federation for AWS:

Code Block

language	bash
title	Bamboo variables

${bamboo.custom.aws.accessKeyId}
${bamboo.custom.aws.secretAccessKey.password}
${bamboo.custom.aws.sessionToken.password}

# Optional: the callerIdentity namespace is only present when option 'Add Caller Identity' is checked.
${bamboo.custom.aws.callerIdentity.account}
${bamboo.custom.aws.callerIdentity.arn}
${bamboo.custom.aws.callerIdentity.userId}

The '*.password' suffix ensures that these sensitive variables are masked with asterisks ('*******') in the Bamboo build log.

An alternative representation as a JSON object for automated processing with tools like jq is available too:

Code Block

language	bash
title	Bamboo variables (alternative representations)

${bamboo.custom.aws.credentials.json.password}

# Optional: the callerIdentity namespace is only present when option 'Add Caller Identity' is checked.
${bamboo.custom.aws.callerIdentity.json}

Environment variables

Aforementioned variables will also be available as environment variables for use in Bamboo Script tasks. The syntax differs between shells, as illustrated in these examples for assigning them to the standardized variables used by tools like the AWS Command Line Interface (AWS CLI):

Code Block

language	bash
title	Bash (Unix shell)

export AWS_ACCESS_KEY_ID=$bamboo_custom_aws_accessKeyId
export AWS_SECRET_ACCESS_KEY=$bamboo_custom_aws_secretAccessKey_password
export AWS_SESSION_TOKEN=$bamboo_custom_aws_sessionToken_password

Code Block

language	powershell
title	PowerShell

$AWS_ACCESS_KEY_ID = $bamboo_custom_aws_accessKeyId
$AWS_SECRET_ACCESS_KEY = $bamboo_custom_aws_secretAccessKey_password
$AWS_SESSION_TOKEN = $bamboo_custom_aws_sessionToken_password

Code Block

language	diff
title	Windows Command Prompt (cmd)

set AWS_ACCESS_KEY_ID=%bamboo_custom_aws_accessKeyId%
set AWS_SECRET_ACCESS_KEY=%bamboo_custom_aws_secretAccessKey_password%
set AWS_SESSION_TOKEN=%bamboo_custom_aws_sessionToken_password%

How-to Articles

Filter by label (Content by label)

max	8
showSpace	false
sort	title
excerptType	simple
cql	label in ("aws-cli","aws-iam","aws-credentials") and label in ("kb-how-to-article","kb-troubleshooting-article") and label = "variables"

Frequently Asked Questions (FAQ)

Questionslist macro

filter	popular
ask	true
limit	8
topic	aws-credentials

Versions Compared

Old Version 19

New Version 20

Key

Configuration

AWS Credentials Sources

Usage

Bamboo variables

Environment variables

How-to Articles

Frequently Asked Questions (FAQ)