https://github.com/joutvhu/download-s3

GitHub Action to download files from Amazon S3.
https://github.com/joutvhu/download-s3

action aws-s3 download github

Last synced: 1 day ago
JSON representation

GitHub Action to download files from Amazon S3.

• Host: GitHub
• URL: https://github.com/joutvhu/download-s3
• Owner: joutvhu
• License: mit
• Created: 2024-01-14T10:52:53.000Z (12 months ago)
• Default Branch: main
• Last Pushed: 2024-01-27T20:59:22.000Z (11 months ago)
• Last Synced: 2024-11-08T21:38:29.228Z (about 2 months ago)
• Topics: action, aws-s3, download, github
• Language: JavaScript
• Homepage:
• Size: 1.46 MB
• Stars: 1
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# Download S3

GitHub action to download files from Amazon S3

## Usage

See [action.yml](action.yml)

## Inputs

- `aws_access_key_id`: (__Required__) The AWS access key ID.

- `aws_secret_access_key`: (__Required__) The AWS secret access key.

- `aws_region`: (__Required__) The region to send service requests to.

- `aws_bucket`: (__Required__) The bucket name containing the files to download.

- `source`: The directory (or file path) on the bucket to which you want to download. Default is root directory.

- `target`: The local directory (or file path) where files are saved. Default is current directory.

## Example

```yaml

steps:

  - uses: joutvhu/download-s3@v1

    with:

      aws_access_key_id: ${{ secrets.AWS_ACCESS_KEY_ID }}

      aws_secret_access_key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}

      aws_region: us-east-1

      aws_bucket: ${{ secrets.AWS_BUCKET }}

      source: ''

      target: './backup'

```