Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Added How-to content.

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

Panel
borderColor#bbb
bgColor#eeeeee

On this page:

Table of Contents
excludePopular.*

Panel
borderColor#bbb
bgColor#eeeeee

Related Pages:

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

      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:

      (info) 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:

        Panel
        borderColorgrey
        •  – Declares file(s) to be compressed css.
        • Activate server-side encryption and reduced redundancy storage.
        • Redirect request to another location, if the bucket is configured as a website.
        • Sets a one hour maximum age.
        •  – Grant public read access.
        •  – Replace source metadata with new values.
          • (warning) Note that this has somewhat tricky implications, please see the PUT Object - Copy documentation for details.
      Generated Variables
      Code Block
      languagetext
      linenumberstrue
      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

       
      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.
      Generated VariablesN/A

      Delete

       
      Source Bucket Name

      see Download above

      Source Object Key Prefix
      see Download above
      Generated VariablesN/A

      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 Configurationsee Upload above
      Generated Variables
      Code Block
      languagetext
      linenumberstrue
      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
      

Variables

Include Page
_VariablesNote
_VariablesNote

How-to Articles

Filter by label (Content by label)
max8
showSpacefalse
sorttitle
excerptTypesimple
cqllabel in ("amazon-s3","aws-cli")

Frequently Asked Questions (FAQ)

Questionslist macro
filterpopular
asktrue
limit8
topicamazon-s3