Using the Amazon S3 Object task in Bamboo

You can use the Amazon S3 Object task to upload, download, delete or copy Amazon Simple Storage Service (Amazon S3) (files); in particular, you can upload your Bamboo job's build artifacts or select local files and directories (optionally via Ant Patterns) - when addressing S3 objects (files), it matches those by key prefix, which allows to operate on multiple objects at once (virtual directories resp. folder hierarchies).

On this page:

Related Pages:

Configuration

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

Complete the following settings:

Common to all tasks

Click here to expand...

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. Alternatively, select [Use region variable ...] to supply the region dynamically via Bamboo variables (needs to be a region code such as `ap-southeast-2`) - refer to How to parametrize the AWS region via a Bamboo variable for details.
...	Configure task/action specific parameters, see below ...
AWS Security 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.
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.

Actions supported by this task:

ZIP Archive Support

As of Tasks for AWS 2.9, you can compress files into a ZIP archive during uploading to ease using AWS services that support or require the deployment artifact to be a ZIP file - this is enabled by a new option Upload as ZIP archive for the Amazon S3 Object task's Upload File(s) action.

Variables

All tasks support Bamboo Variable Substitution/Definition - this task's actions generate variables as follows:

A task's generated variables might get amended with respective AWS API additions over time - a live build log will always provide the most current variable shape accordingly

Upload File(s)

Creating resource variables for uploaded object 'prefix/taws-tst-object-4B.txt':
... bamboo.custom.aws.s3.object.first.BucketName: taws-tst-target-us-east-1
... bamboo.custom.aws.s3.object.first.ETag: 1dafad37f6d9e169248bacb8485fd9cc
... bamboo.custom.aws.s3.object.first.ObjectKey: prefix/taws-tst-object-4B.txt
... bamboo.custom.aws.s3.object.first.VersionId: null

Download Object(s)

N/A

Delete Object(s)

N/A

Copy Object(s)

Creating resource variables for copied object 'taws-tst-object-4B.a.txt':
... bamboo.custom.aws.s3.object.first.BucketName: taws-tst-target-us-east-1
... bamboo.custom.aws.s3.object.first.ETag: 1dafad37f6d9e169248bacb8485fd9cc
... bamboo.custom.aws.s3.object.first.ObjectKey: taws-tst-object-4B.a.txt
... bamboo.custom.aws.s3.object.first.VersionId: null