RedshiftDatasetDefinition: DatasetDefinition for Redshift.

In DyfanJones/sagemaker-r-common: R6sagemaker lower level api calls

DatasetDefinition for Redshift.

Description

With this input, SQL queries will be executed using Redshift to generate datasets to S3.

Super class

sagemaker.core::ApiObject -> RedshiftDatasetDefinition

Methods

Public methods

• RedshiftDatasetDefinition$new()

• RedshiftDatasetDefinition$clone()

Inherited methods

• sagemaker.core::ApiObject$format()
• sagemaker.core::ApiObject$from_paws()
• sagemaker.core::ApiObject$to_paws()

---

Method new()

Initialize RedshiftDatasetDefinition.

Usage

RedshiftDatasetDefinition$new(
  cluster_id = NULL,
  database = NULL,
  db_user = NULL,
  query_string = NULL,
  cluster_role_arn = NULL,
  output_s3_uri = NULL,
  kms_key_id = NULL,
  output_format = NULL,
  output_compression = NULL
)

Arguments

cluster_id

(str, default=None): The Redshift cluster Identifier. database (str, default=None): The name of the Redshift database used in Redshift query execution.

database

(str, default=None): The name of the Redshift database used in Redshift query execution.

db_user

(str, default=None): The database user name used in Redshift query execution.

query_string

(str, default=None): The SQL query statements to be executed.

cluster_role_arn

(str, default=None): The IAM role attached to your Redshift cluster that Amazon SageMaker uses to generate datasets.

output_s3_uri

(str, default=None): The location in Amazon S3 where the Redshift query results are stored.

kms_key_id

(str, default=None): The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt data from a Redshift execution.

output_format

(str, default=None): The data storage format for Redshift query results. Valid options are "PARQUET", "CSV"

output_compression

(str, default=None): The compression used for Redshift query results. Valid options are "None", "GZIP", "SNAPPY", "ZSTD", "BZIP2"

---

Method clone()

The objects of this class are cloneable with this method.

Usage

RedshiftDatasetDefinition$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

DyfanJones/sagemaker-r-common documentation built on June 14, 2022, 10:31 p.m.