resource_sets

Creates, updates, deletes or gets a resource_set resource or lists resource_sets in a region

Overview

Name	resource_sets
Type	Resource
Description	Creates an AWS Firewall Manager resource set.
Id	awscc.fms.resource_sets

Fields

get (all properties)

Name	Datatype	Description
id	string	A Base62 ID
name	string
description	string
resource_type_list	array
resources	array
▶tags	array
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
id	string	A Base62 ID
region	string	AWS region.

For more information, see AWS::FMS::ResourceSet.

Methods

Name	Resource	Accessible by	Required Params
create_resource	resource_sets	INSERT	Name, ResourceTypeList, region
delete_resource	resource_sets	DELETE	Identifier, region
update_resource	resource_sets	UPDATE	Identifier, PatchDocument, region
list_resources	resource_sets_list_only	SELECT	region
get_resource	resource_sets	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual resource_set.

SELECT
  region,
  id,
  name,
  description,
  resource_type_list,
  resources,
  tags
FROM awscc.fms.resource_sets
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ id }}';

list (identifiers only)

Lists all resource_sets in a region.

SELECT
  region,
  id
FROM awscc.fms.resource_sets_list_only
WHERE
  region = 'us-east-1';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.fms.resource_sets (
  Name,
  ResourceTypeList,
  region
)
SELECT
  '{{ name }}',
  '{{ resource_type_list }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.fms.resource_sets (
  Name,
  Description,
  ResourceTypeList,
  Resources,
  Tags,
  region
)
SELECT
  '{{ name }}',
  '{{ description }}',
  '{{ resource_type_list }}',
  '{{ resources }}',
  '{{ tags }}',
  '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: resource_set
    props:
      - name: name
        value: '{{ name }}'
      - name: description
        value: '{{ description }}'
      - name: resource_type_list
        value:
          - '{{ resource_type_list[0] }}'
      - name: resources
        value:
          - '{{ resources[0] }}'
      - name: tags
        value:
          - key: '{{ key }}'
            value: '{{ value }}'

UPDATE example

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

/*+ update */
UPDATE awscc.fms.resource_sets
SET PatchDocument = string('{{ {
    "Name": name,
    "Description": description,
    "ResourceTypeList": resource_type_list,
    "Resources": resources,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ id }}';

DELETE example

/*+ delete */
DELETE FROM awscc.fms.resource_sets
WHERE
  Identifier = '{{ id }}' AND
  region = 'us-east-1';

Permissions

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

Create

fms:PutResourceSet,
fms:BatchAssociateResource,
fms:ListResourceSetResources,
fms:TagResource

Update

fms:PutResourceSet,
fms:BatchAssociateResource,
fms:BatchDisassociateResource,
fms:GetResourceSet,
fms:ListResourceSetResources,
fms:TagResource,
fms:UntagResource,
fms:ListTagsForResource

Read

fms:GetResourceSet,
fms:ListResourceSetResources,
fms:ListTagsForResource

Delete

fms:DeleteResourceSet

List

fms:ListResourceSets