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.
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
The name of the database.
Required when authenticating using temporary credentials.
dbUseroptionalstringdb_useroptionalstrdbUseroptionalStringDbUseroptionalstringDbUseroptional*string#The database user name.
Required when authenticating using temporary credentials.
secretManagerArnoptionalstringsecret_manager_arnoptionalstrsecretManagerArnoptionalStringSecretManagerArnoptionalstringSecretManagerArnoptional*string#The name or ARN of the secret that enables access to the database.
Required when authenticating using Secrets Manager.
The SQL statement text to run.
statementNameoptionalstringstatement_nameoptionalstrstatementNameoptionalStringStatementNameoptionalstringStatementNameoptional*string#The name of the SQL statement.
You can name the SQL statement when you create it to identify the query.
withEventoptionalboolean | IResolvablewith_eventoptionaltyping.Union[bool, IResolvable]withEventoptionalBooleanWithEventoptionalboolWithEventoptionalinterface{}= false#Indicates whether to send an event back to EventBridge after the SQL statement runs.