Package software.amazon.awscdk.services.events

Interface CfnRule.RedshiftDataParametersProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnRule.RedshiftDataParametersProperty.Jsii$Proxy

Enclosing class:

CfnRule

@Stability(Stable)
public static interface CfnRule.RedshiftDataParametersProperty
extends software.amazon.jsii.JsiiSerializable

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.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.events.*;
 RedshiftDataParametersProperty redshiftDataParametersProperty = RedshiftDataParametersProperty.builder()
         .database("database")
         // the properties below are optional
         .dbUser("dbUser")
         .secretManagerArn("secretManagerArn")
         .sql("sql")
         .sqls(List.of("sqls"))
         .statementName("statementName")
         .withEvent(false)
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-redshiftdataparameters.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnRule.RedshiftDataParametersProperty.Builder	A builder for CfnRule.RedshiftDataParametersProperty
static final class	CfnRule.RedshiftDataParametersProperty.Jsii$Proxy	An implementation for CfnRule.RedshiftDataParametersProperty

Method Summary

Modifier and Type	Method	Description
static CfnRule.RedshiftDataParametersProperty.Builder	builder()
String	getDatabase()	The name of the database.
default String	getDbUser()	The database user name.
default String	getSecretManagerArn()	The name or ARN of the secret that enables access to the database.
default String	getSql()	The SQL statement text to run.
default List<String>	getSqls()	One or more SQL statements to run.
default String	getStatementName()	The name of the SQL statement.
default Object	getWithEvent()	Indicates whether to send an event back to EventBridge after the SQL statement runs.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDatabase

@Stability(Stable)
@NotNull
String getDatabase()

The name of the database.

Required when authenticating using temporary credentials.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-redshiftdataparameters.html#cfn-events-rule-redshiftdataparameters-database

getDbUser

@Stability(Stable)
@Nullable
default String getDbUser()

The database user name.

Required when authenticating using temporary credentials.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-redshiftdataparameters.html#cfn-events-rule-redshiftdataparameters-dbuser

getSecretManagerArn

@Stability(Stable)
@Nullable
default String getSecretManagerArn()

The name or ARN of the secret that enables access to the database.

Required when authenticating using AWS Secrets Manager.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-redshiftdataparameters.html#cfn-events-rule-redshiftdataparameters-secretmanagerarn

getSql

@Stability(Stable)
@Nullable
default String getSql()

The SQL statement text to run.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-redshiftdataparameters.html#cfn-events-rule-redshiftdataparameters-sql

getSqls

@Stability(Stable)
@Nullable
default List<String> getSqls()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-redshiftdataparameters.html#cfn-events-rule-redshiftdataparameters-sqls

getStatementName

@Stability(Stable)
@Nullable
default String getStatementName()

The name of the SQL statement.

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-redshiftdataparameters.html#cfn-events-rule-redshiftdataparameters-statementname

getWithEvent

@Stability(Stable)
@Nullable
default Object getWithEvent()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-redshiftdataparameters.html#cfn-events-rule-redshiftdataparameters-withevent

builder

@Stability(Stable)
static CfnRule.RedshiftDataParametersProperty.Builder builder()

Returns:

a CfnRule.RedshiftDataParametersProperty.Builder of CfnRule.RedshiftDataParametersProperty