Amazon S3: Upload Directory
Description
Amazon S3: Upload Directory plugin step uploads multiple files and subdirectories to the Amazon S3 bucket.
Notes:
- To upload an object, the user must have “write” permission on the bucket.
- If Object Name is not given, the files will be uploaded to the root of the bucket.
Reference
Configurations
| Field Name | Description |
|---|---|
| Step Name | Specify a unique name for the step. |
| CONNECTION tab: | Connection fields |
| Region | Specify a valid AWS region 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 |
| Bucket Name | Specify the name of the S3 bucket in which the directory is to be uploaded. The data type is string. The field is mandatory. |
| Get | Click the button to populate the list of available buckets. |
| Object Name | Specify a folder in the S3 bucket in which files are to be uploaded. Keep it blank to upload files to the root of the bucket. |
| Directory Path | Specify the directory name that is to be uploaded. It is the path to the directory which is uploaded on the Amazon S3 bucket. The data type is string. The field is mandatory. Note: If the directory or sub-directory is empty, that is, does not contain files, then the workflow will be successful but the empty directory or sub-directory won’t be uploaded to the UI. |
| Browse | Click to browse the directory path to upload multiple files in the Amazon S3 bucket. |
| Include Subdirectories | Select if you want to include subdirectories in the upload. If true, files found in subdirectories will be included uploaded. Default Value: No |