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(value=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")
         .sql("sql")
         // the properties below are optional
         .dbUser("dbUser")
         .secretManagerArn("secretManagerArn")
         .statementName("statementName")
         .withEvent(false)
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and 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.
String	getSql() The SQL statement text 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 Detail

getDatabase

@Stability(value=Stable)
 @NotNull
String getDatabase()

The name of the database.

Required when authenticating using temporary credentials.

getSql

@Stability(value=Stable)
 @NotNull
String getSql()

The SQL statement text to run.

getDbUser

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

The database user name.

Required when authenticating using temporary credentials.

getSecretManagerArn

@Stability(value=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.

getStatementName

@Stability(value=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.

getWithEvent

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

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

builder

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

Returns:

a CfnRule.RedshiftDataParametersProperty.Builder of CfnRule.RedshiftDataParametersProperty