Skip to content

SnowflakeDestinationUpdate

Source code in docs_src/capo_firehose/types/snowflake_destination_update.py
class SnowflakeDestinationUpdate(TypedDict, closed=True):
    account_url: NotRequired[
        "capo_firehose.types.snowflake_account_url.SnowflakeAccountUrl"
    ]
    """<p>URL for accessing your Snowflake account. This URL must include your <a href="https://docs.snowflake.com/en/user-guide/admin-account-identifier">account identifier</a>. Note that the protocol (https://) and port number are optional.</p>"""
    private_key: NotRequired[
        "capo_firehose.types.snowflake_private_key.SnowflakePrivateKey"
    ]
    """<p>The private key used to encrypt your Snowflake client. For information, see <a href="https://docs.snowflake.com/en/user-guide/data-load-snowpipe-streaming-configuration#using-key-pair-authentication-key-rotation">Using Key Pair Authentication & Key Rotation</a>.</p>"""
    key_passphrase: NotRequired[
        "capo_firehose.types.snowflake_key_passphrase.SnowflakeKeyPassphrase"
    ]
    """<p>Passphrase to decrypt the private key when the key is encrypted. For information, see <a href="https://docs.snowflake.com/en/user-guide/data-load-snowpipe-streaming-configuration#using-key-pair-authentication-key-rotation">Using Key Pair Authentication & Key Rotation</a>.</p>"""
    user: NotRequired["capo_firehose.types.snowflake_user.SnowflakeUser"]
    """<p>User login name for the Snowflake account.</p>"""
    database: NotRequired["capo_firehose.types.snowflake_database.SnowflakeDatabase"]
    """<p>All data in Snowflake is maintained in databases.</p>"""
    schema: NotRequired["capo_firehose.types.snowflake_schema.SnowflakeSchema"]
    """<p>Each database consists of one or more schemas, which are logical groupings of database objects, such as tables and views</p>"""
    table: NotRequired["capo_firehose.types.snowflake_table.SnowflakeTable"]
    """<p>All data in Snowflake is stored in database tables, logically structured as collections of columns and rows.</p>"""
    snowflake_role_configuration: NotRequired[
        "capo_firehose.types.snowflake_role_configuration.SnowflakeRoleConfiguration"
    ]
    """<p>Optionally configure a Snowflake role. Otherwise the default user role will be used.</p>"""
    data_loading_option: NotRequired[
        "capo_firehose.types.snowflake_data_loading_option.SnowflakeDataLoadingOption"
    ]
    """<p> JSON keys mapped to table column names or choose to split the JSON payload where content is mapped to a record content column and source metadata is mapped to a record metadata column.</p>"""
    meta_data_column_name: NotRequired[
        "capo_firehose.types.snowflake_meta_data_column_name.SnowflakeMetaDataColumnName"
    ]
    """<p>The name of the record metadata column</p>"""
    content_column_name: NotRequired[
        "capo_firehose.types.snowflake_content_column_name.SnowflakeContentColumnName"
    ]
    """<p>The name of the content metadata column</p>"""
    cloud_watch_logging_options: NotRequired[
        "capo_firehose.types.cloud_watch_logging_options.CloudWatchLoggingOptions"
    ]
    processing_configuration: NotRequired[
        "capo_firehose.types.processing_configuration.ProcessingConfiguration"
    ]
    role_arn: NotRequired["capo_firehose.types.role_arn.RoleARN"]
    """<p>The Amazon Resource Name (ARN) of the Snowflake role</p>"""
    retry_options: NotRequired[
        "capo_firehose.types.snowflake_retry_options.SnowflakeRetryOptions"
    ]
    """<p>Specify how long Firehose retries sending data to the New Relic HTTP endpoint. After sending data, Firehose first waits for an acknowledgment from the HTTP endpoint. If an error occurs or the acknowledgment doesn’t arrive within the acknowledgment timeout period, Firehose starts the retry duration counter. It keeps retrying until the retry duration expires. After that, Firehose considers it a data delivery failure and backs up the data to your Amazon S3 bucket. Every time that Firehose sends data to the HTTP endpoint (either the initial attempt or a retry), it restarts the acknowledgement timeout counter and waits for an acknowledgement from the HTTP endpoint. Even if the retry duration expires, Firehose still waits for the acknowledgment until it receives it or the acknowledgement timeout period is reached. If the acknowledgment times out, Firehose determines whether there's time left in the retry counter. If there is time left, it retries again and repeats the logic until it receives an acknowledgment or determines that the retry time has expired. If you don't want Firehose to retry sending data, set this value to 0.</p>"""
    s3_backup_mode: NotRequired[
        "capo_firehose.types.snowflake_s3_backup_mode.SnowflakeS3BackupMode"
    ]
    """<p>Choose an S3 backup mode. Once you set the mode as <code>AllData</code>, you can not change it to <code>FailedDataOnly</code>.</p>"""
    s3_update: NotRequired[
        "capo_firehose.types.s3_destination_update.S3DestinationUpdate"
    ]
    secrets_manager_configuration: NotRequired[
        "capo_firehose.types.secrets_manager_configuration.SecretsManagerConfiguration"
    ]
    """<p> Describes the Secrets Manager configuration in Snowflake. </p>"""
    buffering_hints: NotRequired[
        "capo_firehose.types.snowflake_buffering_hints.SnowflakeBufferingHints"
    ]
    """<p> Describes the buffering to perform before delivering data to the Snowflake destination. </p>"""

account_url instance-attribute

account_url: NotRequired[SnowflakeAccountUrl]

URL for accessing your Snowflake account. This URL must include your account identifier. Note that the protocol (https://) and port number are optional.

buffering_hints instance-attribute

buffering_hints: NotRequired[SnowflakeBufferingHints]

Describes the buffering to perform before delivering data to the Snowflake destination.

cloud_watch_logging_options instance-attribute

cloud_watch_logging_options: NotRequired[CloudWatchLoggingOptions]

content_column_name instance-attribute

content_column_name: NotRequired[SnowflakeContentColumnName]

The name of the content metadata column

data_loading_option instance-attribute

data_loading_option: NotRequired[SnowflakeDataLoadingOption]

JSON keys mapped to table column names or choose to split the JSON payload where content is mapped to a record content column and source metadata is mapped to a record metadata column.

database instance-attribute

database: NotRequired[SnowflakeDatabase]

All data in Snowflake is maintained in databases.

key_passphrase instance-attribute

key_passphrase: NotRequired[SnowflakeKeyPassphrase]

Passphrase to decrypt the private key when the key is encrypted. For information, see Using Key Pair Authentication & Key Rotation.

meta_data_column_name instance-attribute

meta_data_column_name: NotRequired[SnowflakeMetaDataColumnName]

The name of the record metadata column

private_key instance-attribute

private_key: NotRequired[SnowflakePrivateKey]

The private key used to encrypt your Snowflake client. For information, see Using Key Pair Authentication & Key Rotation.

processing_configuration instance-attribute

processing_configuration: NotRequired[ProcessingConfiguration]

retry_options instance-attribute

retry_options: NotRequired[SnowflakeRetryOptions]

Specify how long Firehose retries sending data to the New Relic HTTP endpoint. After sending data, Firehose first waits for an acknowledgment from the HTTP endpoint. If an error occurs or the acknowledgment doesn’t arrive within the acknowledgment timeout period, Firehose starts the retry duration counter. It keeps retrying until the retry duration expires. After that, Firehose considers it a data delivery failure and backs up the data to your Amazon S3 bucket. Every time that Firehose sends data to the HTTP endpoint (either the initial attempt or a retry), it restarts the acknowledgement timeout counter and waits for an acknowledgement from the HTTP endpoint. Even if the retry duration expires, Firehose still waits for the acknowledgment until it receives it or the acknowledgement timeout period is reached. If the acknowledgment times out, Firehose determines whether there's time left in the retry counter. If there is time left, it retries again and repeats the logic until it receives an acknowledgment or determines that the retry time has expired. If you don't want Firehose to retry sending data, set this value to 0.

role_arn instance-attribute

role_arn: NotRequired[RoleARN]

The Amazon Resource Name (ARN) of the Snowflake role

s3_backup_mode instance-attribute

s3_backup_mode: NotRequired[SnowflakeS3BackupMode]

Choose an S3 backup mode. Once you set the mode as AllData, you can not change it to FailedDataOnly.

s3_update instance-attribute

s3_update: NotRequired[S3DestinationUpdate]

schema instance-attribute

schema: NotRequired[SnowflakeSchema]

Each database consists of one or more schemas, which are logical groupings of database objects, such as tables and views

secrets_manager_configuration instance-attribute

secrets_manager_configuration: NotRequired[SecretsManagerConfiguration]

Describes the Secrets Manager configuration in Snowflake.

snowflake_role_configuration instance-attribute

snowflake_role_configuration: NotRequired[SnowflakeRoleConfiguration]

Optionally configure a Snowflake role. Otherwise the default user role will be used.

table instance-attribute

table: NotRequired[SnowflakeTable]

All data in Snowflake is stored in database tables, logically structured as collections of columns and rows.

user instance-attribute

user: NotRequired[SnowflakeUser]

User login name for the Snowflake account.