named_queries

Creates, updates, deletes or gets a named_query resource or lists named_queries in a region

Overview

Name	named_queries
Type	Resource
Description	Resource schema for AWS::Athena::NamedQuery
Id	awscc.athena.named_queries

Fields

get (all properties)

Name	Datatype	Description
name	string	The query name.
database	string	The database to which the query belongs.
description	string	The query description.
query_string	string	The contents of the query with all query statements.
work_group	string	The name of the workgroup that contains the named query.
named_query_id	string	The unique ID of the query.
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
name	string	The query name.
named_query_id	string	The unique ID of the query.
region	string	AWS region.

For more information, see AWS::Athena::NamedQuery.

Methods

Name	Resource	Accessible by	Required Params
create_resource	named_queries	INSERT	Database, QueryString, region
delete_resource	named_queries	DELETE	Identifier, region
list_resources	named_queries_list_only	SELECT	region
get_resource	named_queries	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual named_query.

SELECT
  region,
  name,
  database,
  description,
  query_string,
  work_group,
  named_query_id
FROM awscc.athena.named_queries
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ named_query_id }}';

list (identifiers only)

Lists all named_queries in a region.

SELECT
  region,
  named_query_id
FROM awscc.athena.named_queries_list_only
WHERE
  region = 'us-east-1';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.athena.named_queries (
  Database,
  QueryString,
  region
)
SELECT
  '{{ database }}',
  '{{ query_string }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.athena.named_queries (
  Name,
  Database,
  Description,
  QueryString,
  WorkGroup,
  region
)
SELECT
  '{{ name }}',
  '{{ database }}',
  '{{ description }}',
  '{{ query_string }}',
  '{{ work_group }}',
  '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: named_query
    props:
      - name: name
        value: '{{ name }}'
      - name: database
        value: '{{ database }}'
      - name: description
        value: '{{ description }}'
      - name: query_string
        value: '{{ query_string }}'
      - name: work_group
        value: '{{ work_group }}'

DELETE example

/*+ delete */
DELETE FROM awscc.athena.named_queries
WHERE
  Identifier = '{{ named_query_id }}' AND
  region = 'us-east-1';

Permissions

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

Create

athena:CreateNamedQuery

Read

athena:GetNamedQuery

List

athena:ListNamedQueries

Delete

athena:DeleteNamedQuery