Skip to content

RedshiftDestinationDescription

Source code in docs_src/capo_firehose/types/redshift_destination_description.py
class RedshiftDestinationDescription(TypedDict, closed=True):
    role_arn: "capo_firehose.types.role_arn.RoleARN"
    """<p>The Amazon Resource Name (ARN) of the Amazon Web Services credentials. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces</a>.</p>"""
    cluster_jdbcurl: "capo_firehose.types.cluster_jdbcurl.ClusterJDBCURL"
    """<p>The database connection string.</p>"""
    copy_command: "capo_firehose.types.copy_command.CopyCommand"
    """<p>The <code>COPY</code> command.</p>"""
    username: NotRequired["capo_firehose.types.username.Username"]
    """<p>The name of the user.</p>"""
    retry_options: NotRequired[
        "capo_firehose.types.redshift_retry_options.RedshiftRetryOptions"
    ]
    """<p>The retry behavior in case Firehose is unable to deliver documents to Amazon Redshift. Default value is 3600 (60 minutes).</p>"""
    s3_destination_description: (
        "capo_firehose.types.s3_destination_description.S3DestinationDescription"
    )
    """<p>The Amazon S3 destination.</p>"""
    processing_configuration: NotRequired[
        "capo_firehose.types.processing_configuration.ProcessingConfiguration"
    ]
    """<p>The data processing configuration.</p>"""
    s3_backup_mode: NotRequired[
        "capo_firehose.types.redshift_s3_backup_mode.RedshiftS3BackupMode"
    ]
    """<p>The Amazon S3 backup mode.</p>"""
    s3_backup_description: NotRequired[
        "capo_firehose.types.s3_destination_description.S3DestinationDescription"
    ]
    """<p>The configuration for backup in Amazon S3.</p>"""
    cloud_watch_logging_options: NotRequired[
        "capo_firehose.types.cloud_watch_logging_options.CloudWatchLoggingOptions"
    ]
    """<p>The Amazon CloudWatch logging options for your Firehose stream.</p>"""
    secrets_manager_configuration: NotRequired[
        "capo_firehose.types.secrets_manager_configuration.SecretsManagerConfiguration"
    ]
    """<p> The configuration that defines how you access secrets for Amazon Redshift. </p>"""

cloud_watch_logging_options instance-attribute

cloud_watch_logging_options: NotRequired[CloudWatchLoggingOptions]

The Amazon CloudWatch logging options for your Firehose stream.

cluster_jdbcurl instance-attribute

cluster_jdbcurl: ClusterJDBCURL

The database connection string.

copy_command instance-attribute

copy_command: CopyCommand

The COPY command.

processing_configuration instance-attribute

processing_configuration: NotRequired[ProcessingConfiguration]

The data processing configuration.

retry_options instance-attribute

retry_options: NotRequired[RedshiftRetryOptions]

The retry behavior in case Firehose is unable to deliver documents to Amazon Redshift. Default value is 3600 (60 minutes).

role_arn instance-attribute

role_arn: RoleARN

The Amazon Resource Name (ARN) of the Amazon Web Services credentials. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.

s3_backup_description instance-attribute

s3_backup_description: NotRequired[S3DestinationDescription]

The configuration for backup in Amazon S3.

s3_backup_mode instance-attribute

s3_backup_mode: NotRequired[RedshiftS3BackupMode]

The Amazon S3 backup mode.

s3_destination_description instance-attribute

s3_destination_description: S3DestinationDescription

The Amazon S3 destination.

secrets_manager_configuration instance-attribute

secrets_manager_configuration: NotRequired[SecretsManagerConfiguration]

The configuration that defines how you access secrets for Amazon Redshift.

username instance-attribute

username: NotRequired[Username]

The name of the user.