Amazon S3

Amazon S3 Plugin steps perform actions on S3 buckets.

Prerequisites

• Amazon S3 instance with access details.

• Connection parameters like Access Key and Secret Key should be generated beforehand from the Amazon S3 console.

• During design time, if you want to use the GET button of the Bucket Name input field, the ListAllMyBuckets permission must be provided.

• Proxy environment settings: If you are using a Proxy environment, ensure you complete the following settings: Add proxy details to process studio/agent.bat file (set OPT section) as shown in the following sample format:

  -Dhttps.proxyHost=x.x.x.x -Dhttps.proxyPort=1234 -Dhttps.proxyUser="XXXXX" -Dhttps.proxyPassword="****"

  

Important:

The Proxy environment settings prerequisite is not required for the following steps:

• Amazon S3: Download File
• Amazon S3: Get Objects From Bucket

Reference

Generate Access Key and Secret Key. For details, see pstools.

Common Tab: Connection Fields

The following table explains the Connections and its field details, which is a common configuration available across steps.

Field Name	Description
Region	Specify a valid AWS region. Or, Click Get, to choose a region available on the Amazon S3 instance from the Region Explorer window. The field type is string and the field is mandatory.
Access Key	Specify the access key to authenticate an Amazon S3 cloud instance. Note: - Select Accept value as variable/static to use access key as static value or from environment variable in appeared access key box.  - Clear the checkbox to use access key from previous step.
Secret Key	Specify the secret key to authenticate Amazon AWS cloud. Note: - Select Accept value as variable/static to use secret key as static value or from environment variable in appeared secret key box. - Clear the checkbox to use secret key from previous step.
VPC Endpoint	Specify the private VPC (Virtual Private Cloud) endpoint to connect to Amazon S3 using AWS Private Link (for example, https://vpce.s3.amazonaws.com). When this field is provided, the plugin switches to private network connectivity settings (Path-Style Access), allowing secure access to S3 without public internet or a NAT Gateway. If left blank, the step uses the default Amazon S3 public endpoint to perform the actions, for example, adding tags to a bucket, copy file, create bucket and so on.
Test Connection	Click Test Connection to verify whether the connection is available or not. Region, Access key, and Secret Key are mandatory to authenticate Amazon AWS cloud. Note: Field values from previous steps cannot be used for connection verification, as their values are only accessible when the workflow is in running state. Static values and environment variables are allowed.