groups

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

Overview

Name	groups
Type	Resource
Description	Resource Type definition for AWS::Synthetics::Group
Id	awscc.synthetics.groups

Fields

get (all properties)

Name	Datatype	Description
name	string	Name of the group.
id	string	Id of the group.
▶tags	array
resource_arns	array
region	string	AWS region.

list (identifiers only)

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

For more information, see AWS::Synthetics::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,
  id,
  tags,
  resource_arns
FROM awscc.synthetics.groups
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ name }}';

list (identifiers only)

Lists all groups in a region.

SELECT
  region,
  name
FROM awscc.synthetics.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.synthetics.groups (
  Name,
  region
)
SELECT
  '{{ name }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.synthetics.groups (
  Name,
  Tags,
  ResourceArns,
  region
)
SELECT
  '{{ name }}',
  '{{ tags }}',
  '{{ resource_arns }}',
  '{{ 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: tags
        value:
          - key: '{{ key }}'
            value: '{{ value }}'
      - name: resource_arns
        value:
          - '{{ resource_arns[0] }}'

UPDATE example

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

/*+ update */
UPDATE awscc.synthetics.groups
SET PatchDocument = string('{{ {
    "Tags": tags,
    "ResourceArns": resource_arns
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ name }}';

DELETE example

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

Permissions

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

Create

synthetics:CreateGroup,
synthetics:AssociateResource,
synthetics:TagResource,
synthetics:GetGroup

Update

synthetics:AssociateResource,
synthetics:DisassociateResource,
synthetics:TagResource,
synthetics:UntagResource,
synthetics:GetGroup,
synthetics:ListGroupResources

Read

synthetics:GetGroup,
synthetics:ListTagsForResource,
synthetics:ListGroupResources

Delete

synthetics:DeleteGroup,
synthetics:GetGroup

List

synthetics:ListGroups