Configuration for Redshift Dataset Definition input.
Contents
- ClusterId
-
The Redshift cluster Identifier.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern:
.*Required: Yes
- ClusterRoleArn
-
The IAM role attached to your Redshift cluster that Amazon SageMaker uses to generate datasets.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Pattern:
^arn:aws[a-z\-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+$Required: Yes
- Database
-
The name of the Redshift database used in Redshift query execution.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
.*Required: Yes
- DbUser
-
The database user name used in Redshift query execution.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
.*Required: Yes
- OutputFormat
-
The data storage format for Redshift query results.
Type: String
Valid Values:
PARQUET | CSVRequired: Yes
- OutputS3Uri
-
The location in Amazon S3 where the Redshift query results are stored.
Type: String
Length Constraints: Maximum length of 1024.
Pattern:
^(https|s3)://([^/]+)/?(.*)$Required: Yes
- QueryString
-
The SQL query statements to be executed.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 4096.
Pattern:
[\s\S]+Required: Yes
- KmsKeyId
-
The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt data from a Redshift execution.
Type: String
Length Constraints: Maximum length of 2048.
Pattern:
^[a-zA-Z0-9:/_-]*$Required: No
- OutputCompression
-
The compression used for Redshift query results.
Type: String
Valid Values:
None | GZIP | BZIP2 | ZSTD | SNAPPYRequired: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
