aws-cdk-lib.aws_pipes.CfnPipe.PipeTargetRedshiftDataParametersProperty

PipeTargetRedshiftDataParametersProperty Struct

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

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

databasestringdatabasestrdatabaseStringDatabasestringDatabase*stringrequired#

The name of the database.

Required when authenticating using temporary credentials.

dbUserstringdb_userstrdbUserStringDbUserstringDbUser*string#

The database user name.

Required when authenticating using temporary credentials.

secretManagerArnstringsecret_manager_arnstrsecretManagerArnStringSecretManagerArnstringSecretManagerArn*string#

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

Required when authenticating using Secrets Manager.

sqlsstring[]sqlstyping.List[str]sqlsList<String>Sqlsstring[]Sqls*[]*stringrequired#

The SQL statement text to run.

statementNamestringstatement_namestrstatementNameStringStatementNamestringStatementName*string#

The name of the SQL statement.

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

withEventboolean | IResolvablewith_eventtyping.Union[bool, IResolvable]withEventBooleanWithEventboolWithEventinterface{}= false#

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