Class: AWSCDK::Sagemaker::CfnProcessingJob::RedshiftDatasetDefinitionProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
sagemaker/cfn_processing_job.rb

Overview

Configuration for Redshift Dataset Definition input.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(cluster_id:, cluster_role_arn:, database:, db_user:, output_format:, output_s3_uri:, query_string:, kms_key_id: nil, output_compression: nil) ⇒ RedshiftDatasetDefinitionProperty

Returns a new instance of RedshiftDatasetDefinitionProperty.

Parameters:

  • cluster_id (String) —

    The Redshift cluster Identifier.

  • cluster_role_arn (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.

  • db_user (String) —

    The database user name used in Redshift query execution.

  • output_format (String) —

    The data storage format for Redshift query results.

  • output_s3_uri (String) —

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

  • query_string (String) —

    The SQL query statements to be executed.

  • kms_key_id (String, nil) (defaults to: nil) —

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

  • output_compression (String, nil) (defaults to: nil) —

    The compression used for Redshift query results.



1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
 
# File 'sagemaker/cfn_processing_job.rb', line 1437

def initialize(cluster_id:, cluster_role_arn:, database:, db_user:, output_format:, output_s3_uri:, query_string:, kms_key_id: nil, output_compression: nil)
  @cluster_id = cluster_id
  Jsii::Type.check_type(@cluster_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "clusterId")
  @cluster_role_arn = cluster_role_arn
  Jsii::Type.check_type(@cluster_role_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "clusterRoleArn")
  @database = database
  Jsii::Type.check_type(@database, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "database")
  @db_user = db_user
  Jsii::Type.check_type(@db_user, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "dbUser")
  @output_format = output_format
  Jsii::Type.check_type(@output_format, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "outputFormat")
  @output_s3_uri = output_s3_uri
  Jsii::Type.check_type(@output_s3_uri, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "outputS3Uri")
  @query_string = query_string
  Jsii::Type.check_type(@query_string, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "queryString")
  @kms_key_id = kms_key_id
  Jsii::Type.check_type(@kms_key_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "kmsKeyId") unless @kms_key_id.nil?
  @output_compression = output_compression
  Jsii::Type.check_type(@output_compression, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "outputCompression") unless @output_compression.nil?
end

Instance Attribute Details

#cluster_id ⇒ String (readonly)

The Redshift cluster Identifier.

Returns:

  • (String)

See Also:



1462
1463
1464
 
# File 'sagemaker/cfn_processing_job.rb', line 1462

def cluster_id
  @cluster_id
end

#cluster_role_arn ⇒ String (readonly)

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

Returns:

  • (String)

See Also:



1467
1468
1469
 
# File 'sagemaker/cfn_processing_job.rb', line 1467

def cluster_role_arn
  @cluster_role_arn
end

#database ⇒ String (readonly)

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

Returns:

  • (String)

See Also:



1472
1473
1474
 
# File 'sagemaker/cfn_processing_job.rb', line 1472

def database
  @database
end

#db_user ⇒ String (readonly)

The database user name used in Redshift query execution.

Returns:

  • (String)

See Also:



1477
1478
1479
 
# File 'sagemaker/cfn_processing_job.rb', line 1477

def db_user
  @db_user
end

#kms_key_id ⇒ String? (readonly)

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

Returns:

  • (String, nil)

See Also:



1497
1498
1499
 
# File 'sagemaker/cfn_processing_job.rb', line 1497

def kms_key_id
  @kms_key_id
end

#output_compression ⇒ String? (readonly)

The compression used for Redshift query results.

Returns:

  • (String, nil)

See Also:



1502
1503
1504
 
# File 'sagemaker/cfn_processing_job.rb', line 1502

def output_compression
  @output_compression
end

#output_format ⇒ String (readonly)

The data storage format for Redshift query results.

Returns:

  • (String)

See Also:



1482
1483
1484
 
# File 'sagemaker/cfn_processing_job.rb', line 1482

def output_format
  @output_format
end

#output_s3_uri ⇒ String (readonly)

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

Returns:

  • (String)

See Also:



1487
1488
1489
 
# File 'sagemaker/cfn_processing_job.rb', line 1487

def output_s3_uri
  @output_s3_uri
end

#query_string ⇒ String (readonly)

The SQL query statements to be executed.

Returns:

  • (String)

See Also:



1492
1493
1494
 
# File 'sagemaker/cfn_processing_job.rb', line 1492

def query_string
  @query_string
end

Class Method Details

.jsii_properties ⇒ Object 



1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
 
# File 'sagemaker/cfn_processing_job.rb', line 1504

def self.jsii_properties
  {
    :cluster_id => "clusterId",
    :cluster_role_arn => "clusterRoleArn",
    :database => "database",
    :db_user => "dbUser",
    :output_format => "outputFormat",
    :output_s3_uri => "outputS3Uri",
    :query_string => "queryString",
    :kms_key_id => "kmsKeyId",
    :output_compression => "outputCompression",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
 
# File 'sagemaker/cfn_processing_job.rb', line 1518

def to_jsii
  result = {}
  result.merge!({
    "clusterId" => @cluster_id,
    "clusterRoleArn" => @cluster_role_arn,
    "database" => @database,
    "dbUser" => @db_user,
    "outputFormat" => @output_format,
    "outputS3Uri" => @output_s3_uri,
    "queryString" => @query_string,
    "kmsKeyId" => @kms_key_id,
    "outputCompression" => @output_compression,
  })
  result.compact
end