software.amazon.awssdk.services.eventbridge.model

Class RedshiftDataParameters

java.lang.Object

software.amazon.awssdk.services.eventbridge.model.RedshiftDataParameters

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<RedshiftDataParameters.Builder,RedshiftDataParameters>

@Generated(value="software.amazon.awssdk:codegen")
public final class RedshiftDataParameters
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<RedshiftDataParameters.Builder,RedshiftDataParameters>

These are custom parameters to be used when the target is a Redshift cluster to invoke the Redshift Data API ExecuteStatement based on EventBridge events.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	RedshiftDataParameters.Builder

Method Summary

Modifier and Type	Method and Description
static RedshiftDataParameters.Builder	builder()
String	database() The name of the database.
String	dbUser() The database user name.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
List<SdkField<?>>	sdkFields()
String	secretManagerArn() The name or ARN of the secret that enables access to the database.
static Class<? extends RedshiftDataParameters.Builder>	serializableBuilderClass()
String	sql() The SQL statement text to run.
String	statementName() The name of the SQL statement.
RedshiftDataParameters.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString() Returns a string representation of this object.
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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

secretManagerArn

public final String secretManagerArn()

The name or ARN of the secret that enables access to the database. Required when authenticating using AWS Secrets Manager.

Returns:

The name or ARN of the secret that enables access to the database. Required when authenticating using AWS Secrets Manager.

database

public final String database()

The name of the database. Required when authenticating using temporary credentials.

Returns:

The name of the database. Required when authenticating using temporary credentials.

dbUser

public final String dbUser()

The database user name. Required when authenticating using temporary credentials.

Returns:

The database user name. Required when authenticating using temporary credentials.

sql

public final String sql()

The SQL statement text to run.

Returns:

The SQL statement text to run.

statementName

public final String statementName()

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.

withEvent

public final Boolean withEvent()

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.

toBuilder

public RedshiftDataParameters.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<RedshiftDataParameters.Builder,RedshiftDataParameters>

Returns:

a builder for type T

builder

public static RedshiftDataParameters.Builder builder()

serializableBuilderClass

public static Class<? extends RedshiftDataParameters.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Description copied from interface: SdkPojo

Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.