Class RedshiftDataParameters
- java.lang.Object
-
- software.amazon.awssdk.services.cloudwatchevents.model.RedshiftDataParameters
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<RedshiftDataParameters.Builder,RedshiftDataParameters>
@Generated("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 Amazon Redshift cluster to invoke the Amazon Redshift Data API ExecuteStatement based on EventBridge events.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceRedshiftDataParameters.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static RedshiftDataParameters.Builderbuilder()Stringdatabase()The name of the database.StringdbUser()The database user name.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()StringsecretManagerArn()The name or ARN of the secret that enables access to the database.static Class<? extends RedshiftDataParameters.Builder>serializableBuilderClass()Stringsql()The SQL statement text to run.StringstatementName()The name of the SQL statement.RedshiftDataParameters.BuildertoBuilder()StringtoString()Returns a string representation of this object.BooleanwithEvent()Indicates whether to send an event back to EventBridge after the SQL statement runs.-
Methods inherited from class java.lang.Object
clone, finalize, 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 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.
-
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()
- Specified by:
toBuilderin interfaceToCopyableBuilder<RedshiftDataParameters.Builder,RedshiftDataParameters>
-
builder
public static RedshiftDataParameters.Builder builder()
-
serializableBuilderClass
public static Class<? extends RedshiftDataParameters.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-