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:

S3 Features

Most features offered by S3 are available by means of specifying additional Metadata fragments.

Zip Support

Several AWS services support or require the deployment artifact to be a Zip file. Based on Bamboo's artifact support and build pipeline workflow, we had considered the creation of such Zip files to be out of scope so far, i.e. considered artifact generation to be the responsibility of the facilitated build tool (e.g. Maven's JAR/WAR file generation).

However, from a usability perspective, users rightfully expect being able to deploy build results as is and transport/storage compression to be the responsibility of the upload task. Please watch/vote/comment on UAA-106 - Getting issue details... STATUS to help us prioritize the resp. improvement.

Upload File(s)
Artifact	Select the artifact you want to upload.
Source Local Path	Specify the local path (relative to the Bamboo working directory) to the files you want to upload. Use commas to separate files and directories. You can also use: Ant-style pattern matching to include multiple files Ant-style regular expression matching to rename multiple files See How to use Ant regular expressions to rename files on S3 uploads for some renaming examples.
Target Bucket Name	Specify the name of the S3 bucket where you want the files to be uploaded to.
Target Object Key Prefix (Virtual Directory)	(Optional) Specify the S3 object key prefix you want the uploaded files to gain in the target bucket.
Metadata Configuration	(Optional) Specify additional metadata in JSON format. Insert fragments from the inline Examples dialog to get started. Refer to PUT Object and PUT Object - Copy for available metadata options and values. For example: Content type and encoding – Declares file(s) to be compressed css. Encryption and storage class – Activate server-side encryption and reduced redundancy storage. Website redirect location – Redirect request to another location, if the bucket is configured as a website. Cache control – Sets a one hour maximum age. Access control – Grant public read access. (Copy only) Replace metadata – Replace source metadata with new values. Note that this has somewhat tricky implications, please see the PUT Object - Copy documentation for details.
Download Object(s)
Source Bucket Name	Specify the name of the S3 bucket where you want the objects to be downloaded from.
Source Object Key Prefix	Specify the key prefix of the S3 objects you want to download from the source bucket.
Target Local Path	(Optional) Specify the local path (relative to the working directory) where the objects will be downloaded to.
Delete Object(s)
Source Bucket Name	see Download above
Source Object Key Prefix	see Download above
Copy Object(s)
Source Bucket Name	see Download above
Source Object Key Prefix	see Download above
Target Bucket Name	see Upload above
Target Object Key Prefix (Virtual Directory)	see Upload above
Metadata Configuration	see Upload above

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':
... custom.aws.s3.object.first.BucketName: taws-tst-target-us-east-1
... custom.aws.s3.object.first.ETag: 1dafad37f6d9e169248bacb8485fd9cc
... custom.aws.s3.object.first.ObjectKey: prefix/taws-tst-object-4B.txt
... 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':
... custom.aws.s3.object.first.BucketName: taws-tst-target-us-east-1
... custom.aws.s3.object.first.ETag: 1dafad37f6d9e169248bacb8485fd9cc
... custom.aws.s3.object.first.ObjectKey: taws-tst-object-4B.a.txt
... custom.aws.s3.object.first.VersionId: null

How-to Articles

Frequently Asked Questions (FAQ)