account_settings

Creates, updates, deletes, gets or lists an account_settings resource.

Overview

Name	account_settings
Type	Resource
Id	aws.resource_groups.account_settings

Fields

The following fields are returned by SELECT queries:

get_account_settings

Name	Datatype	Description
group_lifecycle_events_desired_status	string	The desired target status of the group lifecycle events feature. If (ACTIVE, INACTIVE)
group_lifecycle_events_status	string	The current status of the group lifecycle events feature. (ACTIVE, INACTIVE, IN_PROGRESS, ERROR)
group_lifecycle_events_status_message	string	The text of any error message occurs during an attempt to turn group lifecycle events on or off.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_account_settings	select	region		Retrieves the current status of optional features in Resource Groups.
update_account_settings	update	region		Turns on or turns off optional features in Resource Groups. The preceding example shows that the request to turn on group lifecycle events is IN_PROGRESS. You can call the GetAccountSettings operation to check for completion by looking for GroupLifecycleEventsStatus to change to ACTIVE.

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_account_settings

Retrieves the current status of optional features in Resource Groups.

SELECT
group_lifecycle_events_desired_status,
group_lifecycle_events_status,
group_lifecycle_events_status_message
FROM aws.resource_groups.account_settings
WHERE region = '{{ region }}' -- required
;

UPDATE examples

update_account_settings

Turns on or turns off optional features in Resource Groups. The preceding example shows that the request to turn on group lifecycle events is IN_PROGRESS. You can call the GetAccountSettings operation to check for completion by looking for GroupLifecycleEventsStatus to change to ACTIVE.

UPDATE aws.resource_groups.account_settings
SET 
GroupLifecycleEventsDesiredStatus = '{{ GroupLifecycleEventsDesiredStatus }}'
WHERE 
region = '{{ region }}' --required
RETURNING
account_settings;