interface RedshiftDatasetDefinitionProperty

Language	Type name
.NET	Amazon.CDK.AWS.Sagemaker.CfnProcessingJob.RedshiftDatasetDefinitionProperty
Go	github.com/aws/aws-cdk-go/awscdk/v2/awssagemaker#CfnProcessingJob_RedshiftDatasetDefinitionProperty
Java	software.amazon.awscdk.services.sagemaker.CfnProcessingJob.RedshiftDatasetDefinitionProperty
Python	aws_cdk.aws_sagemaker.CfnProcessingJob.RedshiftDatasetDefinitionProperty
TypeScript	aws-cdk-lib » aws_sagemaker » CfnProcessingJob » RedshiftDatasetDefinitionProperty

Configuration for Redshift Dataset Definition input.

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

Example

// 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 redshiftDatasetDefinitionProperty: sagemaker.CfnProcessingJob.RedshiftDatasetDefinitionProperty = {
  clusterId: 'clusterId',
  clusterRoleArn: 'clusterRoleArn',
  database: 'database',
  dbUser: 'dbUser',
  outputFormat: 'outputFormat',
  outputS3Uri: 'outputS3Uri',
  queryString: 'queryString',

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

Properties

Name	Type	Description
clusterId	string	The Redshift cluster Identifier.
clusterRoleArn	string	The IAM role attached to your Redshift cluster that Amazon SageMaker uses to generate datasets.
database	string	The name of the Redshift database used in Redshift query execution.
dbUser	string	The database user name used in Redshift query execution.
outputFormat	string	The data storage format for Redshift query results.
outputS3Uri	string	The location in Amazon S3 where the Redshift query results are stored.
queryString	string	The SQL query statements to be executed.
kmsKeyId?	string	The AWS Key Management Service ( AWS KMS) key that Amazon SageMaker uses to encrypt data from a Redshift execution.
outputCompression?	string	The compression used for Redshift query results.

---

clusterId

Type: string

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

---

clusterRoleArn

Type: string

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

---

database

Type: string

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

---

dbUser

Type: string

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

---

outputFormat

Type: string

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

---

outputS3Uri

Type: string

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

---

queryString

Type: string

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

---

kmsKeyId?

Type: string (optional)

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

---

outputCompression?

Type: string (optional)

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