Amazon S3: Copy File
Description
Amazon S3: Copy File plugin step copies the file (object) from one bucket to another in Amazon S3.
Notes:
- To copy a file in or from a folder, specify the folder name and file name separated by the delimiter "/". The folder will be created, if the folder is not present in the Destination bucket. For example, "foldername/filename.extension".
- Provide a valid File extension in Destination Key, same as the extension of the File, given in the Source Key field.
- If Destination Key/Filename is empty, it will consider Source Key's foldername and filename.extension during copying the files.
- If the filename.extension is to be copied at the Destination root path and the source path contains foldername(s)/filename.extension then in such case only the filename.extension needs to be provided in the Destination Key/Filename field.
- For version-disabled buckets, the version ID will be displayed as null in the output.
Reference
Configurations
| Field Name | Description |
|---|---|
| Step Name | Specify a unique name for the step. |
| CONNECTION tab: | Connection fields |
| Region | Specify a region of the destination bucket or click the Get button to choose a region from the Region Explorer window. The field type is String. This field is mandatory. |
| Button: Get | Click Get button to open the Region Explorer window populated with the list of Regions available on the Amazon S3 instance. Choose a Region. |
| Access Key: | Access key to authenticate an Amazon S3 cloud instance. |
| Accept Values from fields | Leave checkbox unchecked to accept Access Key value from a field in the previous steps of the stream using a drop down list. Else enable checkbox for Access Key field to appear as Text box. |
| Access Key | Specify the Access Key to authenticate Amazon S3 cloud instance. If checkbox above is enabled Access Key field appears as Text box and accepts static values or variables. Else if checkbox above is disabled Access Key field appears as a drop down to select fields from previous steps. The field type is String. This field is mandatory. |
| Secret Key: | Secret key to authenticate Amazon AWS cloud. |
| Accept Values from fields | Leave checkbox unchecked to accept Secret Key value from a field in the previous steps of the stream using a drop down list. Else enable checkbox for Secret Key field to appear as Text box. |
| Secret Key | Specify the Secret Key to authenticate Amazon S3 cloud instance. If checkbox above is enabled Secret Key field appears as Text box and accepts static values or variables. Else if checkbox above is disabled Secret Key field appears as a drop down to select fields from previous steps. The field type is String. This field is mandatory. |
| Button: Test Connection | Click Test Connection button to verify whether the connection is available or not. Region, Access key and Secret Key are mandatory to authenticate Amazon S3 cloud instance. For the purpose of verification fields coming from previous steps are not allowed since field values can only be accessed when workflow is in running state. Static values and environment variables are allowed. |
| INPUT tab: | Input fields |
| Source Bucket | Specify the name of the bucket from which you want to copy the file. |
| Button: Get | Click the button to populate the list of available Buckets. |
| Source Key/Filename | Specify or select the source key or filename that you want to copy from the source bucket to the destination bucket. The field type is String. This field is mandatory. |
| Version ID (Source Key) | Specify or select the specific version ID of the file to be copied. To use the version ID, you must enable Bucket versioning. |
| Destination Bucket | Specify or select the name of the bucket to which you want to copy the file. Note: The region of the destination bucket must be the same as the region in the Connection parameter. The field type is String. This field is mandatory. |
| Button: Get | Click Get button populates the list of Buckets available in the region, which is provided in the Connection parameters. |
| Destination Key/Filename | Use the field to rename the filename after copying the file. |
| OUTPUT tab: | Output fields |
| Destination Key Version ID | Specify the output variable name in the field. The field returns the version ID of the destination key. Default output variable name: DestinationKeyVersionID. The field type is String. This field is mandatory. |