query_definitions

Creates, updates, deletes or gets a query_definition resource or lists query_definitions in a region

Overview

Name	query_definitions
Type	Resource
Description	The resource schema for AWSLogs QueryDefinition
Id	awscc.logs.query_definitions

Fields

get (all properties)

Name	Datatype	Description
name	string	A name for the saved query definition
query_string	string	The query string to use for this definition
log_group_names	array	Optionally define specific log groups as part of your query definition
query_definition_id	string	Unique identifier of a query definition
query_language	string	Query language of the query string. Possible values are CWLI, SQL, PPL, with CWLI being the default.
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
query_definition_id	string	Unique identifier of a query definition
region	string	AWS region.

For more information, see AWS::Logs::QueryDefinition.

Methods

Name	Resource	Accessible by	Required Params
create_resource	query_definitions	INSERT	Name, QueryString, region
delete_resource	query_definitions	DELETE	Identifier, region
update_resource	query_definitions	UPDATE	Identifier, PatchDocument, region
list_resources	query_definitions_list_only	SELECT	region
get_resource	query_definitions	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual query_definition.

SELECT
  region,
  name,
  query_string,
  log_group_names,
  query_definition_id,
  query_language
FROM awscc.logs.query_definitions
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ query_definition_id }}';

list (identifiers only)

Lists all query_definitions in a region.

SELECT
  region,
  query_definition_id
FROM awscc.logs.query_definitions_list_only
WHERE
  region = 'us-east-1';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.logs.query_definitions (
  Name,
  QueryString,
  region
)
SELECT
  '{{ name }}',
  '{{ query_string }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.logs.query_definitions (
  Name,
  QueryString,
  LogGroupNames,
  QueryLanguage,
  region
)
SELECT
  '{{ name }}',
  '{{ query_string }}',
  '{{ log_group_names }}',
  '{{ query_language }}',
  '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: query_definition
    props:
      - name: name
        value: '{{ name }}'
      - name: query_string
        value: '{{ query_string }}'
      - name: log_group_names
        value:
          - '{{ log_group_names[0] }}'
      - name: query_language
        value: '{{ query_language }}'

UPDATE example

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

/*+ update */
UPDATE awscc.logs.query_definitions
SET PatchDocument = string('{{ {
    "Name": name,
    "QueryString": query_string,
    "LogGroupNames": log_group_names,
    "QueryLanguage": query_language
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ query_definition_id }}';

DELETE example

/*+ delete */
DELETE FROM awscc.logs.query_definitions
WHERE
  Identifier = '{{ query_definition_id }}' AND
  region = 'us-east-1';

Permissions

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

Create

logs:PutQueryDefinition

Read

logs:DescribeQueryDefinitions

Update

logs:PutQueryDefinition

Delete

logs:DeleteQueryDefinition

List

logs:DescribeQueryDefinitions