Copy
Copy a file between S3 buckets.
type: "io.kestra.plugin.aws.s3.Copy"
Examples
id: aws_s3_copy
namespace: company.team
tasks:
- id: copy
type: io.kestra.plugin.aws.s3.Copy
accessKeyId: "{{ secret('AWS_ACCESS_KEY_ID') }}"
secretKeyId: "{{ secret('AWS_SECRET_KEY_ID') }}"
region: "eu-central-1"
from:
bucket: "my-bucket"
key: "path/to/file"
to:
bucket: "my-bucket2"
key: "path/to/file2"
Properties
accessKeyId string
Access Key Id in order to connect to AWS.
If no credentials are defined, we will use the default credentials provider chain to fetch credentials.
compatibilityMode booleanstring
Enable compatibility mode.
Use it to connect to S3 bucket with S3 compatible services that don't support the new transport client.
delete booleanstring
false
Whether to delete the source file after download.
endpointOverride string
The endpoint with which the SDK should communicate.
This property allows you to use a different S3 compatible storage backend.
forcePathStyle booleanstring
Force path style access.
Must only be used when compatibilityMode
is enabled.
from Non-dynamicCopy-CopyObjectFrom
The source bucket and key.
region string
AWS region with which the SDK should communicate.
secretKeyId string
Secret Key Id in order to connect to AWS.
If no credentials are defined, we will use the default credentials provider chain to fetch credentials.
sessionToken string
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 credentials are defined, we will use the default credentials provider chain to fetch credentials.
stsEndpointOverride string
The AWS STS endpoint with which the SDKClient should communicate.
stsRoleArn string
AWS STS Role.
The Amazon Resource Name (ARN) of the role to assume. If set the task will use the StsAssumeRoleCredentialsProvider
. If no credentials are defined, we will use the default credentials provider chain to fetch credentials.
stsRoleExternalId string
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 string
PT15M
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 string
AWS STS Session name.
This property is only used when an stsRoleArn
is defined.
to Non-dynamicCopy-CopyObject
The destination bucket and key.
Outputs
bucket string
key string
versionId string
The version of the object.
Definitions
io.kestra.plugin.aws.s3.Copy-CopyObjectFrom
bucket *Requiredstring
The bucket name
key *Requiredstring
The bucket key
versionId string
The specific version of the object.
io.kestra.plugin.aws.s3.Copy-CopyObject
bucket *Requiredstring
The bucket name
key *Requiredstring
The bucket key