prepared_statements

Creates, updates, deletes or gets a prepared_statement resource or lists prepared_statements in a region

Overview

Name	prepared_statements
Type	Resource
Description	Resource schema for AWS::Athena::PreparedStatement
Id	awscc.athena.prepared_statements

Fields

get (all properties)

Name	Datatype	Description
statement_name	string	The name of the prepared statement.
work_group	string	The name of the workgroup to which the prepared statement belongs.
description	string	The description of the prepared statement.
query_statement	string	The query string for the prepared statement.
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
statement_name	string	The name of the prepared statement.
work_group	string	The name of the workgroup to which the prepared statement belongs.
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	prepared_statements	INSERT	StatementName, WorkGroup, QueryStatement, region
delete_resource	prepared_statements	DELETE	Identifier, region
update_resource	prepared_statements	UPDATE	Identifier, PatchDocument, region
list_resources	prepared_statements_list_only	SELECT	region
get_resource	prepared_statements	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual prepared_statement.

SELECT
  region,
  statement_name,
  work_group,
  description,
  query_statement
FROM awscc.athena.prepared_statements
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ statement_name }}|{{ work_group }}';

list (identifiers only)

Lists all prepared_statements in a region.

SELECT
  region,
  statement_name,
  work_group
FROM awscc.athena.prepared_statements_list_only
WHERE
  region = 'us-east-1';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.athena.prepared_statements (
  StatementName,
  WorkGroup,
  QueryStatement,
  region
)
SELECT
  '{{ statement_name }}',
  '{{ work_group }}',
  '{{ query_statement }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.athena.prepared_statements (
  StatementName,
  WorkGroup,
  Description,
  QueryStatement,
  region
)
SELECT
  '{{ statement_name }}',
  '{{ work_group }}',
  '{{ description }}',
  '{{ query_statement }}',
  '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: prepared_statement
    props:
      - name: statement_name
        value: '{{ statement_name }}'
      - name: work_group
        value: '{{ work_group }}'
      - name: description
        value: '{{ description }}'
      - name: query_statement
        value: '{{ query_statement }}'

UPDATE example

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

/*+ update */
UPDATE awscc.athena.prepared_statements
SET PatchDocument = string('{{ {
    "Description": description,
    "QueryStatement": query_statement
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ statement_name }}|{{ work_group }}';

DELETE example

/*+ delete */
DELETE FROM awscc.athena.prepared_statements
WHERE
  Identifier = '{{ statement_name }}|{{ work_group }}' AND
  region = 'us-east-1';

Permissions

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

Create

athena:CreatePreparedStatement,
athena:GetPreparedStatement

Read

athena:GetPreparedStatement

Update

athena:UpdatePreparedStatement

Delete

athena:DeletePreparedStatement,
athena:GetPreparedStatement

List

athena:ListPreparedStatements