global_settings
Creates, updates, deletes, gets or lists a global_settings resource.
Overview
| Name | global_settings |
| Type | Resource |
| Id | aws.backup.global_settings |
Fields
The following fields are returned by SELECT queries:
- describe_global_settings
| Name | Datatype | Description |
|---|---|---|
global_settings | object | The status of the flags isCrossAccountBackupEnabled, isMpaEnabled ('Mpa' refers to multi-party approval), and isDelegatedAdministratorEnabled. isCrossAccountBackupEnabled: Allow accounts in your organization to copy backups to other accounts. isMpaEnabled: Add cross-account access to your organization with the option to assign a Multi-party approval team to a logically air-gapped vault. isDelegatedAdministratorEnabled: Allow Backup to automatically synchronize delegated administrator permissions with Organizations. |
last_update_time | string (date-time) | The date and time that the supported flags were last updated. This update is in Unix format and Coordinated Universal Time (UTC). The value of LastUpdateTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
describe_global_settings | select | region | Describes whether the Amazon Web Services account has enabled different cross-account management options, including cross-account backup, multi-party approval, and delegated administrator. Returns an error if the account is not a member of an Organizations organization. Example: describe-global-settings --region us-west-2 | |
update_global_settings | update | region | Updates whether the Amazon Web Services account has enabled different cross-account management options, including cross-account backup, multi-party approval, and delegated administrator. Returns an error if the account is not an Organizations management account. Use the DescribeGlobalSettings API to determine the current settings. |
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_global_settings
Describes whether the Amazon Web Services account has enabled different cross-account management options, including cross-account backup, multi-party approval, and delegated administrator. Returns an error if the account is not a member of an Organizations organization. Example: describe-global-settings --region us-west-2
SELECT
global_settings,
last_update_time
FROM aws.backup.global_settings
WHERE region = '{{ region }}' -- required
;
UPDATE examples
- update_global_settings
Updates whether the Amazon Web Services account has enabled different cross-account management options, including cross-account backup, multi-party approval, and delegated administrator. Returns an error if the account is not an Organizations management account. Use the DescribeGlobalSettings API to determine the current settings.
UPDATE aws.backup.global_settings
SET
GlobalSettings = '{{ GlobalSettings }}'
WHERE
region = '{{ region }}' --required;