Skip to content

PipeTargetRedshiftDataParameters

Source code in docs_src/capo_pipes/types/pipe_target_redshift_data_parameters.py 
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
class PipeTargetRedshiftDataParameters(TypedDict, closed=True):
    secret_manager_arn: NotRequired[
        "capo_pipes.types.secret_manager_arn_or_json_path.SecretManagerArnOrJsonPath"
    ]
    """<p>The name or ARN of the secret that enables access to the database. Required when authenticating using Secrets Manager.</p>"""
    database: "capo_pipes.types.database.Database"
    """<p>The name of the database. Required when authenticating using temporary credentials.</p>"""
    db_user: NotRequired["capo_pipes.types.db_user.DbUser"]
    """<p>The database user name. Required when authenticating using temporary credentials.</p>"""
    statement_name: NotRequired["capo_pipes.types.statement_name.StatementName"]
    """<p>The name of the SQL statement. You can name the SQL statement when you create it to identify the query.</p>"""
    with_event: "capo_pipes.types.boolean.Boolean"
    """<p>Indicates whether to send an event back to EventBridge after the SQL statement runs.</p>"""
    sqls: "capo_pipes.types.sqls.Sqls"
    """<p>The SQL statement text to run.</p>"""

database instance-attribute 

database: Database

The name of the database. Required when authenticating using temporary credentials.

db_user instance-attribute 

db_user: NotRequired[DbUser]

The database user name. Required when authenticating using temporary credentials.

secret_manager_arn instance-attribute 

secret_manager_arn: NotRequired[SecretManagerArnOrJsonPath]

The name or ARN of the secret that enables access to the database. Required when authenticating using Secrets Manager.

sqls instance-attribute 

sqls: Sqls

The SQL statement text to run.

statement_name instance-attribute 

statement_name: NotRequired[StatementName]

The name of the SQL statement. You can name the SQL statement when you create it to identify the query.

with_event instance-attribute 

with_event: Boolean

Indicates whether to send an event back to EventBridge after the SQL statement runs.