AWS::SageMaker::ProcessingJob AthenaDatasetDefinition - Amazon CloudFormation
SyntaxProperties
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

This is the new Amazon CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the Amazon CloudFormation User Guide.

AWS::SageMaker::ProcessingJob AthenaDatasetDefinition

Configuration for Athena Dataset Definition input.

Syntax

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

JSON

{
  "Catalog" : String,
  "Database" : String,
  "KmsKeyId" : String,
  "OutputCompression" : String,
  "OutputFormat" : String,
  "OutputS3Uri" : String,
  "QueryString" : String,
  "WorkGroup" : String
}

YAML

  Catalog: String
  Database: String
  KmsKeyId: String
  OutputCompression: String
  OutputFormat: String
  OutputS3Uri: String
  QueryString: 
    String
  WorkGroup: String

Properties

Catalog

The name of the data catalog used in Athena query execution.

Required: Yes

Type: String

Maximum: 256

Update requires: Replacement

Database

The name of the database used in the Athena query execution.

Required: Yes

Type: String

Pattern: .*

Maximum: 255

Update requires: Replacement

KmsKeyId

The Amazon Key Management Service (Amazon KMS) key that Amazon SageMaker uses to encrypt data generated from an Athena query execution.

Required: No

Type: String

Pattern: [a-zA-Z0-9:/_-]*

Minimum: 0

Maximum: 2048

Update requires: Replacement

OutputCompression

The compression used for Athena query results.

Required: No

Type: String

Allowed values: GZIP | SNAPPY | ZLIB

Update requires: Replacement

OutputFormat

The data storage format for Athena query results.

Required: Yes

Type: String

Allowed values: PARQUET | AVRO | ORC | JSON | TEXTFILE

Update requires: Replacement

OutputS3Uri

The location in Amazon S3 where Athena query results are stored.

Required: Yes

Type: String

Pattern: (https|s3)://([^/]+)/?(.*)

Minimum: 0

Maximum: 1024

Update requires: Replacement

QueryString

The SQL query statements, to be executed.

Required: Yes

Type: String

Pattern: [\s\S]+

Maximum: 4096

Update requires: Replacement

WorkGroup

The name of the workgroup in which the Athena query is being started.

Required: No

Type: String

Pattern: [a-zA-Z0-9._-]+

Maximum: 128

Update requires: Replacement