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 = '{{ region }}' 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 = '{{ region }}';

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 }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.devopsguru.resource_collections (
  ResourceCollectionFilter,
  region
)
SELECT
  '{{ resource_collection_filter }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

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 }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.devopsguru.resource_collections
WHERE
  Identifier = '{{ resource_collection_type }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

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