interface PipeTargetRedshiftDataParametersProperty

Language	Type name
.NET	`Amazon.CDK.AWS.Pipes.CfnPipe.PipeTargetRedshiftDataParametersProperty`
Java	`software.amazon.awscdk.services.pipes.CfnPipe.PipeTargetRedshiftDataParametersProperty`
Python	`aws_cdk.aws_pipes.CfnPipe.PipeTargetRedshiftDataParametersProperty`
TypeScript	`@aws-cdk/aws-pipes` » `CfnPipe` » `PipeTargetRedshiftDataParametersProperty`

These are custom parameters to be used when the target is a Amazon Redshift cluster to invoke the Amazon Redshift Data API BatchExecuteStatement.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as pipes from '@aws-cdk/aws-pipes';
const pipeTargetRedshiftDataParametersProperty: pipes.CfnPipe.PipeTargetRedshiftDataParametersProperty = {
  database: 'database',
  sqls: ['sqls'],

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

Properties

Name	Type	Description
database	`string`	The name of the database.
sqls	`string[]`	The SQL statement text to run.
dbUser?	`string`	The database user name.
secretManagerArn?	`string`	The name or ARN of the secret that enables access to the database.
statementName?	`string`	The name of the SQL statement.
withEvent?	`boolean \|` `IResolvable`	Indicates 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.

sqls

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 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.