AWS::Athena::PreparedStatement

Specifies a prepared statement for use with SQL queries in Athena.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::Athena::PreparedStatement",
  "Properties" : {
      "Description" : String,
      "QueryStatement" : String,
      "StatementName" : String,
      "WorkGroup" : String
    }
}

YAML

Type: AWS::Athena::PreparedStatement
Properties:
  Description: String
  QueryStatement: String
  StatementName: String
  WorkGroup: String

Properties

Description

The description of the prepared statement.

Required: No

Type: String

Minimum: 1

Maximum: 1024

Update requires: No interruption

QueryStatement

The query string for the prepared statement.

Required: Yes

Type: String

Minimum: 1

Maximum: 262144

Update requires: No interruption

StatementName

The name of the prepared statement.

Required: Yes

Type: String

Minimum: 1

Maximum: 256

Update requires: Replacement

WorkGroup

The workgroup to which the prepared statement belongs.

Required: Yes

Type: String

Minimum: 1

Maximum: 128

Update requires: Replacement

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the name of the prepared statement.

For more information about using the Ref function, see Ref.