Amazon S3: Upload File
Description
Amazon S3: Upload File plugin step creates or uploads an object in a bucket of Amazon S3.
Permission
To create or upload an object, the user must have write permission on 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 to create/upload an object. The data type is string. The field is mandatory. |
| Get | Click the button to populate the list of available Buckets. |
| Local File Path | Specify the file path on the local machine to be created/uploaded on the Amazon S3 bucket. The data type is string. The field is mandatory. |
| Browse | To browse the file path to create a file in the Amazon S3 bucket. |
| Key Name | This field is used to Rename a file. The file will be stored in an Amazon S3 bucket with the name given in this field. The data type is string. The field is mandatory. Notes: - The Key Name field is used to rename a file. The file will be stored in an Amazon S3 bucket with the name given in this field. - To store the file in a folder, specify the folder name with delimiter “/”. Example: “foldername/filename.extension”. - If the given folder does not exist on the bucket, it will be created. - If the file name is not given in Key Name, it will take the default file name and create an object with that name. - Provide valid file extension, same as the extension of File, given in the “Local File Path” field. - Key name does not support consecutive forward slashes (//). |
| ADDITIONAL INPUT tab: | Additional Input fields |
| Storage Class | The storage class to assign to the object. Allowed Values: ''STANDARD'', ''STANDARD_IA'', ''ONEZONE_IA'', ''REDUCED_REDUNDANCY'', ''INTELLIGENT_TIERING'', ''GLACIER'', ''DEEP_ARCHIVE''. Default value: STANDARD. |
| Access Control List | Specify an Access Control List. The Access Control List determines user permissions for the uploaded file. It enables the owner to grant required permissions to other AWS accounts. Allowed Values: ''Private'', ''PublicRead'', ''PublicReadWrite'', ''AwsExecRead'', ''AuthenticatedRead'', ''BucketOwnerFullControl'', ''BucketOwnerRead'', ''LogDeliveryWrite'' Default value: Private |
| OUTPUT tab: | Output fields |
| Object URL | Specify the output variable name in the field. The default output variable name: ObjectURL. An object URL is generated by an AWS user who has access to the object. The generated URL is then given to the user without making the bucket private. |