RedshiftDataParameters (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.eventbridge.model.RedshiftDataParameters

All Implemented Interfaces:

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

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

RedshiftDataParameters()

Constructors
Constructor and Description
`RedshiftDataParameters()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`RedshiftDataParameters`	`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.
`String`	`getSql()` The SQL statement text to run.
`List<String>`	`getSqls()`
`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`	`setSql(String sql)` The SQL statement text to run.
`void`	`setSqls(Collection<String> sqls)`
`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.
`RedshiftDataParameters`	`withDatabase(String database)` The name of the database.
`RedshiftDataParameters`	`withDbUser(String dbUser)` The database user name.
`RedshiftDataParameters`	`withSecretManagerArn(String secretManagerArn)` The name or ARN of the secret that enables access to the database.
`RedshiftDataParameters`	`withSql(String sql)` The SQL statement text to run.
`RedshiftDataParameters`	`withSqls(Collection<String> sqls)`
`RedshiftDataParameters`	`withSqls(String... sqls)` NOTE: This method appends the values to the existing list (if any).
`RedshiftDataParameters`	`withStatementName(String statementName)` The name of the SQL statement.
`RedshiftDataParameters`	`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
  - RedshiftDataParameters
```
public RedshiftDataParameters()
```
- Method Detail
  - setSecretManagerArn
```
public void setSecretManagerArn(String secretManagerArn)
```
    The name or ARN of the secret that enables access to the database. Required when authenticating using Amazon Web Services Secrets Manager.
    
    Parameters:
    
    secretManagerArn - The name or ARN of the secret that enables access to the database. Required when authenticating using Amazon Web Services Secrets Manager.
  - getSecretManagerArn
```
public String getSecretManagerArn()
```
    The name or ARN of the secret that enables access to the database. Required when authenticating using Amazon Web Services Secrets Manager.
    
    Returns:
    
    The name or ARN of the secret that enables access to the database. Required when authenticating using Amazon Web Services Secrets Manager.
  - withSecretManagerArn
```
public RedshiftDataParameters withSecretManagerArn(String secretManagerArn)
```
    The name or ARN of the secret that enables access to the database. Required when authenticating using Amazon Web Services Secrets Manager.
    
    Parameters:
    
    secretManagerArn - The name or ARN of the secret that enables access to the database. Required when authenticating using Amazon Web Services Secrets Manager.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - 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 RedshiftDataParameters 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.
    
    Do not provide this parameter when connecting to a Redshift Serverless workgroup.
    
    Parameters:
    
    dbUser - The database user name. Required when authenticating using temporary credentials.
    
    Do not provide this parameter when connecting to a Redshift Serverless workgroup.
  - getDbUser
```
public String getDbUser()
```
    The database user name. Required when authenticating using temporary credentials.
    
    Do not provide this parameter when connecting to a Redshift Serverless workgroup.
    
    Returns:
    
    The database user name. Required when authenticating using temporary credentials.
    
    Do not provide this parameter when connecting to a Redshift Serverless workgroup.
  - withDbUser
```
public RedshiftDataParameters withDbUser(String dbUser)
```
    The database user name. Required when authenticating using temporary credentials.
    
    Do not provide this parameter when connecting to a Redshift Serverless workgroup.
    
    Parameters:
    
    dbUser - The database user name. Required when authenticating using temporary credentials.
    
    Do not provide this parameter when connecting to a Redshift Serverless workgroup.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSql
```
public void setSql(String sql)
```
    The SQL statement text to run.
    
    Parameters:
    
    sql - The SQL statement text to run.
  - getSql
```
public String getSql()
```
    The SQL statement text to run.
    
    Returns:
    
    The SQL statement text to run.
  - withSql
```
public RedshiftDataParameters withSql(String sql)
```
    The SQL statement text to run.
    
    Parameters:
    
    sql - 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 RedshiftDataParameters 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 RedshiftDataParameters 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.
  - getSqls
```
public List<String> getSqls()
```
    Returns:
  - setSqls
```
public void setSqls(Collection<String> sqls)
```
    Parameters:
    
    sqls -
  - withSqls
```
public RedshiftDataParameters withSqls(String... sqls)
```
    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 -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withSqls
```
public RedshiftDataParameters withSqls(Collection<String> sqls)
```
    Parameters:
    
    sqls -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - 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 RedshiftDataParameters 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.

AWS SDK for Java 1.x API Reference - 1.12.545

Class RedshiftDataParameters

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

RedshiftDataParameters

Method Detail

setSecretManagerArn

getSecretManagerArn

withSecretManagerArn

setDatabase

getDatabase

withDatabase

setDbUser

getDbUser

withDbUser

setSql

getSql

withSql

setStatementName

getStatementName

withStatementName

setWithEvent

getWithEvent

withWithEvent

isWithEvent

getSqls

setSqls

withSqls

withSqls

toString

equals

hashCode

clone

marshall