Package software.amazon.awscdk.services.sagemaker

Interface CfnProcessingJob.RedshiftDatasetDefinitionProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnProcessingJob.RedshiftDatasetDefinitionProperty.Jsii$Proxy

Enclosing class:

CfnProcessingJob

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

Configuration for Redshift 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.*;
 RedshiftDatasetDefinitionProperty redshiftDatasetDefinitionProperty = RedshiftDatasetDefinitionProperty.builder()
         .clusterId("clusterId")
         .clusterRoleArn("clusterRoleArn")
         .database("database")
         .dbUser("dbUser")
         .outputFormat("outputFormat")
         .outputS3Uri("outputS3Uri")
         .queryString("queryString")
         // the properties below are optional
         .kmsKeyId("kmsKeyId")
         .outputCompression("outputCompression")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnProcessingJob.RedshiftDatasetDefinitionProperty.Builder	builder()
String	getClusterId()	The Redshift cluster Identifier.
String	getClusterRoleArn()	The IAM role attached to your Redshift cluster that Amazon SageMaker uses to generate datasets.
String	getDatabase()	The name of the Redshift database used in Redshift query execution.
String	getDbUser()	The database user name used in Redshift query execution.
default String	getKmsKeyId()	The AWS Key Management Service ( AWS KMS) key that Amazon SageMaker uses to encrypt data from a Redshift execution.
default String	getOutputCompression()	The compression used for Redshift query results.
String	getOutputFormat()	The data storage format for Redshift query results.
String	getOutputS3Uri()	The location in Amazon S3 where the Redshift query results are stored.
String	getQueryString()	The SQL query statements to be executed.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getClusterId

@Stability(Stable)
@NotNull
String getClusterId()

The Redshift cluster Identifier.

See Also:

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

getClusterRoleArn

@Stability(Stable)
@NotNull
String getClusterRoleArn()

The IAM role attached to your Redshift cluster that Amazon SageMaker uses to generate datasets.

See Also:

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

getDatabase

@Stability(Stable)
@NotNull
String getDatabase()

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

See Also:

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

getDbUser

@Stability(Stable)
@NotNull
String getDbUser()

The database user name used in Redshift query execution.

See Also:

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

getOutputFormat

@Stability(Stable)
@NotNull
String getOutputFormat()

The data storage format for Redshift query results.

See Also:

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

getOutputS3Uri

@Stability(Stable)
@NotNull
String getOutputS3Uri()

The location in Amazon S3 where the Redshift query results are stored.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-processingjob-redshiftdatasetdefinition.html#cfn-sagemaker-processingjob-redshiftdatasetdefinition-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-redshiftdatasetdefinition.html#cfn-sagemaker-processingjob-redshiftdatasetdefinition-querystring

getKmsKeyId

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

The AWS Key Management Service ( AWS KMS) key that Amazon SageMaker uses to encrypt data from a Redshift execution.

See Also:

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

getOutputCompression

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

The compression used for Redshift query results.

See Also:

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

builder

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

Returns:

a CfnProcessingJob.RedshiftDatasetDefinitionProperty.Builder of CfnProcessingJob.RedshiftDatasetDefinitionProperty