PipeTargetRedshiftDataParameters (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.pipes.model.PipeTargetRedshiftDataParameters

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class PipeTargetRedshiftDataParameters
extends Object
implements Serializable, Cloneable, StructuredPojo
```
These are custom parameters to be used when the target is a Amazon Redshift cluster to invoke the Amazon Redshift Data API ExecuteStatement.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

PipeTargetRedshiftDataParameters()

Constructors
Constructor and Description
`PipeTargetRedshiftDataParameters()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`PipeTargetRedshiftDataParameters`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getDatabase()` The name of the database.
`String`	`getDbUser()` The database user name.
`String`	`getSecretManagerArn()` The name or ARN of the secret that enables access to the database.
`List<String>`	`getSqls()` The SQL statement text to run.
`String`	`getStatementName()` The name of the SQL statement.
`Boolean`	`getWithEvent()` Indicates whether to send an event back to EventBridge after the SQL statement runs.
`int`	`hashCode()`
`Boolean`	`isWithEvent()` Indicates whether to send an event back to EventBridge after the SQL statement runs.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setDatabase(String database)` The name of the database.
`void`	`setDbUser(String dbUser)` The database user name.
`void`	`setSecretManagerArn(String secretManagerArn)` The name or ARN of the secret that enables access to the database.
`void`	`setSqls(Collection<String> sqls)` The SQL statement text to run.
`void`	`setStatementName(String statementName)` The name of the SQL statement.
`void`	`setWithEvent(Boolean withEvent)` Indicates whether to send an event back to EventBridge after the SQL statement runs.
`String`	`toString()` Returns a string representation of this object.
`PipeTargetRedshiftDataParameters`	`withDatabase(String database)` The name of the database.
`PipeTargetRedshiftDataParameters`	`withDbUser(String dbUser)` The database user name.
`PipeTargetRedshiftDataParameters`	`withSecretManagerArn(String secretManagerArn)` The name or ARN of the secret that enables access to the database.
`PipeTargetRedshiftDataParameters`	`withSqls(Collection<String> sqls)` The SQL statement text to run.
`PipeTargetRedshiftDataParameters`	`withSqls(String... sqls)` The SQL statement text to run.
`PipeTargetRedshiftDataParameters`	`withStatementName(String statementName)` The name of the SQL statement.
`PipeTargetRedshiftDataParameters`	`withWithEvent(Boolean withEvent)` Indicates whether to send an event back to EventBridge after the SQL statement runs.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - PipeTargetRedshiftDataParameters
```
public PipeTargetRedshiftDataParameters()
```
- Method Detail
  - setDatabase
```
public void setDatabase(String database)
```
    The name of the database. Required when authenticating using temporary credentials.
    
    Parameters:
    
    database - The name of the database. Required when authenticating using temporary credentials.
  - getDatabase
```
public String getDatabase()
```
    The name of the database. Required when authenticating using temporary credentials.
    
    Returns:
    
    The name of the database. Required when authenticating using temporary credentials.
  - withDatabase
```
public PipeTargetRedshiftDataParameters withDatabase(String database)
```
    The name of the database. Required when authenticating using temporary credentials.
    
    Parameters:
    
    database - The name of the database. Required when authenticating using temporary credentials.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDbUser
```
public void setDbUser(String dbUser)
```
    The database user name. Required when authenticating using temporary credentials.
    
    Parameters:
    
    dbUser - The database user name. Required when authenticating using temporary credentials.
  - getDbUser
```
public String getDbUser()
```
    The database user name. Required when authenticating using temporary credentials.
    
    Returns:
    
    The database user name. Required when authenticating using temporary credentials.
  - withDbUser
```
public PipeTargetRedshiftDataParameters withDbUser(String dbUser)
```
    The database user name. Required when authenticating using temporary credentials.
    
    Parameters:
    
    dbUser - The database user name. Required when authenticating using temporary credentials.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSecretManagerArn
```
public void setSecretManagerArn(String secretManagerArn)
```
    The name or ARN of the secret that enables access to the database. Required when authenticating using SageMaker.
    
    Parameters:
    
    secretManagerArn - The name or ARN of the secret that enables access to the database. Required when authenticating using SageMaker.
  - getSecretManagerArn
```
public String getSecretManagerArn()
```
    The name or ARN of the secret that enables access to the database. Required when authenticating using SageMaker.
    
    Returns:
    
    The name or ARN of the secret that enables access to the database. Required when authenticating using SageMaker.
  - withSecretManagerArn
```
public PipeTargetRedshiftDataParameters withSecretManagerArn(String secretManagerArn)
```
    The name or ARN of the secret that enables access to the database. Required when authenticating using SageMaker.
    
    Parameters:
    
    secretManagerArn - The name or ARN of the secret that enables access to the database. Required when authenticating using SageMaker.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getSqls
```
public List<String> getSqls()
```
    The SQL statement text to run.
    
    Returns:
    
    The SQL statement text to run.
  - setSqls
```
public void setSqls(Collection<String> sqls)
```
    The SQL statement text to run.
    
    Parameters:
    
    sqls - The SQL statement text to run.
  - withSqls
```
public PipeTargetRedshiftDataParameters withSqls(String... sqls)
```
    The SQL statement text to run.
    
    NOTE: This method appends the values to the existing list (if any). Use setSqls(java.util.Collection) or withSqls(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    sqls - The SQL statement text to run.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withSqls
```
public PipeTargetRedshiftDataParameters withSqls(Collection<String> sqls)
```
    The SQL statement text to run.
    
    Parameters:
    
    sqls - The SQL statement text to run.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStatementName
```
public void setStatementName(String statementName)
```
    The name of the SQL statement. You can name the SQL statement when you create it to identify the query.
    
    Parameters:
    
    statementName - The name of the SQL statement. You can name the SQL statement when you create it to identify the query.
  - getStatementName
```
public String getStatementName()
```
    The name of the SQL statement. You can name the SQL statement when you create it to identify the query.
    
    Returns:
    
    The name of the SQL statement. You can name the SQL statement when you create it to identify the query.
  - withStatementName
```
public PipeTargetRedshiftDataParameters withStatementName(String statementName)
```
    The name of the SQL statement. You can name the SQL statement when you create it to identify the query.
    
    Parameters:
    
    statementName - The name of the SQL statement. You can name the SQL statement when you create it to identify the query.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setWithEvent
```
public void setWithEvent(Boolean withEvent)
```
    Indicates whether to send an event back to EventBridge after the SQL statement runs.
    
    Parameters:
    
    withEvent - Indicates whether to send an event back to EventBridge after the SQL statement runs.
  - getWithEvent
```
public Boolean getWithEvent()
```
    Indicates whether to send an event back to EventBridge after the SQL statement runs.
    
    Returns:
    
    Indicates whether to send an event back to EventBridge after the SQL statement runs.
  - withWithEvent
```
public PipeTargetRedshiftDataParameters withWithEvent(Boolean withEvent)
```
    Indicates whether to send an event back to EventBridge after the SQL statement runs.
    
    Parameters:
    
    withEvent - Indicates whether to send an event back to EventBridge after the SQL statement runs.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isWithEvent
```
public Boolean isWithEvent()
```
    Indicates whether to send an event back to EventBridge after the SQL statement runs.
    
    Returns:
    
    Indicates whether to send an event back to EventBridge after the SQL statement runs.
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public PipeTargetRedshiftDataParameters clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class PipeTargetRedshiftDataParameters

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PipeTargetRedshiftDataParameters

Method Detail

setDatabase

getDatabase

withDatabase

setDbUser

getDbUser

withDbUser

setSecretManagerArn

getSecretManagerArn

withSecretManagerArn

getSqls

setSqls

withSqls

withSqls

setStatementName

getStatementName

withStatementName

setWithEvent

getWithEvent

withWithEvent

isWithEvent

toString

equals

hashCode

clone

marshall