Amazon S3: Set Bucket Policy
Description
Amazon S3: Set Bucket Policy plugin step sets the bucket policy for provided Amazon S3 bucket. Bucket policies provide access control management at the bucket level for both, the bucket resource and contained object resources.
Notes:
- After execution of the step, an already applied bucket policy will be overwritten with the new bucket policy.
- Only the owner of a bucket can set the bucket policy.
- At any given point in time, not more than one policy can be assigned to the bucket.
References
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 bucket for which you want to assign the policy. The field type is String. This field is mandatory. |
| Button: Get | Click the button to populate the list of available Buckets. |
| Bucket Policy | Specify the Bucket Policy in JSON text to be assigned to the Amazon S3 bucket. Double-click the field to insert fields in the Bucket Policy from the navigator. Else, use template support in the request body to substitute fields and environment variables/parameters in appropriate placeholders for previous step/input step - ?{fieldname}, Environment variables - ${environment variable}.Note: Ensure when substituting a string value (field or environment variable), we have to explicitly enclose that value in double quotes (""). |