# PipeTargetRedshiftDataParametersProperty

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

- Source: Generated code
- Type last changed: v2.93.0 · 23 Aug 2023

## Example

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

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

## Properties

- `database`: string (required) — The name of the database.

  Required when authenticating using temporary credentials.

- `dbUser`: string — The database user name.

  Required when authenticating using temporary credentials.

- `secretManagerArn`: string — The name or ARN of the secret that enables access to the database.

  Required when authenticating using Secrets Manager.

- `sqls`: string[] (required) — The SQL statement text to run.

- `statementName`: string — The name of the SQL statement.

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

- `withEvent`: boolean | [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) = false — Indicates whether to send an event back to EventBridge after the SQL statement runs.