Page Comparison

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).

Configuration

To configure an Amazon S3 Object task:

1. Navigate to the Tasks configuration tab for the job (this will be the default job if creating a new plan).
2. 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.

3. Complete the following settings:

   1. Common to all tasks
      

      Include Page
      _CommonTaskParametersTable _CommonTaskParametersTable

   2. Actions supported by this task:

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

      Upload
      Artifact

   (Optional) One or more instance IDs (semicolon separated)

   1. Select the artifact you want to upload.

      Source Local Path

   The

   1. 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

   The

   1. Specify the name of the S3 bucket where you want the

   objects will

   1. files to be uploaded to.

      Target Object Key Prefix (Virtual Directory)

   The

   1. (Optional) Specify the S3 object key prefix

   of the S3 objects to be uploaded

   1. you want the uploaded files to gain in the target bucket.
      Metadata Configuration	(Optional)

   Additional

   1. 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: Panel borderColor grey 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
      Source Bucket Name

   The

   1. Specify the name of the S3 bucket where you want the objects

   will

   1. to be downloaded from.

      Source Object Key Prefix

   The

   1. Specify the key prefix of the S3 objects you want to

   be downloaded

   1. download from the source bucket.

      Target Local Path

   The

   1. (Optional) Specify the local path (relative to the working directory) where the objects will be downloaded to.
      Delete
      Source Bucket Name	see Download above
      Source Object Key Prefix	see Download above
      Copy
      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

Upload

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

N/A

Delete

N/A

Copy

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)