s3_access_policies

Creates, updates, deletes, gets or lists a s3_access_policies resource.

Overview

Name	s3_access_policies
Type	Resource
Id	aws.omics.s3_access_policies

Fields

The following fields are returned by SELECT queries:

get_s3_access_policy

Name	Datatype	Description
s_3_access_point_arn	string	The S3 access point ARN that has the access policy. (pattern: <code>arn:[^:]:s3:[^:]:[^:]:accesspoint/.</code>)
s_3_access_policy	string	The current resource policy that controls S3 access on the store.
store_id	string	The Amazon Web Services-generated Sequence Store or Reference Store ID. (pattern: <code>[0-9]+</code>)
store_type	string	The type of store associated with the access point. (SEQUENCE_STORE, REFERENCE_STORE)
update_time	string (date-time)	The time when the policy was last updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_s3_access_policy	select	s3_access_point_arn, region		Retrieves details about an access policy on a given store.
put_s3_access_policy	replace	s3_access_point_arn, region, s3AccessPolicy		Adds an access policy to the specified store.
delete_s3_access_policy	delete	s3_access_point_arn, region		Deletes an access policy for the specified store.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)
s3_access_point_arn	string	The S3 access point ARN that has the access policy.

SELECT examples

get_s3_access_policy

Retrieves details about an access policy on a given store.

SELECT
s_3_access_point_arn,
s_3_access_policy,
store_id,
store_type,
update_time
FROM aws.omics.s3_access_policies
WHERE s3_access_point_arn = '{{ s3_access_point_arn }}' -- required
AND region = '{{ region }}' -- required
;

REPLACE examples

put_s3_access_policy

Adds an access policy to the specified store.

REPLACE aws.omics.s3_access_policies
SET 
s3AccessPolicy = '{{ s3AccessPolicy }}'
WHERE 
s3_access_point_arn = '{{ s3_access_point_arn }}' --required
AND region = '{{ region }}' --required
AND s3AccessPolicy = '{{ s3AccessPolicy }}' --required
RETURNING
s_3_access_point_arn,
store_id,
store_type;

DELETE examples

delete_s3_access_policy

Deletes an access policy for the specified store.

DELETE FROM aws.omics.s3_access_policies
WHERE s3_access_point_arn = '{{ s3_access_point_arn }}' --required
AND region = '{{ region }}' --required
;