Download Download

yaml
type: "io.kestra.plugin.aws.s3.Download"

Download a file to a S3 bucket.

Examples

yaml
id: "download"
type: "io.kestra.plugin.aws.s3.Download"
accessKeyId: "<access-key>"
secretKeyId: "<secret-key>"
region: "eu-central-1"
bucket: "my-bucket"
key: "path/to/file"

Properties

accessKeyId

  • Type: string
  • Dynamic: ✔️
  • Required:

The Access Key Id in order to connect to AWS

If no connection is defined, we will use default DefaultCredentialsProvider that will try to guess the value

bucket

  • Type: string
  • Dynamic: ✔️
  • Required:

The bucket name

endpointOverride

  • Type: string
  • Dynamic: ✔️
  • Required:

The endpoint with which the SDK should communicate.

Should normally not be used except for local development.

key

  • Type: string
  • Dynamic: ✔️
  • Required:

The key where to download the file.

region

  • Type: string
  • Dynamic: ✔️
  • Required:

The region with which the SDK should communicate.

requestPayer

  • Type: string
  • Dynamic: ✔️
  • Required:

Sets the value of the RequestPayer property for this object.

secretKeyId

  • Type: string
  • Dynamic: ✔️
  • Required:

The Secret Key Id in order to connect to AWS

If no connection is defined, we will use default DefaultCredentialsProvider that will try to guess the value

sessionToken

  • Type: string
  • Dynamic: ✔️
  • Required:

The he AWS session token, retrieved from an AWS token service, used for authenticating that this user has received temporary permission to access some resource.

If no connection is defined, we will use default DefaultCredentialsProvider that will try to guess the value

versionId

  • Type: string
  • Dynamic: ✔️
  • Required:

The specific version of the object.

Outputs

contentLength

  • Type: integer

Size of the body in bytes.

contentType

  • Type: string

A standard MIME type describing the format of the object data.

metadata

  • Type: object
  • SubType: string

A map of metadata to store with the object in S3.

uri

  • Type: string

versionId

  • Type: string

Version of the object.