2.248.0

interface PipeTargetRedshiftDataParametersProperty

LanguageType name
.NETAmazon.CDK.CfnPropertyMixins.AWS.Pipes.CfnPipePropsMixin.PipeTargetRedshiftDataParametersProperty
Gogithub.com/aws/aws-cdk-go/awscdkcfnpropertymixins/v2/awspipes#CfnPipePropsMixin_PipeTargetRedshiftDataParametersProperty
Javasoftware.amazon.awscdk.cfnpropertymixins.services.pipes.CfnPipePropsMixin.PipeTargetRedshiftDataParametersProperty
Pythonaws_cdk.cfn_property_mixins.aws_pipes.CfnPipePropsMixin.PipeTargetRedshiftDataParametersProperty
TypeScript @aws-cdk/cfn-property-mixins » aws_pipes » CfnPipePropsMixin » PipeTargetRedshiftDataParametersProperty

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetredshiftdataparameters.html

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/cfn-property-mixins';
const pipeTargetRedshiftDataParametersProperty: pipes.CfnPipePropsMixin.PipeTargetRedshiftDataParametersProperty = {
  database: 'database',
  dbUser: 'dbUser',
  secretManagerArn: 'secretManagerArn',
  sqls: ['sqls'],
  statementName: 'statementName',
  withEvent: false,
};

Properties

NameTypeDescription
database?stringThe name of the database.
dbUser?stringThe database user name.
secretManagerArn?stringThe name or ARN of the secret that enables access to the database.
sqls?string[]The SQL statement text to run.
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 (optional)

The name of the database.

Required when authenticating using temporary credentials.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetredshiftdataparameters.html#cfn-pipes-pipe-pipetargetredshiftdataparameters-database

dbUser?

Type: string (optional)

The database user name.

Required when authenticating using temporary credentials.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetredshiftdataparameters.html#cfn-pipes-pipe-pipetargetredshiftdataparameters-dbuser

secretManagerArn?

Type: string (optional)

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

Required when authenticating using Secrets Manager.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetredshiftdataparameters.html#cfn-pipes-pipe-pipetargetredshiftdataparameters-secretmanagerarn

sqls?

Type: string[] (optional)

The SQL statement text to run.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetredshiftdataparameters.html#cfn-pipes-pipe-pipetargetredshiftdataparameters-sqls

statementName?

Type: string (optional)

The name of the SQL statement.

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetredshiftdataparameters.html#cfn-pipes-pipe-pipetargetredshiftdataparameters-statementname

withEvent?

Type: boolean | IResolvable (optional, default: false)

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetredshiftdataparameters.html#cfn-pipes-pipe-pipetargetredshiftdataparameters-withevent

← PreviousNext →