# s3-resource-simple

**Repository Path**: mirrors_davidB/s3-resource-simple

## Basic Information

- **Project Name**: s3-resource-simple
- **Description**: Concourse CI Resource for uploading files to S3
- **Primary Language**: Unknown
- **License**: CC0-1.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-08-08
- **Last Updated**: 2026-06-20

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Simple S3 Resource for [Concourse CI](http://concourse.ci)

Resource to upload files to S3. Unlike the [the official S3 Resource](https://github.com/concourse/s3-resource), this Resource can upload or download multiple files.

This repository is a fork of [18F/s3-resource-simple](https://github.com/18F/s3-resource-simple) with support of:

- [Specifying working directory for aws sync command?](https://github.com/18F/s3-resource-simple/issues/13)
- [Asset Scripts Output version correctly + Working Directory](https://github.com/18F/s3-resource-simple/pull/21)

## Usage

Include the following in your Pipeline YAML file, replacing the values in the angle brackets (`< >`):

```yaml
resource_types:
- name: s3-sync
  type: docker-image
  check_every: 48h
  source:
    repository: davidb31/s3-resource-simple
resources:
- name: <resource name>
  type: s3-sync
  check_every: 72h # the resource is mainly used in put (to upload, no need to check)
  source:
    access_key_id: ((aws-access-key))
    secret_access_key: ((aws-secret-key))
    bucket: ((aws-bucket))
    path: [<optional>, use to sync to a specific path of the bucket instead of root of bucket]
    options: [<optional, see note below>]
    region: <optional, see note below>
jobs:
- name: <job name>
  plan:
  - <some Resource or Task that outputs files>
  - put: <resource name>
    params:
      options: [<optional, see note below>]
      dir: <optional, see note below>
```

### AWS Credentials

The `access_key_id` and `secret_access_key` are optional and if not provided the EC2 Metadata service will be queried for role based credentials.

### `options`

The `options` parameter is synonymous with the options that `aws cli` accepts for `sync`. Please see [S3 Sync Options](http://docs.aws.amazon.com/cli/latest/reference/s3/sync.html#options) and pay special attention to the [Use of Exclude and Include Filters](http://docs.aws.amazon.com/cli/latest/reference/s3/index.html#use-of-exclude-and-include-filters).
Final `options` is the concatenation of the one defined into "resources/source" and into "put/params".

### `dir`

Use to upload from a subfolder of the working directory.

Given the following directory `test`:

```txt
test
├── results
│   ├── 1.json
│   └── 2.json
└── scripts
    └── bad.sh
```

we can upload _only_ the `results` subdirectory by using the following `dir` in our put configuration:

```yaml
      - put: "results-bucket"
        params:
          dir: 'results'
```

### `region`

Interacting with some AWS regions (like London) requires AWS Signature Version
4. This options allows you to explicitly specify region where your bucket is
located (if this is set, AWS_DEFAULT_REGION env variable will be set accordingly).

```yaml
region: eu-west-2
```