Skip to content

RedshiftDatasetDefinition

Source code in docs_src/capo_sagemaker/types/redshift_dataset_definition.py
class RedshiftDatasetDefinition(TypedDict, closed=True):
    cluster_id: NotRequired[
        "capo_sagemaker.types.redshift_cluster_id.RedshiftClusterId"
    ]
    database: NotRequired["capo_sagemaker.types.redshift_database.RedshiftDatabase"]
    db_user: NotRequired["capo_sagemaker.types.redshift_user_name.RedshiftUserName"]
    query_string: NotRequired[
        "capo_sagemaker.types.redshift_query_string.RedshiftQueryString"
    ]
    cluster_role_arn: NotRequired["capo_sagemaker.types.role_arn.RoleArn"]
    """<p>The IAM role attached to your Redshift cluster that Amazon SageMaker uses to generate datasets.</p>"""
    output_s3_uri: NotRequired["capo_sagemaker.types.s3_uri.S3Uri"]
    """<p>The location in Amazon S3 where the Redshift query results are stored.</p>"""
    kms_key_id: NotRequired["capo_sagemaker.types.kms_key_id.KmsKeyId"]
    """<p>The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data from a Redshift execution.</p>"""
    output_format: NotRequired[
        "capo_sagemaker.types.redshift_result_format.RedshiftResultFormat"
    ]
    output_compression: NotRequired[
        "capo_sagemaker.types.redshift_result_compression_type.RedshiftResultCompressionType"
    ]

cluster_id instance-attribute

cluster_id: NotRequired[RedshiftClusterId]

cluster_role_arn instance-attribute

cluster_role_arn: NotRequired[RoleArn]

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

database instance-attribute

database: NotRequired[RedshiftDatabase]

db_user instance-attribute

db_user: NotRequired[RedshiftUserName]

kms_key_id instance-attribute

kms_key_id: NotRequired[KmsKeyId]

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

output_compression instance-attribute

output_compression: NotRequired[RedshiftResultCompressionType]

output_format instance-attribute

output_format: NotRequired[RedshiftResultFormat]

output_s3_uri instance-attribute

output_s3_uri: NotRequired[S3Uri]

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

query_string instance-attribute

query_string: NotRequired[RedshiftQueryString]