Package software.amazon.awscdk.services.events.targets

Class RedshiftQueryProps.Builder

java.lang.Object

software.amazon.awscdk.services.events.targets.RedshiftQueryProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<RedshiftQueryProps>

Enclosing interface:

RedshiftQueryProps

@Stability(Stable)
public static final class RedshiftQueryProps.Builder
extends Object
implements software.amazon.jsii.Builder<RedshiftQueryProps>

A builder for RedshiftQueryProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
RedshiftQueryProps	build()	Builds the configured instance.
RedshiftQueryProps.Builder	database(String database)	Sets the value of RedshiftQueryProps.getDatabase()
RedshiftQueryProps.Builder	dbUser(String dbUser)	Sets the value of RedshiftQueryProps.getDbUser()
RedshiftQueryProps.Builder	deadLetterQueue(IQueue deadLetterQueue)	Sets the value of RedshiftQueryProps.getDeadLetterQueue()
RedshiftQueryProps.Builder	input(RuleTargetInput input)	Sets the value of RedshiftQueryProps.getInput()
RedshiftQueryProps.Builder	role(IRole role)	Sets the value of RedshiftQueryProps.getRole()
RedshiftQueryProps.Builder	secret(ISecret secret)	Sets the value of RedshiftQueryProps.getSecret()
RedshiftQueryProps.Builder	sendEventBridgeEvent(Boolean sendEventBridgeEvent)	Sets the value of RedshiftQueryProps.getSendEventBridgeEvent()
RedshiftQueryProps.Builder	sql(List<String> sql)	Sets the value of RedshiftQueryProps.getSql()
RedshiftQueryProps.Builder	statementName(String statementName)	Sets the value of RedshiftQueryProps.getStatementName()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

database

@Stability(Stable)
public RedshiftQueryProps.Builder database(String database)

Sets the value of RedshiftQueryProps.getDatabase()

Parameters:

database - The Amazon Redshift database to run the query against. This parameter is required.

Returns:

this

sql

@Stability(Stable)
public RedshiftQueryProps.Builder sql(List<String> sql)

Sets the value of RedshiftQueryProps.getSql()

Parameters:

sql - The SQL queries to be executed. This parameter is required. Each query is run sequentially within a single transaction; the next query in the array will only execute after the previous one has successfully completed.

• When multiple sql queries are included, this will use the batchExecuteStatement API. Therefore, if any statement fails, the entire transaction is rolled back.
• If a single SQL statement is to be executed, this will use the executeStatement API.

Returns:

this

dbUser

@Stability(Stable)
public RedshiftQueryProps.Builder dbUser(String dbUser)

Sets the value of RedshiftQueryProps.getDbUser()

Parameters:

dbUser - The Amazon Redshift database user to run the query as. This is required when authenticating via temporary credentials.

Returns:

this

deadLetterQueue

@Stability(Stable)
public RedshiftQueryProps.Builder deadLetterQueue(IQueue deadLetterQueue)

Sets the value of RedshiftQueryProps.getDeadLetterQueue()

Parameters:

deadLetterQueue - The queue to be used as dead letter queue.

Returns:

this

input

@Stability(Stable)
public RedshiftQueryProps.Builder input(RuleTargetInput input)

Sets the value of RedshiftQueryProps.getInput()

Parameters:

input - The input to the state machine execution.

Returns:

this

role

@Stability(Stable)
public RedshiftQueryProps.Builder role(IRole role)

Sets the value of RedshiftQueryProps.getRole()

Parameters:

role - The IAM role to be used to execute the SQL statement.

Returns:

this

secret

@Stability(Stable)
public RedshiftQueryProps.Builder secret(ISecret secret)

Sets the value of RedshiftQueryProps.getSecret()

Parameters:

secret - The secret containing the password for the database user. This is required when authenticating via Secrets Manager. If the full secret ARN is not specified, this will instead use the secret name.

Returns:

this

sendEventBridgeEvent

@Stability(Stable)
public RedshiftQueryProps.Builder sendEventBridgeEvent(Boolean sendEventBridgeEvent)

Sets the value of RedshiftQueryProps.getSendEventBridgeEvent()

Parameters:

sendEventBridgeEvent - Should an event be sent back to Event Bridge when the SQL statement is executed.

Returns:

this

statementName

@Stability(Stable)
public RedshiftQueryProps.Builder statementName(String statementName)

Sets the value of RedshiftQueryProps.getStatementName()

Parameters:

statementName - The name of the SQL statement. You can name the SQL statement for identitfication purposes. If you would like Amazon Redshift to identify the Event Bridge rule, and present it in the Amazon Redshift console, append a QS2- prefix to the statement name.

Returns:

this

build

@Stability(Stable)
public RedshiftQueryProps build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<RedshiftQueryProps>

Returns:

a new instance of RedshiftQueryProps

Throws:

NullPointerException - if any required attribute was not provided