Versions objects in an S3 bucket, by pattern-matching filenames to identify version numbers.
-
bucket: Required. The name of the bucket. -
access_key_id: Optional. The AWS access key to use when accessing the bucket. -
secret_access_key: Optional. The AWS secret key to use when accessing the bucket. -
session_token: Optional. The AWS session token to use when accessing the bucket. -
region_name: Optional. The region the bucket is in. Defaults tous-east-1. -
private: Optional. Indicates that the bucket is private, so that any URLs provided are signed. -
cloudfront_url: Optional. The URL (scheme and domain) of your CloudFront distribution that is fronting this bucket. This will be used in theurlfile that is given to the following task. -
endpoint: Optional. Custom endpoint for using S3 compatible provider.
One of the following two options must be specified:
-
regexp: Optional. The pattern to match filenames against within S3. The first grouped match is used to extract the version, or if a group is explicitly namedversion, that group is used. At least one capture group must be specified, with parentheses.The version extracted from this pattern is used to version the resource. Semantic versions, or just numbers, are supported. Accordingly, full regular expressions are supported, to specify the capture groups.
-
versioned_file: Optional If you enable versioning for your S3 bucket then you can keep the file name the same and upload new versions of your file without resorting to version numbers. This property is the path to the file in your S3 bucket.
Objects will be found via the pattern configured by regexp. The versions
will be used to order them (using semver). Each
object's filename is the resulting version.
Places the following files in the destination:
-
(filename): The file fetched from the bucket. -
url: A file containing the URL of the object. Ifprivateis true, this URL will be signed. -
version: The version identified in the file name.
None.
Given a file specified by file, upload it to the S3 bucket. If regexp is
specified, the new file will be uploaded to the directory that the regex
searches in. If versioned_file is specified, the new file will be uploaded as
a new version of that file.
-
file: Required. Path to the file to upload, provided by an output of a task. If multiple files are matched by the glob, an error is raised. The file which matches will be placed into the directory structure on S3 as defined inregexpin the resource definition. The matching syntax is bash glob expansion, so no capture groups, etc. -
acl: Optional. Canned Acl for the uploaded object.
- name: release
type: s3
source:
bucket: releases
regexp: directory_on_s3/release-(.*).tgz
access_key_id: ACCESS-KEY
secret_access_key: SECRET- get: release- put: release
params:
file: path/to/release-*.tgz
acl: public-reads3:PutObjects3:PutObjectAcls3:GetObjects3:ListBucket
Everything above and...
s3:GetBucketVersionings3:GetObjectVersions3:ListBucketVersionss3:PutObjectVersionAcl
First get the resource via:
go get github.com/concourse/s3-resource
Get the dependencies:
go get -d -t ./...