Copy Copy

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

Copy a file between S3 buckets.

Examples

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

Properties

accessKeyId

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

Access Key Id in order to connect to AWS. If no connection is defined, we will use the DefaultCredentialsProvider to fetch the value.

compatibilityMode

  • Type: boolean
  • Dynamic:
  • Required:

delete

  • Type: boolean
  • Dynamic:
  • Required:
  • Default: false

Whether to delete the source file after download.

endpointOverride

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

The endpoint with which the SDK should communicate. This property should normally not be used except for local development.

from

The source bucket and key.

region

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

AWS region with which the SDK should communicate.

secretKeyId

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

Secret Key Id in order to connect to AWS. If no connection is defined, we will use the DefaultCredentialsProvider to fetch the value.

sessionToken

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

AWS session token, retrieved from an AWS token service, used for authenticating that this user has received temporary permissions to access a given resource. If no connection is defined, we will use the DefaultCredentialsProvider to fetch the value.

stsEndpointOverride

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

The AWS STS endpoint with which the SDKClient should communicate.

stsRoleArn

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

AWS STS Role. The Amazon Resource Name (ARN) of the role to assume. If set the task will use the StsAssumeRoleCredentialsProvider. Otherwise, the StaticCredentialsProvider will be used with the provided Access Key Id and Secret Key.

stsRoleExternalId

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

AWS STS External Id. A unique identifier that might be required when you assume a role in another account. This property is only used when an stsRoleArn is defined.

stsRoleSessionDuration

  • Type: string
  • Dynamic:
  • Required:
  • Default: 900.000000000
  • Format: duration

AWS STS Session duration. The duration of the role session (default: 15 minutes, i.e., PT15M). This property is only used when an stsRoleArn is defined.

stsRoleSessionName

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

AWS STS Session name. This property is only used when an stsRoleArn is defined.

to

The destination bucket and key.

Outputs

bucket

  • Type: string
  • Dynamic:
  • Required:

key

  • Type: string
  • Dynamic:
  • Required:

versionId

  • Type: string
  • Dynamic:
  • Required:

The version of the object.

Definitions

io.kestra.plugin.aws.s3.Copy-CopyObjectFrom

Properties

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

The bucket name

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

The bucket key

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

The specific version of the object.

io.kestra.plugin.aws.s3.Copy-CopyObject

Properties

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

The bucket name

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

The bucket key