stored_queries

Creates, updates, deletes or gets a stored_query resource or lists stored_queries in a region

Overview

Name	stored_queries
Type	Resource
Description	Resource Type definition for AWS::Config::StoredQuery
Id	awscc.config.stored_queries

Fields

get (all properties)

Name	Datatype	Description
query_arn	string
query_id	string
query_name	string
query_description	string
query_expression	string
▶tags	array	The tags for the stored query.
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
query_name	string
region	string	AWS region.

For more information, see AWS::Config::StoredQuery.

Methods

Name	Resource	Accessible by	Required Params
create_resource	stored_queries	INSERT	QueryName, QueryExpression, region
delete_resource	stored_queries	DELETE	Identifier, region
update_resource	stored_queries	UPDATE	Identifier, PatchDocument, region
list_resources	stored_queries_list_only	SELECT	region
get_resource	stored_queries	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual stored_query.

SELECT
  region,
  query_arn,
  query_id,
  query_name,
  query_description,
  query_expression,
  tags
FROM awscc.config.stored_queries
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ query_name }}';

list (identifiers only)

Lists all stored_queries in a region.

SELECT
  region,
  query_name
FROM awscc.config.stored_queries_list_only
WHERE
  region = '{{ region }}';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.config.stored_queries (
  QueryName,
  QueryExpression,
  region
)
SELECT
  '{{ query_name }}',
  '{{ query_expression }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.config.stored_queries (
  QueryName,
  QueryDescription,
  QueryExpression,
  Tags,
  region
)
SELECT
  '{{ query_name }}',
  '{{ query_description }}',
  '{{ query_expression }}',
  '{{ tags }}',
  '{{ 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: stored_query
  props:
    - name: query_name
      value: '{{ query_name }}'
    - name: query_description
      value: '{{ query_description }}'
    - name: query_expression
      value: '{{ query_expression }}'
    - name: tags
      value:
        - key: '{{ key }}'
          value: '{{ value }}'

UPDATE example

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

/*+ update */
UPDATE awscc.config.stored_queries
SET PatchDocument = string('{{ {
    "QueryDescription": query_description,
    "QueryExpression": query_expression,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ query_name }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.config.stored_queries
WHERE
  Identifier = '{{ query_name }}' 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 stored_queries resource, the following permissions are required:

Create

config:PutStoredQuery,
config:GetStoredQuery,
config:TagResource

Read

config:GetStoredQuery,
config:ListTagsForResource

Update

config:PutStoredQuery,
config:GetStoredQuery,
config:TagResource,
config:UntagResource,
config:ListTagsForResource

Delete

config:DeleteStoredQuery,
config:UntagResource

List

config:ListStoredQueries