Skip to content

RedshiftDataParameters

Source code in docs_src/capo_eventbridge/types/redshift_data_parameters.py
class RedshiftDataParameters(TypedDict, closed=True):
    secret_manager_arn: NotRequired[
        "capo_eventbridge.types.redshift_secret_manager_arn.RedshiftSecretManagerArn"
    ]
    """<p>The name or ARN of the secret that enables access to the database. Required when authenticating using Amazon Web Services Secrets Manager.</p>"""
    database: "capo_eventbridge.types.database.Database"
    """<p>The name of the database. Required when authenticating using temporary credentials.</p>"""
    db_user: NotRequired["capo_eventbridge.types.db_user.DbUser"]
    """<p>The database user name. Required when authenticating using temporary credentials.</p>"""
    sql: NotRequired["capo_eventbridge.types.sql.Sql"]
    """<p>The SQL statement text to run.</p>"""
    statement_name: NotRequired["capo_eventbridge.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_eventbridge.types.boolean.Boolean"
    """<p>Indicates whether to send an event back to EventBridge after the SQL statement runs.</p>"""
    sqls: NotRequired["capo_eventbridge.types.sqls.Sqls"]
    """<p>One or more SQL statements to run. The SQL statements are run as a single transaction. They run serially in the order of the array. Subsequent SQL statements don't start until the previous statement in the array completes. If any SQL statement fails, then because they are run as one transaction, all work is rolled back.</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[RedshiftSecretManagerArn]

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

sql instance-attribute

sql: NotRequired[Sql]

The SQL statement text to run.

sqls instance-attribute

sqls: NotRequired[Sqls]

One or more SQL statements to run. The SQL statements are run as a single transaction. They run serially in the order of the array. Subsequent SQL statements don't start until the previous statement in the array completes. If any SQL statement fails, then because they are run as one transaction, all work is rolled back.

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.