eventbridge/aws.sdk.kotlin.services.eventbridge.model/RedshiftDataParameters

RedshiftDataParameters

These are custom parameters to be used when the target is a Amazon Redshift cluster to invoke the Amazon Redshift Data API ExecuteStatement based on EventBridge events.

Types

Builder

class Builder

Companion

object Companion

Properties

database

val database: String

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

dbUser

val dbUser: String?

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

secretManagerArn

val secretManagerArn: String?

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

sql

val sql: String?

The SQL statement text to run.

sqls

val sqls: List<String>?

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.

statementName

val statementName: String?

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

withEvent

val withEvent: Boolean

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

Functions

copy

inline fun copy(block: RedshiftDataParameters.Builder.() -> Unit = {}): RedshiftDataParameters

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String