Package software.amazon.awscdk.services.sagemaker

Interface CfnProcessingJob.AthenaDatasetDefinitionProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnProcessingJob.AthenaDatasetDefinitionProperty.Jsii$Proxy

Enclosing class:

CfnProcessingJob

@Stability(Stable)
public static interface CfnProcessingJob.AthenaDatasetDefinitionProperty
extends software.amazon.jsii.JsiiSerializable

Configuration for Athena Dataset Definition input.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.sagemaker.*;
 AthenaDatasetDefinitionProperty athenaDatasetDefinitionProperty = AthenaDatasetDefinitionProperty.builder()
         .catalog("catalog")
         .database("database")
         .outputFormat("outputFormat")
         .outputS3Uri("outputS3Uri")
         .queryString("queryString")
         // the properties below are optional
         .kmsKeyId("kmsKeyId")
         .outputCompression("outputCompression")
         .workGroup("workGroup")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-processingjob-athenadatasetdefinition.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnProcessingJob.AthenaDatasetDefinitionProperty.Builder	A builder for CfnProcessingJob.AthenaDatasetDefinitionProperty
static final class	CfnProcessingJob.AthenaDatasetDefinitionProperty.Jsii$Proxy	An implementation for CfnProcessingJob.AthenaDatasetDefinitionProperty

Method Summary

Modifier and Type	Method	Description
static CfnProcessingJob.AthenaDatasetDefinitionProperty.Builder	builder()
String	getCatalog()	The name of the data catalog used in Athena query execution.
String	getDatabase()	The name of the database used in the Athena query execution.
default String	getKmsKeyId()	The AWS Key Management Service ( AWS KMS) key that Amazon SageMaker uses to encrypt data generated from an Athena query execution.
default String	getOutputCompression()	The compression used for Athena query results.
String	getOutputFormat()	The data storage format for Athena query results.
String	getOutputS3Uri()	The location in Amazon S3 where Athena query results are stored.
String	getQueryString()	The SQL query statements, to be executed.
default String	getWorkGroup()	The name of the workgroup in which the Athena query is being started.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getCatalog

@Stability(Stable)
@NotNull
String getCatalog()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-processingjob-athenadatasetdefinition.html#cfn-sagemaker-processingjob-athenadatasetdefinition-catalog

getDatabase

@Stability(Stable)
@NotNull
String getDatabase()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-processingjob-athenadatasetdefinition.html#cfn-sagemaker-processingjob-athenadatasetdefinition-database

getOutputFormat

@Stability(Stable)
@NotNull
String getOutputFormat()

The data storage format for Athena query results.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-processingjob-athenadatasetdefinition.html#cfn-sagemaker-processingjob-athenadatasetdefinition-outputformat

getOutputS3Uri

@Stability(Stable)
@NotNull
String getOutputS3Uri()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-processingjob-athenadatasetdefinition.html#cfn-sagemaker-processingjob-athenadatasetdefinition-outputs3uri

getQueryString

@Stability(Stable)
@NotNull
String getQueryString()

The SQL query statements, to be executed.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-processingjob-athenadatasetdefinition.html#cfn-sagemaker-processingjob-athenadatasetdefinition-querystring

getKmsKeyId

@Stability(Stable)
@Nullable
default String getKmsKeyId()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-processingjob-athenadatasetdefinition.html#cfn-sagemaker-processingjob-athenadatasetdefinition-kmskeyid

getOutputCompression

@Stability(Stable)
@Nullable
default String getOutputCompression()

The compression used for Athena query results.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-processingjob-athenadatasetdefinition.html#cfn-sagemaker-processingjob-athenadatasetdefinition-outputcompression

getWorkGroup

@Stability(Stable)
@Nullable
default String getWorkGroup()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-processingjob-athenadatasetdefinition.html#cfn-sagemaker-processingjob-athenadatasetdefinition-workgroup

builder

@Stability(Stable)
static CfnProcessingJob.AthenaDatasetDefinitionProperty.Builder builder()

Returns:

a CfnProcessingJob.AthenaDatasetDefinitionProperty.Builder of CfnProcessingJob.AthenaDatasetDefinitionProperty