Package software.amazon.awscdk.cfnpropertymixins.services.sagemaker

Interface CfnProcessingJobPropsMixin.RedshiftDatasetDefinitionProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnProcessingJobPropsMixin.RedshiftDatasetDefinitionProperty.Jsii$Proxy

Enclosing class:

CfnProcessingJobPropsMixin

@Stability(Stable)
public static interface CfnProcessingJobPropsMixin.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.cfnpropertymixins.services.sagemaker.*;
 RedshiftDatasetDefinitionProperty redshiftDatasetDefinitionProperty = RedshiftDatasetDefinitionProperty.builder()
         .clusterId("clusterId")
         .clusterRoleArn("clusterRoleArn")
         .database("database")
         .dbUser("dbUser")
         .kmsKeyId("kmsKeyId")
         .outputCompression("outputCompression")
         .outputFormat("outputFormat")
         .outputS3Uri("outputS3Uri")
         .queryString("queryString")
         .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	CfnProcessingJobPropsMixin.RedshiftDatasetDefinitionProperty.Builder	A builder for CfnProcessingJobPropsMixin.RedshiftDatasetDefinitionProperty
static final class	CfnProcessingJobPropsMixin.RedshiftDatasetDefinitionProperty.Jsii$Proxy	An implementation for CfnProcessingJobPropsMixin.RedshiftDatasetDefinitionProperty

Method Summary

Modifier and Type	Method	Description
static CfnProcessingJobPropsMixin.RedshiftDatasetDefinitionProperty.Builder	builder()
default String	getClusterId()	The Redshift cluster Identifier.
default String	getClusterRoleArn()	The IAM role attached to your Redshift cluster that Amazon SageMaker uses to generate datasets.
default String	getDatabase()	The name of the Redshift database used in Redshift query execution.
default 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.
default String	getOutputFormat()	The data storage format for Redshift query results.
default String	getOutputS3Uri()	The location in Amazon S3 where the Redshift query results are stored.
default String	getQueryString()	The SQL query statements to be executed.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getClusterId

@Stability(Stable)
@Nullable
default 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)
@Nullable
default 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)
@Nullable
default 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)
@Nullable
default 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

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

getOutputFormat

@Stability(Stable)
@Nullable
default 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)
@Nullable
default 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)
@Nullable
default 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

builder

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

Returns:

a CfnProcessingJobPropsMixin.RedshiftDatasetDefinitionProperty.Builder of CfnProcessingJobPropsMixin.RedshiftDatasetDefinitionProperty