AWS::SageMaker::ProcessingJob RedshiftDatasetDefinition - AWS CloudFormation
SyntaxProperties

This is the new AWS CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::SageMaker::ProcessingJob RedshiftDatasetDefinition

Configuration for Redshift Dataset Definition input.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "ClusterId" : String,
  "ClusterRoleArn" : String,
  "Database" : String,
  "DbUser" : String,
  "KmsKeyId" : String,
  "OutputCompression" : String,
  "OutputFormat" : String,
  "OutputS3Uri" : String,
  "QueryString" : String
}

YAML

  ClusterId: String
  ClusterRoleArn: String
  Database: String
  DbUser: String
  KmsKeyId: String
  OutputCompression: String
  OutputFormat: String
  OutputS3Uri: String
  QueryString: 
    String

Properties

ClusterId

The Redshift cluster Identifier.

Required: Yes

Type: String

Pattern: .*

Maximum: 63

Update requires: Replacement

ClusterRoleArn

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

Required: Yes

Type: String

Pattern: arn:aws[a-z\-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+

Minimum: 20

Maximum: 2048

Update requires: Replacement

Database

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

Required: Yes

Type: String

Pattern: .*

Maximum: 64

Update requires: Replacement

DbUser

The database user name used in Redshift query execution.

Required: Yes

Type: String

Pattern: .*

Maximum: 128

Update requires: Replacement

KmsKeyId

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

Required: No

Type: String

Pattern: [a-zA-Z0-9:/_-]*

Minimum: 0

Maximum: 2048

Update requires: Replacement

OutputCompression

The compression used for Redshift query results.

Required: No

Type: String

Allowed values: None | GZIP | SNAPPY | ZSTD | BZIP2

Update requires: Replacement

OutputFormat

The data storage format for Redshift query results.

Required: Yes

Type: String

Allowed values: PARQUET | CSV

Update requires: Replacement

OutputS3Uri

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

Required: Yes

Type: String

Pattern: (https|s3)://([^/]+)/?(.*)

Minimum: 0

Maximum: 1024

Update requires: Replacement

QueryString

The SQL query statements to be executed.

Required: Yes

Type: String

Pattern: [\s\S]+

Maximum: 4096

Update requires: Replacement