Interface CfnPipe.PipeTargetRedshiftDataParametersProperty

All Superinterfaces:
All Known Implementing Classes:
Enclosing class:

@Stability(Stable) public static interface CfnPipe.PipeTargetRedshiftDataParametersProperty extends
These are custom parameters to be used when the target is a Amazon Redshift cluster to invoke the Amazon Redshift Data API BatchExecuteStatement.


 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 PipeTargetRedshiftDataParametersProperty pipeTargetRedshiftDataParametersProperty = PipeTargetRedshiftDataParametersProperty.builder()
         // the properties below are optional
  • Method Details

    • getDatabase

      @Stability(Stable) @NotNull String getDatabase()
      The name of the database.

      Required when authenticating using temporary credentials.

    • getSqls

      @Stability(Stable) @NotNull List<String> getSqls()
      The SQL statement text to run.
    • getDbUser

      @Stability(Stable) @Nullable default String getDbUser()
      The database user name.

      Required when authenticating using temporary credentials.

    • 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 .

    • 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.

    • getWithEvent

      @Stability(Stable) @Nullable default Object getWithEvent()
      Indicates whether to send an event back to EventBridge after the SQL statement runs.
    • builder

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