S3 Copy Object
Create a copy of an object stored in Amazon S3.
In-ports
s3-uris Object | Array — a pair of S3 object locations.
trigger Boolean — triggers the S3 request.
abort Boolean — aborts all pending requests.
config JSON (dynamic) — accepts a JSON object with configuration properties.
Out-ports
response Object — emits a response wrapped into JSON object, or an error signal in case of a failure.
errors JSON — emits any errors that occur during action execution.
Overview
The AWS S3 Copy Object component allows you to create a copy of an object stored in Amazon S3. You can copy individual objects between general purpose buckets, between directory buckets, and between general purpose and directory buckets. Ensure the regions for both source and destination are enabled for your account. Specify the destination region using the Destination region setting if it's different from the source region.
The s3-uris port accepts either an array with two elements or an object with source and target properties representing the source and target S3 URIs. S3 URI indicates an S3 location in the format s3://amzn-s3-demo-bucket/mykey, where amzn-s3-demo-bucket is the bucket name and mykey is the key.
You must have read access to the source object and write access to the destination bucket.
To use this component, connect it to your Amazon S3 account and pass a pair of URIs to the s3-uris port. On success, a response with information about the copied object will be emitted.
If the trigger input port is used, the component waits until an event is received before executing the action. The action is performed with each event. Errors encountered will be emitted on the errors output port. Use the abort port to cancel the execution.
Settings
Enable realtime config port
When enabled, this setting allows the component to be configured via the config port. The port accepts a configuration object as input, enabling dynamic property updates during runtime. While using this port won't trigger component reinitialization, it may result in the loss of some previous component state.
Destination region (destinationRegion)
The destination region that you want to copy the S3 object to.
- Required: Yes
Keep always active
Determines whether the component will remain active even if it is not connected to a visible widget or another active component.
Example Configuration
Example of a configuration object:
{
"region": "us-east-1"
}
Related
- S3 List Buckets
- S3 List Objects
- S3 Put Object
- S3 Delete Object
- S3 Copy Object
- S3 Create Pre-signed URL
See also
For more information about Amazon S3, see the following: