region_settings
Creates, updates, deletes, gets or lists a region_settings resource.
Overview
| Name | region_settings |
| Type | Resource |
| Id | aws.backup.region_settings |
Fields
The following fields are returned by SELECT queries:
- describe_region_settings
| Name | Datatype | Description |
|---|---|---|
resource_type_management_preference | object | Returns whether Backup fully manages the backups for a resource type. For the benefits of full Backup management, see Full Backup management. For a list of resource types and whether each supports full Backup management, see the Feature availability by resource table. If "DynamoDB":false, you can enable full Backup management for DynamoDB backup by enabling Backup's advanced DynamoDB backup features. |
resource_type_opt_in_preference | object | The services along with the opt-in preferences in the Region. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
describe_region_settings | select | region | Returns the current service opt-in settings for the Region. If service opt-in is enabled for a service, Backup tries to protect that service's resources in this Region, when the resource is included in an on-demand backup or scheduled backup plan. Otherwise, Backup does not try to protect that service's resources in this Region. | |
update_region_settings | update | region | Updates the current service opt-in settings for the Region. Use the DescribeRegionSettings API to determine the resource types that are supported. |
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
- describe_region_settings
Returns the current service opt-in settings for the Region. If service opt-in is enabled for a service, Backup tries to protect that service's resources in this Region, when the resource is included in an on-demand backup or scheduled backup plan. Otherwise, Backup does not try to protect that service's resources in this Region.
SELECT
resource_type_management_preference,
resource_type_opt_in_preference
FROM aws.backup.region_settings
WHERE region = '{{ region }}' -- required
;
UPDATE examples
- update_region_settings
Updates the current service opt-in settings for the Region. Use the DescribeRegionSettings API to determine the resource types that are supported.
UPDATE aws.backup.region_settings
SET
ResourceTypeOptInPreference = '{{ ResourceTypeOptInPreference }}',
ResourceTypeManagementPreference = '{{ ResourceTypeManagementPreference }}'
WHERE
region = '{{ region }}' --required;