AWS CDK Reference

Appearance

v2.275.0

AthenaDatasetDefinitionProperty Struct ​

Configuration for Athena Dataset Definition input.

Source
Generated code
Type last changed
v2.211.0 · 13 Aug 2025

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_sagemaker as sagemaker } from 'aws-cdk-lib';
const athenaDatasetDefinitionProperty: sagemaker.CfnProcessingJob.AthenaDatasetDefinitionProperty = {
  catalog: 'catalog',
  database: 'database',
  outputFormat: 'outputFormat',
  outputS3Uri: 'outputS3Uri',
  queryString: 'queryString',

  // the properties below are optional
  kmsKeyId: 'kmsKeyId',
  outputCompression: 'outputCompression',
  workGroup: 'workGroup',
};

Properties ​

catalogstringcatalogstrcatalogStringCatalogstringCatalog*stringrequired#
The name of the data catalog used in Athena query execution.
databasestringdatabasestrdatabaseStringDatabasestringDatabase*stringrequired#
The name of the database used in the Athena query execution.
kmsKeyIdoptionalstringkms_key_idoptionalstrkmsKeyIdoptionalStringKmsKeyIdoptionalstringKmsKeyIdoptional*string#
The AWS Key Management Service ( AWS KMS) key that Amazon SageMaker uses to encrypt data generated from an Athena query execution.
outputCompressionoptionalstringoutput_compressionoptionalstroutputCompressionoptionalStringOutputCompressionoptionalstringOutputCompressionoptional*string#
The compression used for Athena query results.
outputFormatstringoutput_formatstroutputFormatStringOutputFormatstringOutputFormat*stringrequired#
The data storage format for Athena query results.
outputS3Uristringoutput_s3_uristroutputS3UriStringOutputS3UristringOutputS3Uri*stringrequired#
The location in Amazon S3 where Athena query results are stored.
queryStringstringquery_stringstrqueryStringStringQueryStringstringQueryString*stringrequired#
The SQL query statements, to be executed.
workGroupoptionalstringwork_groupoptionalstrworkGroupoptionalStringWorkGroupoptionalstringWorkGroupoptional*string#
The name of the workgroup in which the Athena query is being started.