> For the complete CircleCI developer hub index, see [llms.txt](https://circleci.com/developer/llms.txt)

# aplazame/s3

## Commands

### folder

Parametrized folder deploy to S3

| Parameter | Type | Default | Description |
|---|---|---|---|
| `bucket_name` | string |  |  |
| `src` | string |  |  |
| `dest` | string |  |  |
| `acl` | string | private |  |
| `cache_control` | string | private, max-age:3600 |  |
| `overwrite` | boolean | true |  |
| `arguments` | string |  |  |
| `use_AWS_PROFILE` | boolean | false |  |
| `AWS_PROFILE` | string |  |  |

### file

Parametrized single file deploy to S3

| Parameter | Type | Default | Description |
|---|---|---|---|
| `bucket_name` | string |  |  |
| `src` | string |  |  |
| `dest` | string |  |  |
| `acl` | string | private |  |
| `content_type` | string |  |  |
| `cache_control` | string | private, max-age:3600 |  |
| `arguments` | string |  |  |
| `use_AWS_PROFILE` | boolean | false |  |
| `AWS_PROFILE` | string |  |  |

### public

Parametrized folder deploy to S3

| Parameter | Type | Default | Description |
|---|---|---|---|
| `bucket_name` | string |  |  |
| `src` | string | public |  |
| `dest` | string |  |  |
| `acl` | string | private |  |
| `cache_control` | string | private, max-age:3600 |  |
| `overwrite` | boolean | true |  |
| `arguments` | string |  |  |
| `index` | string |  |  |
| `index_cache_control` | string | no-cache, no-store |  |
| `index_arguments` | string |  |  |
| `use_AWS_PROFILE` | boolean | false |  |
| `AWS_PROFILE` | string |  |  |

## Jobs

### deploy

| Parameter | Type | Default | Description |
|---|---|---|---|
| `executor` | executor | s3_box | executor for s3_deploy |
| `workspace` | string | /tmp/workspace | working directory |
| `do_deploy` | steps |  | commands to be executed after for S3 deploy |

## Executors

### s3_box

| Parameter | Type | Default | Description |
|---|---|---|---|
| `image` | string | aplazame/alpine:0.1.10-aws |  |
| `working_directory` | string | /tmp/workspace |  |