multi_region_access_point_routes
Creates, updates, deletes, gets or lists a multi_region_access_point_routes resource.
Overview
| Name | multi_region_access_point_routes |
| Type | Resource |
| Id | aws.s3control.multi_region_access_point_routes |
Fields
The following fields are returned by SELECT queries:
- get_multi_region_access_point_routes
| Name | Datatype | Description |
|---|---|---|
mrap | string | The Multi-Region Access Point ARN. |
routes | string | The different routes that make up the route configuration. Active routes return a value of 100, and passive routes return a value of 0. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_multi_region_access_point_routes | select | x-amz-account-id, mrap, region | This operation is not supported by directory buckets. Returns the routing configuration for a Multi-Region Access Point, indicating which Regions are active or passive. To obtain routing control changes and failover requests, use the Amazon S3 failover control infrastructure endpoints in these five Amazon Web Services Regions: us-east-1 us-west-2 ap-southeast-2 ap-northeast-1 eu-west-1 | |
submit_multi_region_access_point_routes | exec | x-amz-account-id, mrap, region, RouteUpdates | This operation is not supported by directory buckets. Submits an updated route configuration for a Multi-Region Access Point. This API operation updates the routing status for the specified Regions from active to passive, or from passive to active. A value of 0 indicates a passive status, which means that traffic won't be routed to the specified Region. A value of 100 indicates an active status, which means that traffic will be routed to the specified Region. At least one Region must be active at all times. When the routing configuration is changed, any in-progress operations (uploads, copies, deletes, and so on) to formerly active Regions will continue to run to their final completion state (success or failure). The routing configurations of any Regions that aren’t specified remain unchanged. Updated routing configurations might not be immediately applied. It can take up to 2 minutes for your changes to take effect. To submit routing control changes and failover requests, use the Amazon S3 failover control infrastructure endpoints in these five Amazon Web Services Regions: us-east-1 us-west-2 ap-southeast-2 ap-northeast-1 eu-west-1 |
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 |
|---|---|---|
mrap | string | The Multi-Region Access Point ARN. |
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_routes
This operation is not supported by directory buckets. Returns the routing configuration for a Multi-Region Access Point, indicating which Regions are active or passive. To obtain routing control changes and failover requests, use the Amazon S3 failover control infrastructure endpoints in these five Amazon Web Services Regions: us-east-1 us-west-2 ap-southeast-2 ap-northeast-1 eu-west-1
SELECT
mrap,
routes
FROM aws.s3control.multi_region_access_point_routes
WHERE `x-amz-account-id` = '{{ x-amz-account-id }}' -- required
AND mrap = '{{ mrap }}' -- required
AND region = '{{ region }}' -- required
;
Lifecycle Methods
- submit_multi_region_access_point_routes
This operation is not supported by directory buckets. Submits an updated route configuration for a Multi-Region Access Point. This API operation updates the routing status for the specified Regions from active to passive, or from passive to active. A value of 0 indicates a passive status, which means that traffic won't be routed to the specified Region. A value of 100 indicates an active status, which means that traffic will be routed to the specified Region. At least one Region must be active at all times. When the routing configuration is changed, any in-progress operations (uploads, copies, deletes, and so on) to formerly active Regions will continue to run to their final completion state (success or failure). The routing configurations of any Regions that aren’t specified remain unchanged. Updated routing configurations might not be immediately applied. It can take up to 2 minutes for your changes to take effect. To submit routing control changes and failover requests, use the Amazon S3 failover control infrastructure endpoints in these five Amazon Web Services Regions: us-east-1 us-west-2 ap-southeast-2 ap-northeast-1 eu-west-1
EXEC aws.s3control.multi_region_access_point_routes.submit_multi_region_access_point_routes
@x-amz-account-id='{{ x-amz-account-id }}' --required,
@mrap='{{ mrap }}' --required,
@region='{{ region }}' --required
@@json=
'{
"RouteUpdates": "{{ RouteUpdates }}"
}'
;