CloudBees action: Retrieve an object from Amazon S3

Use this action to download an object file from Amazon Simple Storage Service (Amazon S3).

Inputs

Table 1. Input details

Input name	Data type	Required?	Description
bucket-name	String	Yes	The Amazon S3 bucket name.
file-path	String	Yes	The destination path for the download.
s3-path	String	Yes	The Amazon S3 bucket file path of the object to be downloaded.

Usage example

In your YAML file, add:

      - name: Download to Amazon S3
        uses: cloudbees-io/s3-download-object@v1
        with:
          file-path: "/local-image.tar"
          bucket-name: "Amazon_S3_bucket_name"
          s3-path: "amazon-s3-image.tar"

License

This code is made available under the MIT license.

References

• Learn more about using actions in CloudBees workflows.

• Learn about the CloudBees platform.