Class: Aws::SageMaker::Types::RedshiftDatasetDefinition

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb

Overview

Note:

When making an API call, you may pass RedshiftDatasetDefinition data as a hash:

{
  cluster_id: "RedshiftClusterId", # required
  database: "RedshiftDatabase", # required
  db_user: "RedshiftUserName", # required
  query_string: "RedshiftQueryString", # required
  cluster_role_arn: "RoleArn", # required
  output_s3_uri: "S3Uri", # required
  kms_key_id: "KmsKeyId",
  output_format: "PARQUET", # required, accepts PARQUET, CSV
  output_compression: "None", # accepts None, GZIP, BZIP2, ZSTD, SNAPPY
}

Configuration for Redshift Dataset Definition input.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#cluster_idString

The Redshift cluster Identifier.

Returns:

  • (String)


35585
35586
35587
35588
35589
35590
35591
35592
35593
35594
35595
35596
35597
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 35585

class RedshiftDatasetDefinition < Struct.new(
  :cluster_id,
  :database,
  :db_user,
  :query_string,
  :cluster_role_arn,
  :output_s3_uri,
  :kms_key_id,
  :output_format,
  :output_compression)
  SENSITIVE = []
  include Aws::Structure
end

#cluster_role_arnString

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

Returns:

  • (String)


35585
35586
35587
35588
35589
35590
35591
35592
35593
35594
35595
35596
35597
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 35585

class RedshiftDatasetDefinition < Struct.new(
  :cluster_id,
  :database,
  :db_user,
  :query_string,
  :cluster_role_arn,
  :output_s3_uri,
  :kms_key_id,
  :output_format,
  :output_compression)
  SENSITIVE = []
  include Aws::Structure
end

#databaseString

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

Returns:

  • (String)


35585
35586
35587
35588
35589
35590
35591
35592
35593
35594
35595
35596
35597
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 35585

class RedshiftDatasetDefinition < Struct.new(
  :cluster_id,
  :database,
  :db_user,
  :query_string,
  :cluster_role_arn,
  :output_s3_uri,
  :kms_key_id,
  :output_format,
  :output_compression)
  SENSITIVE = []
  include Aws::Structure
end

#db_userString

The database user name used in Redshift query execution.

Returns:

  • (String)


35585
35586
35587
35588
35589
35590
35591
35592
35593
35594
35595
35596
35597
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 35585

class RedshiftDatasetDefinition < Struct.new(
  :cluster_id,
  :database,
  :db_user,
  :query_string,
  :cluster_role_arn,
  :output_s3_uri,
  :kms_key_id,
  :output_format,
  :output_compression)
  SENSITIVE = []
  include Aws::Structure
end

#kms_key_idString

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

Returns:

  • (String)


35585
35586
35587
35588
35589
35590
35591
35592
35593
35594
35595
35596
35597
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 35585

class RedshiftDatasetDefinition < Struct.new(
  :cluster_id,
  :database,
  :db_user,
  :query_string,
  :cluster_role_arn,
  :output_s3_uri,
  :kms_key_id,
  :output_format,
  :output_compression)
  SENSITIVE = []
  include Aws::Structure
end

#output_compressionString

The compression used for Redshift query results.

Returns:

  • (String)


35585
35586
35587
35588
35589
35590
35591
35592
35593
35594
35595
35596
35597
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 35585

class RedshiftDatasetDefinition < Struct.new(
  :cluster_id,
  :database,
  :db_user,
  :query_string,
  :cluster_role_arn,
  :output_s3_uri,
  :kms_key_id,
  :output_format,
  :output_compression)
  SENSITIVE = []
  include Aws::Structure
end

#output_formatString

The data storage format for Redshift query results.

Returns:

  • (String)


35585
35586
35587
35588
35589
35590
35591
35592
35593
35594
35595
35596
35597
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 35585

class RedshiftDatasetDefinition < Struct.new(
  :cluster_id,
  :database,
  :db_user,
  :query_string,
  :cluster_role_arn,
  :output_s3_uri,
  :kms_key_id,
  :output_format,
  :output_compression)
  SENSITIVE = []
  include Aws::Structure
end

#output_s3_uriString

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

Returns:

  • (String)


35585
35586
35587
35588
35589
35590
35591
35592
35593
35594
35595
35596
35597
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 35585

class RedshiftDatasetDefinition < Struct.new(
  :cluster_id,
  :database,
  :db_user,
  :query_string,
  :cluster_role_arn,
  :output_s3_uri,
  :kms_key_id,
  :output_format,
  :output_compression)
  SENSITIVE = []
  include Aws::Structure
end

#query_stringString

The SQL query statements to be executed.

Returns:

  • (String)


35585
35586
35587
35588
35589
35590
35591
35592
35593
35594
35595
35596
35597
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 35585

class RedshiftDatasetDefinition < Struct.new(
  :cluster_id,
  :database,
  :db_user,
  :query_string,
  :cluster_role_arn,
  :output_s3_uri,
  :kms_key_id,
  :output_format,
  :output_compression)
  SENSITIVE = []
  include Aws::Structure
end