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

# ngs/s3-deploy

Deploy artifacts to AWS S3

## Commands

### deploy

| Parameter | Type | Default | Description |
|---|---|---|---|
| `workspace` | string |  |  |
| `artifacts` | string |  |  |
| `bucket` | string |  |  |
| `acl` | string | public-read |  |
| `cloudfront_distribution_id` | string | \"\" |  |
| `cloudfront_invalidation_paths` | string | /* |  |

## Jobs

### deploy

| Parameter | Type | Default | Description |
|---|---|---|---|
| `workspace` | string |  |  |
| `artifacts` | string |  |  |
| `bucket` | string |  |  |
| `acl` | string | public-read |  |
| `cloudfront_distribution_id` | string | \"\" |  |
| `cloudfront_invalidation_paths` | string | /* |  |

## Executors

### awscli

## Examples

### main

Build and deploy

```yaml
version: 2.1
orbs:
  s3: ngs/s3-deploy@0.0.1
jobs:
  build:
    executor: ...
    steps:
      - checkout
      - make
      - persist_to_workspace:
          root: .
          paths:
            - dist
workflows:
  main:
    jobs:
      - build
      - s3/deploy:
          requires:
            - build
          filters:
            branches:
              only: master
          workspace: .
          artifacts: dist
          bucket: my-artifacts
          cloudfront_distribution_id: ABCDEFG
```