resource_collections

Creates, updates, deletes or gets a resource_collection resource or lists resource_collections in a region

Overview

Name	resource_collections
Type	Resource
Description	This resource schema represents the ResourceCollection resource in the Amazon DevOps Guru.
Id	awscc.devopsguru.resource_collections

Fields

get (all properties)

Name	Datatype	Description
▶resource_collection_filter	object	Information about a filter used to specify which AWS resources are analyzed for anomalous behavior by DevOps Guru.
resource_collection_type	string	The type of ResourceCollection
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
resource_collection_type	string	The type of ResourceCollection
region	string	AWS region.

For more information, see AWS::DevOpsGuru::ResourceCollection.

Methods

Name	Resource	Accessible by	Required Params
create_resource	resource_collections	INSERT	ResourceCollectionFilter, region
delete_resource	resource_collections	DELETE	Identifier, region
update_resource	resource_collections	UPDATE	Identifier, PatchDocument, region
list_resources	resource_collections_list_only	SELECT	region
get_resource	resource_collections	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual resource_collection.

SELECT
  region,
  resource_collection_filter,
  resource_collection_type
FROM awscc.devopsguru.resource_collections
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ resource_collection_type }}';

list (identifiers only)

Lists all resource_collections in a region.

SELECT
  region,
  resource_collection_type
FROM awscc.devopsguru.resource_collections_list_only
WHERE
  region = 'us-east-1';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.devopsguru.resource_collections (
  ResourceCollectionFilter,
  region
)
SELECT
  '{{ resource_collection_filter }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.devopsguru.resource_collections (
  ResourceCollectionFilter,
  region
)
SELECT
  '{{ resource_collection_filter }}',
  '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: resource_collection
    props:
      - name: resource_collection_filter
        value:
          cloud_formation:
            stack_names:
              - '{{ stack_names[0] }}'
          tags:
            - app_boundary_key: '{{ app_boundary_key }}'
              tag_values:
                - '{{ tag_values[0] }}'

UPDATE example

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

/*+ update */
UPDATE awscc.devopsguru.resource_collections
SET PatchDocument = string('{{ {
    "ResourceCollectionFilter": resource_collection_filter
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ resource_collection_type }}';

DELETE example

/*+ delete */
DELETE FROM awscc.devopsguru.resource_collections
WHERE
  Identifier = '{{ resource_collection_type }}' AND
  region = 'us-east-1';

Permissions

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

Create

devops-guru:UpdateResourceCollection,
devops-guru:GetResourceCollection

Read

devops-guru:GetResourceCollection

Delete

devops-guru:UpdateResourceCollection,
devops-guru:GetResourceCollection

List

devops-guru:GetResourceCollection

Update

devops-guru:UpdateResourceCollection,
devops-guru:GetResourceCollection