group_configurations
Creates, updates, deletes, gets or lists a group_configurations resource.
Overview
| Name | group_configurations |
| Type | Resource |
| Id | aws.resource_groups.group_configurations |
Fields
The following fields are returned by SELECT queries:
- get_group_configuration
| Name | Datatype | Description |
|---|---|---|
configuration | array | The configuration currently associated with the group and in effect. |
failure_reason | string | If present, the reason why a request to update the group configuration failed. |
proposed_configuration | array | If present, the new configuration that is in the process of being applied to the group. |
status | string | The current status of an attempt to update the group configuration. (UPDATING, UPDATE_COMPLETE, UPDATE_FAILED) |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_group_configuration | select | region | Retrieves the service configuration associated with the specified resource group. For details about the service configuration syntax, see Service configurations for Resource Groups. Minimum permissions To run this command, you must have the following permissions: resource-groups:GetGroupConfiguration | |
put_group_configuration | replace | region | Attaches a service configuration to the specified group. This occurs asynchronously, and can take time to complete. You can use GetGroupConfiguration to check the status of the update. Minimum permissions To run this command, you must have the following permissions: resource-groups:PutGroupConfiguration |
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_group_configuration
Retrieves the service configuration associated with the specified resource group. For details about the service configuration syntax, see Service configurations for Resource Groups. Minimum permissions To run this command, you must have the following permissions: resource-groups:GetGroupConfiguration
SELECT
configuration,
failure_reason,
proposed_configuration,
status
FROM aws.resource_groups.group_configurations
WHERE region = '{{ region }}' -- required
;
REPLACE examples
- put_group_configuration
Attaches a service configuration to the specified group. This occurs asynchronously, and can take time to complete. You can use GetGroupConfiguration to check the status of the update. Minimum permissions To run this command, you must have the following permissions: resource-groups:PutGroupConfiguration
REPLACE aws.resource_groups.group_configurations
SET
Group = '{{ Group }}',
Configuration = '{{ Configuration }}'
WHERE
region = '{{ region }}' --required;