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	aws.synthetics.groups

Fields

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

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

Methods

Name	Accessible by	Required Params
create_resource	INSERT	Name, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all groups in a region.

SELECT
region,
name,
id,
tags,
resource_arns
FROM aws.synthetics.groups
WHERE region = 'us-east-1';

Gets all properties from an individual group.

SELECT
region,
name,
id,
tags,
resource_arns
FROM aws.synthetics.groups
WHERE region = 'us-east-1' AND data__Identifier = '<Name>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO aws.synthetics.groups (
 Name,
 region
)
SELECT 
'{{ Name }}',
'{{ region }}';

All Properties

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

DELETE example

/*+ delete */
DELETE FROM aws.synthetics.groups
WHERE data__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