region_opt_status
Creates, updates, deletes, gets or lists a region_opt_status resource.
Overview
| Name | region_opt_status |
| Type | Resource |
| Id | aws.account.region_opt_status |
Fields
The following fields are returned by SELECT queries:
- get_region_opt_status
| Name | Datatype | Description |
|---|---|---|
region_name | string | The Region code that was passed in. |
region_opt_status | string | One of the potential statuses a Region can undergo (Enabled, Enabling, Disabled, Disabling, Enabled_By_Default). (ENABLED, ENABLING, DISABLING, DISABLED, ENABLED_BY_DEFAULT) |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_region_opt_status | select | region | Retrieves the opt-in status of a particular Region. |
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) |
SELECT examples
- get_region_opt_status
Retrieves the opt-in status of a particular Region.
SELECT
region_name,
region_opt_status
FROM aws.account.region_opt_status
WHERE region = '{{ region }}' -- required
;