multi_region_access_point_policies
Creates, updates, deletes, gets or lists a multi_region_access_point_policies resource.
Overview
| Name | multi_region_access_point_policies |
| Type | Resource |
| Id | aws.s3control.multi_region_access_point_policies |
Fields
The following fields are returned by SELECT queries:
- get_multi_region_access_point_policy
| Name | Datatype | Description |
|---|---|---|
established | string | The last established policy for the Multi-Region Access Point. |
proposed | string | The proposed policy for the Multi-Region Access Point. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_multi_region_access_point_policy | select | x-amz-account-id, name, region | This operation is not supported by directory buckets. Returns the access control policy of the specified Multi-Region Access Point. This action will always be routed to the US West (Oregon) Region. For more information about the restrictions around working with Multi-Region Access Points, see Multi-Region Access Point restrictions and limitations in the Amazon S3 User Guide. The following actions are related to GetMultiRegionAccessPointPolicy: GetMultiRegionAccessPointPolicyStatus PutMultiRegionAccessPointPolicy | |
put_multi_region_access_point_policy | replace | x-amz-account-id, region, ClientToken, Details | This operation is not supported by directory buckets. Associates an access control policy with the specified Multi-Region Access Point. Each Multi-Region Access Point can have only one policy, so a request made to this action replaces any existing policy that is associated with the specified Multi-Region Access Point. This action will always be routed to the US West (Oregon) Region. For more information about the restrictions around working with Multi-Region Access Points, see Multi-Region Access Point restrictions and limitations in the Amazon S3 User Guide. The following actions are related to PutMultiRegionAccessPointPolicy: GetMultiRegionAccessPointPolicy GetMultiRegionAccessPointPolicyStatus |
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 |
|---|---|---|
name | string | Specifies the Multi-Region Access Point. The name of the Multi-Region Access Point is different from the alias. For more information about the distinction between the name and the alias of an Multi-Region Access Point, see Rules for naming Amazon S3 Multi-Region Access Points in the Amazon S3 User Guide. |
region | string | AWS region (default: us-east-1) |
x-amz-account-id | string | The Amazon Web Services account ID for the owner of the Multi-Region Access Point. |
SELECT examples
- get_multi_region_access_point_policy
This operation is not supported by directory buckets. Returns the access control policy of the specified Multi-Region Access Point. This action will always be routed to the US West (Oregon) Region. For more information about the restrictions around working with Multi-Region Access Points, see Multi-Region Access Point restrictions and limitations in the Amazon S3 User Guide. The following actions are related to GetMultiRegionAccessPointPolicy: GetMultiRegionAccessPointPolicyStatus PutMultiRegionAccessPointPolicy
SELECT
established,
proposed
FROM aws.s3control.multi_region_access_point_policies
WHERE `x-amz-account-id` = '{{ x-amz-account-id }}' -- required
AND name = '{{ name }}' -- required
AND region = '{{ region }}' -- required
;
REPLACE examples
- put_multi_region_access_point_policy
This operation is not supported by directory buckets. Associates an access control policy with the specified Multi-Region Access Point. Each Multi-Region Access Point can have only one policy, so a request made to this action replaces any existing policy that is associated with the specified Multi-Region Access Point. This action will always be routed to the US West (Oregon) Region. For more information about the restrictions around working with Multi-Region Access Points, see Multi-Region Access Point restrictions and limitations in the Amazon S3 User Guide. The following actions are related to PutMultiRegionAccessPointPolicy: GetMultiRegionAccessPointPolicy GetMultiRegionAccessPointPolicyStatus
REPLACE aws.s3control.multi_region_access_point_policies
SET
ClientToken = '{{ ClientToken }}',
Details = '{{ Details }}'
WHERE
`x-amz-account-id` = '{{ x-amz-account-id }}' --required
AND region = '{{ region }}' --required
AND ClientToken = '{{ ClientToken }}' --required
AND Details = '{{ Details }}' --required
RETURNING
request_token_arn;