subscription_states
Creates, updates, deletes, gets or lists a subscription_states resource.
Overview
| Name | subscription_states |
| Type | Resource |
| Id | aws.shield.subscription_states |
Fields
The following fields are returned by SELECT queries:
- get_subscription_state
| Name | Datatype | Description |
|---|---|---|
subscription_state | string | The status of the subscription. (ACTIVE, INACTIVE) |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_subscription_state | select | region | Returns the SubscriptionState, either Active or Inactive. |
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_subscription_state
Returns the SubscriptionState, either Active or Inactive.
SELECT
subscription_state
FROM aws.shield.subscription_states
WHERE region = '{{ region }}' -- required
;