Copies an object in S3 from one bucket to an other.
Requires Extension:
S3 Resource Extension
s3copy( srcBucketName=string, srcObjectName=string, trgBucketName=string, trgObjectName=string, acl=object, location=string, accessKeyId=string, secretAccessKey=string, host=string, timeout=number );
| Argument |
Description |
Default |
|
srcBucketName
string,
required
|
Name of the source bucket of your object to copy
Alias:
srcBucket, sourceBucketName, sourceBucket
|
|
|
srcObjectName
string,
required
|
Name of the source object (path) within the bucket of your object to copy
Alias:
sourceObjectName, srcObject, sourceObject
|
|
|
trgBucketName
string,
required
|
Name of the target bucket of your object to copy
Alias:
trgBucket, targetBucketName, targetBucket
|
|
|
trgObjectName
string,
optional
|
Name of the target object (path)for the target bucket. If not defined the source obbject name is used.
Alias:
targetObjectName, trgObject, targetObject
|
|
|
acl
object,
optional
|
an array of struct where each struct represents an ACL grant
Alias:
aclObject
|
|
|
location
string,
optional
|
location of the S3 storage.
Alias:
region
|
|
|
accessKeyId
string,
optional
|
S3 accessKeyId, if not defined it checks the system property/environment variable for [lucee.s3.accesskeyid].
Alias:
accessKey, awsAccessKeyId, awsAccessKey
|
|
|
secretAccessKey
string,
optional
|
S3 secretAccessKey, if not defined it checks the system property/environment variable for [lucee.s3.secretaccesskey].
Alias:
secretkey, awsSecretkey, awsSecretAccessKey
|
|
|
host
string,
optional
|
the provider to connect, if not set Amazon AWS is used.
Alias:
provider, server
|
|
|
timeout
number,
optional
|
timeout for this execution
|
10000
|
Examples
There are currently no examples for this function
26,285ms WARN No examples for function S3Copy
See also
