aws-cdk-lib.aws_events.CfnRule.RedshiftDataParametersProperty

interface RedshiftDataParametersProperty

LanguageType name
.NETAmazon.CDK.AWS.Events.CfnRule.RedshiftDataParametersProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsevents#CfnRule_RedshiftDataParametersProperty
Javasoftware.amazon.awscdk.services.events.CfnRule.RedshiftDataParametersProperty
Pythonaws_cdk.aws_events.CfnRule.RedshiftDataParametersProperty
TypeScript aws-cdk-lib » aws_events » CfnRule » RedshiftDataParametersProperty

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 { aws_events as events } from 'aws-cdk-lib';
const redshiftDataParametersProperty: events.CfnRule.RedshiftDataParametersProperty = {
  database: 'database',
  sql: 'sql',

  // the properties below are optional
  dbUser: 'dbUser',
  secretManagerArn: 'secretManagerArn',
  statementName: 'statementName',
  withEvent: false,
};

Properties

NameTypeDescription
databasestringThe name of the database.
sqlstringThe SQL statement text to run.
dbUser?stringThe database user name.
secretManagerArn?stringThe name or ARN of the secret that enables access to the database.
statementName?stringThe name of the SQL statement.
withEvent?boolean | IResolvableIndicates whether to send an event back to EventBridge after the SQL statement runs.

database

Type: string

The name of the database.

Required when authenticating using temporary credentials.


sql

Type: string

The SQL statement text to run.


dbUser?

Type: string (optional)

The database user name.

Required when authenticating using temporary credentials.


secretManagerArn?

Type: string (optional)

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

Required when authenticating using AWS Secrets Manager.


statementName?

Type: string (optional)

The name of the SQL statement.

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


withEvent?

Type: boolean | IResolvable (optional)

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