groups

Creates, updates, deletes or gets a group resource or lists groups in a region

Overview

Name	groups
Type	Resource
Description	Schema for ResourceGroups::Group
Id	awscc.resourcegroups.groups

Fields

get (all properties)

Name	Datatype	Description
name	string	The name of the resource group
description	string	The description of the resource group
▶resource_query	object
▶tags	array
arn	string	The Resource Group ARN.
▶configuration	array
resources	array
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
name	string	The name of the resource group
region	string	AWS region.

For more information, see AWS::ResourceGroups::Group.

Methods

Name	Resource	Accessible by	Required Params
create_resource	groups	INSERT	Name, region
delete_resource	groups	DELETE	Identifier, region
update_resource	groups	UPDATE	Identifier, PatchDocument, region
list_resources	groups_list_only	SELECT	region
get_resource	groups	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual group.

SELECT
  region,
  name,
  description,
  resource_query,
  tags,
  arn,
  configuration,
  resources
FROM awscc.resourcegroups.groups
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ name }}';

list (identifiers only)

Lists all groups in a region.

SELECT
  region,
  name
FROM awscc.resourcegroups.groups_list_only
WHERE
  region = 'us-east-1';

INSERT example

Use the following StackQL query and manifest file to create a new group resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO awscc.resourcegroups.groups (
  Name,
  region
)
SELECT
  '{{ name }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.resourcegroups.groups (
  Name,
  Description,
  ResourceQuery,
  Tags,
  Configuration,
  Resources,
  region
)
SELECT
  '{{ name }}',
  '{{ description }}',
  '{{ resource_query }}',
  '{{ tags }}',
  '{{ configuration }}',
  '{{ resources }}',
  '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: group
    props:
      - name: name
        value: '{{ name }}'
      - name: description
        value: '{{ description }}'
      - name: resource_query
        value:
          type: '{{ type }}'
          query:
            resource_type_filters:
              - '{{ resource_type_filters[0] }}'
            stack_identifier: '{{ stack_identifier }}'
            tag_filters:
              - key: '{{ key }}'
                values:
                  - '{{ values[0] }}'
      - name: tags
        value:
          - key: '{{ key }}'
            value: '{{ value }}'
      - name: configuration
        value:
          - type: '{{ type }}'
            parameters:
              - name: '{{ name }}'
                values:
                  - '{{ values[0] }}'
      - name: resources
        value:
          - '{{ resources[0] }}'

UPDATE example

Use the following StackQL query and manifest file to update a group resource, using stack-deploy.

/*+ update */
UPDATE awscc.resourcegroups.groups
SET PatchDocument = string('{{ {
    "Description": description,
    "ResourceQuery": resource_query,
    "Tags": tags,
    "Configuration": configuration,
    "Resources": resources
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ name }}';

DELETE example

/*+ delete */
DELETE FROM awscc.resourcegroups.groups
WHERE
  Identifier = '{{ name }}' AND
  region = 'us-east-1';

Permissions

To operate on the groups resource, the following permissions are required:

Create

resource-groups:CreateGroup,
resource-groups:Tag,
cloudformation:DescribeStacks,
cloudformation:ListStackResources,
resource-groups:ListGroupResources,
resource-groups:GroupResources

Read

resource-groups:GetGroup,
resource-groups:GetGroupQuery,
resource-groups:GetTags,
resource-groups:GetGroupConfiguration,
resource-groups:ListGroupResources

Update

resource-groups:UpdateGroup,
resource-groups:GetTags,
resource-groups:GetGroupQuery,
resource-groups:UpdateGroupQuery,
resource-groups:Tag,
resource-groups:Untag,
resource-groups:PutGroupConfiguration,
resource-groups:GetGroupConfiguration,
resource-groups:ListGroupResources,
resource-groups:GroupResources,
resource-groups:UnGroupResources

Delete

resource-groups:DeleteGroup,
resource-groups:UnGroupResources

List

resource-groups:ListGroups