Package software.amazon.awscdk.services.pipes

Interface CfnPipe.PipeTargetRedshiftDataParametersProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnPipe.PipeTargetRedshiftDataParametersProperty.Jsii$Proxy

Enclosing class:

CfnPipe

@Stability(Stable)
public static interface CfnPipe.PipeTargetRedshiftDataParametersProperty
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.pipes.*;
 PipeTargetRedshiftDataParametersProperty pipeTargetRedshiftDataParametersProperty = PipeTargetRedshiftDataParametersProperty.builder()
         .database("database")
         .sqls(List.of("sqls"))
         // the properties below are optional
         .dbUser("dbUser")
         .secretManagerArn("secretManagerArn")
         .statementName("statementName")
         .withEvent(false)
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnPipe.PipeTargetRedshiftDataParametersProperty.Builder	A builder for CfnPipe.PipeTargetRedshiftDataParametersProperty
static final class	CfnPipe.PipeTargetRedshiftDataParametersProperty.Jsii$Proxy	An implementation for CfnPipe.PipeTargetRedshiftDataParametersProperty

Method Summary

Modifier and Type	Method	Description
static CfnPipe.PipeTargetRedshiftDataParametersProperty.Builder	builder()
String	getDatabase()	The name of the database.
default String	getDbUser()	The database user name.
default String	getSecretManagerArn()	The name or ARN of the secret that enables access to the database.
List<String>	getSqls()	The SQL statement text to run.
default String	getStatementName()	The name of the SQL statement.
default Object	getWithEvent()	Indicates whether to send an event back to EventBridge after the SQL statement runs.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDatabase

@Stability(Stable)
@NotNull
String getDatabase()

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

getSqls

@Stability(Stable)
@NotNull
List<String> getSqls()

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

getDbUser

@Stability(Stable)
@Nullable
default String getDbUser()

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

getSecretManagerArn

@Stability(Stable)
@Nullable
default String getSecretManagerArn()

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

getStatementName

@Stability(Stable)
@Nullable
default String getStatementName()

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

getWithEvent

@Stability(Stable)
@Nullable
default Object getWithEvent()

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

Default: - false

See Also:

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

builder

@Stability(Stable)
static CfnPipe.PipeTargetRedshiftDataParametersProperty.Builder builder()

Returns:

a CfnPipe.PipeTargetRedshiftDataParametersProperty.Builder of CfnPipe.PipeTargetRedshiftDataParametersProperty