Skip to content

AmazonRedshiftNodeData

Source code in docs_src/capo_glue/types/amazon_redshift_node_data.py
class AmazonRedshiftNodeData(TypedDict, closed=True):
    access_type: NotRequired[
        "capo_glue.types.generic_limited_string.GenericLimitedString"
    ]
    """<p>The access type for the Redshift connection. Can be a direct connection or catalog connections.</p>"""
    source_type: NotRequired[
        "capo_glue.types.generic_limited_string.GenericLimitedString"
    ]
    """<p>The source type to specify whether a specific table is the source or a custom query.</p>"""
    connection: NotRequired["capo_glue.types.option.Option"]
    """<p>The Glue connection to the Redshift cluster.</p>"""
    schema: NotRequired["capo_glue.types.option.Option"]
    """<p>The Redshift schema name when working with a direct connection.</p>"""
    table: NotRequired["capo_glue.types.option.Option"]
    """<p>The Redshift table name when working with a direct connection.</p>"""
    catalog_database: NotRequired["capo_glue.types.option.Option"]
    """<p>The name of the Glue Data Catalog database when working with a data catalog.</p>"""
    catalog_table: NotRequired["capo_glue.types.option.Option"]
    """<p>The Glue Data Catalog table name when working with a data catalog.</p>"""
    catalog_redshift_schema: NotRequired["capo_glue.types.generic_string.GenericString"]
    """<p>The Redshift schema name when working with a data catalog.</p>"""
    catalog_redshift_table: NotRequired["capo_glue.types.generic_string.GenericString"]
    """<p>The database table to read from.</p>"""
    temp_dir: NotRequired[
        "capo_glue.types.enclosed_in_string_property.EnclosedInStringProperty"
    ]
    """<p>The Amazon S3 path where temporary data can be staged when copying out of the database.</p>"""
    iam_role: NotRequired["capo_glue.types.option.Option"]
    """<p>Optional. The role name use when connection to S3. The IAM role ill default to the role on the job when left blank.</p>"""
    advanced_options: NotRequired[
        "capo_glue.types.amazon_redshift_advanced_options.AmazonRedshiftAdvancedOptions"
    ]
    """<p>Optional values when connecting to the Redshift cluster.</p>"""
    sample_query: NotRequired["capo_glue.types.generic_string.GenericString"]
    """<p>The SQL used to fetch the data from a Redshift sources when the SourceType is 'query'.</p>"""
    pre_action: NotRequired["capo_glue.types.generic_string.GenericString"]
    """<p>The SQL used before a MERGE or APPEND with upsert is run.</p>"""
    post_action: NotRequired["capo_glue.types.generic_string.GenericString"]
    """<p>The SQL used before a MERGE or APPEND with upsert is run.</p>"""
    action: NotRequired["capo_glue.types.generic_string.GenericString"]
    """<p>Specifies how writing to a Redshift cluser will occur.</p>"""
    table_prefix: NotRequired[
        "capo_glue.types.generic_limited_string.GenericLimitedString"
    ]
    """<p>Specifies the prefix to a table.</p>"""
    upsert: "capo_glue.types.boolean_value.BooleanValue"
    """<p>The action used on Redshift sinks when doing an APPEND.</p>"""
    merge_action: NotRequired[
        "capo_glue.types.generic_limited_string.GenericLimitedString"
    ]
    """<p>The action used when to detemine how a MERGE in a Redshift sink will be handled.</p>"""
    merge_when_matched: NotRequired[
        "capo_glue.types.generic_limited_string.GenericLimitedString"
    ]
    """<p>The action used when to detemine how a MERGE in a Redshift sink will be handled when an existing record matches a new record.</p>"""
    merge_when_not_matched: NotRequired[
        "capo_glue.types.generic_limited_string.GenericLimitedString"
    ]
    """<p>The action used when to detemine how a MERGE in a Redshift sink will be handled when an existing record doesn't match a new record.</p>"""
    merge_clause: NotRequired["capo_glue.types.generic_string.GenericString"]
    """<p>The SQL used in a custom merge to deal with matching records.</p>"""
    crawler_connection: NotRequired["capo_glue.types.generic_string.GenericString"]
    """<p>Specifies the name of the connection that is associated with the catalog table used.</p>"""
    table_schema: NotRequired["capo_glue.types.option_list.OptionList"]
    """<p>The array of schema output for a given node.</p>"""
    staging_table: NotRequired["capo_glue.types.generic_string.GenericString"]
    """<p>The name of the temporary staging table that is used when doing a MERGE or APPEND with upsert.</p>"""
    selected_columns: NotRequired["capo_glue.types.option_list.OptionList"]
    """<p>The list of column names used to determine a matching record when doing a MERGE or APPEND with upsert.</p>"""

access_type instance-attribute

access_type: NotRequired[GenericLimitedString]

The access type for the Redshift connection. Can be a direct connection or catalog connections.

action instance-attribute

action: NotRequired[GenericString]

Specifies how writing to a Redshift cluser will occur.

advanced_options instance-attribute

advanced_options: NotRequired[AmazonRedshiftAdvancedOptions]

Optional values when connecting to the Redshift cluster.

catalog_database instance-attribute

catalog_database: NotRequired[Option]

The name of the Glue Data Catalog database when working with a data catalog.

catalog_redshift_schema instance-attribute

catalog_redshift_schema: NotRequired[GenericString]

The Redshift schema name when working with a data catalog.

catalog_redshift_table instance-attribute

catalog_redshift_table: NotRequired[GenericString]

The database table to read from.

catalog_table instance-attribute

catalog_table: NotRequired[Option]

The Glue Data Catalog table name when working with a data catalog.

connection instance-attribute

connection: NotRequired[Option]

The Glue connection to the Redshift cluster.

crawler_connection instance-attribute

crawler_connection: NotRequired[GenericString]

Specifies the name of the connection that is associated with the catalog table used.

iam_role instance-attribute

iam_role: NotRequired[Option]

Optional. The role name use when connection to S3. The IAM role ill default to the role on the job when left blank.

merge_action instance-attribute

merge_action: NotRequired[GenericLimitedString]

The action used when to detemine how a MERGE in a Redshift sink will be handled.

merge_clause instance-attribute

merge_clause: NotRequired[GenericString]

The SQL used in a custom merge to deal with matching records.

merge_when_matched instance-attribute

merge_when_matched: NotRequired[GenericLimitedString]

The action used when to detemine how a MERGE in a Redshift sink will be handled when an existing record matches a new record.

merge_when_not_matched instance-attribute

merge_when_not_matched: NotRequired[GenericLimitedString]

The action used when to detemine how a MERGE in a Redshift sink will be handled when an existing record doesn't match a new record.

post_action instance-attribute

post_action: NotRequired[GenericString]

The SQL used before a MERGE or APPEND with upsert is run.

pre_action instance-attribute

pre_action: NotRequired[GenericString]

The SQL used before a MERGE or APPEND with upsert is run.

sample_query instance-attribute

sample_query: NotRequired[GenericString]

The SQL used to fetch the data from a Redshift sources when the SourceType is 'query'.

schema instance-attribute

schema: NotRequired[Option]

The Redshift schema name when working with a direct connection.

selected_columns instance-attribute

selected_columns: NotRequired[OptionList]

The list of column names used to determine a matching record when doing a MERGE or APPEND with upsert.

source_type instance-attribute

source_type: NotRequired[GenericLimitedString]

The source type to specify whether a specific table is the source or a custom query.

staging_table instance-attribute

staging_table: NotRequired[GenericString]

The name of the temporary staging table that is used when doing a MERGE or APPEND with upsert.

table instance-attribute

table: NotRequired[Option]

The Redshift table name when working with a direct connection.

table_prefix instance-attribute

table_prefix: NotRequired[GenericLimitedString]

Specifies the prefix to a table.

table_schema instance-attribute

table_schema: NotRequired[OptionList]

The array of schema output for a given node.

temp_dir instance-attribute

temp_dir: NotRequired[EnclosedInStringProperty]

The Amazon S3 path where temporary data can be staged when copying out of the database.

upsert instance-attribute

upsert: BooleanValue

The action used on Redshift sinks when doing an APPEND.