AWS CDK Reference

Appearance

v2.275.0

RedshiftDatasetDefinitionProperty Struct ​

Configuration for Redshift 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 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 ​

clusterIdstringcluster_idstrclusterIdStringClusterIdstringClusterId*stringrequired#
The Redshift cluster Identifier.
clusterRoleArnstringcluster_role_arnstrclusterRoleArnStringClusterRoleArnstringClusterRoleArn*stringrequired#
The IAM role attached to your Redshift cluster that Amazon SageMaker uses to generate datasets.
databasestringdatabasestrdatabaseStringDatabasestringDatabase*stringrequired#
The name of the Redshift database used in Redshift query execution.
dbUserstringdb_userstrdbUserStringDbUserstringDbUser*stringrequired#
The database user name used in Redshift query execution.
kmsKeyIdoptionalstringkms_key_idoptionalstrkmsKeyIdoptionalStringKmsKeyIdoptionalstringKmsKeyIdoptional*string#
The AWS Key Management Service ( AWS KMS) key that Amazon SageMaker uses to encrypt data from a Redshift execution.
outputCompressionoptionalstringoutput_compressionoptionalstroutputCompressionoptionalStringOutputCompressionoptionalstringOutputCompressionoptional*string#
The compression used for Redshift query results.
outputFormatstringoutput_formatstroutputFormatStringOutputFormatstringOutputFormat*stringrequired#
The data storage format for Redshift query results.
outputS3Uristringoutput_s3_uristroutputS3UriStringOutputS3UristringOutputS3Uri*stringrequired#
The location in Amazon S3 where the Redshift query results are stored.
queryStringstringquery_stringstrqueryStringStringQueryStringstringQueryString*stringrequired#
The SQL query statements to be executed.