redshiftdata/aws.sdk.kotlin.services.redshiftdata.model/ExecuteStatementRequest/Builder

Builder

Properties

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials.

database

var database: String?

The name of the database. This parameter is required when authenticating using either Secrets Manager or temporary credentials.

dbUser

var dbUser: String?

The database user name. This parameter is required when connecting to a cluster as a database user and authenticating using temporary credentials.

parameters

var parameters: List<SqlParameter>?

The parameters for the SQL statement.

resultFormat

var resultFormat: ResultFormatString?

The data format of the result of the SQL statement. If no format is specified, the default is JSON.

secretArn

var secretArn: String?

The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using Secrets Manager.

sessionId

var sessionId: String?

The session identifier of the query.

sessionKeepAliveSeconds

var sessionKeepAliveSeconds: Int?

The number of seconds to keep the session alive after the query finishes. The maximum time a session can keep alive is 24 hours. After 24 hours, the session is forced closed and the query is terminated.

sql

var sql: String?

The SQL statement text to run.

statementName

var statementName: String?

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

withEvent

var withEvent: Boolean?

A value that indicates whether to send an event to the Amazon EventBridge event bus after the SQL statement runs.

workgroupName

var workgroupName: String?

The serverless workgroup name or Amazon Resource Name (ARN). This parameter is required when connecting to a serverless workgroup and authenticating using either Secrets Manager or temporary credentials.