Class RedshiftParameters

java.lang.Object
software.amazon.awssdk.services.quicksight.model.RedshiftParameters
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<RedshiftParameters.Builder,RedshiftParameters>
@Generated("software.amazon.awssdk:codegen") public final class RedshiftParameters extends Object implements SdkPojo, Serializable, ToCopyableBuilder<RedshiftParameters.Builder,RedshiftParameters>

The parameters for Amazon Redshift. The ClusterId field can be blank if Host and Port are both set. The Host and Port fields can be blank if the ClusterId field is set.

See Also:

  • Method Details

    • host

      public final String host()

      Host. This field can be blank if ClusterId is provided.

      Returns:
      Host. This field can be blank if ClusterId is provided.

    • port

      public final Integer port()

      Port. This field can be blank if the ClusterId is provided.

      Returns:
      Port. This field can be blank if the ClusterId is provided.

    • database

      public final String database()

      Database.

      Returns:
      Database.

    • clusterId

      public final String clusterId()

      Cluster ID. This field can be blank if the Host and Port are provided.

      Returns:
      Cluster ID. This field can be blank if the Host and Port are provided.

    • iamParameters

      public final RedshiftIAMParameters iamParameters()

      An optional parameter that uses IAM authentication to grant Quick Sight access to your cluster. This parameter can be used instead of DataSourceCredentials.

      Returns:
      An optional parameter that uses IAM authentication to grant Quick Sight access to your cluster. This parameter can be used instead of DataSourceCredentials.

    • identityCenterConfiguration

      public final IdentityCenterConfiguration identityCenterConfiguration()

      An optional parameter that configures IAM Identity Center authentication to grant Quick Sight access to your cluster.

      This parameter can only be specified if your Quick Sight account is configured with IAM Identity Center.

      Returns:
      An optional parameter that configures IAM Identity Center authentication to grant Quick Sight access to your cluster.

      This parameter can only be specified if your Quick Sight account is configured with IAM Identity Center.

    • toBuilder

      public RedshiftParameters.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<RedshiftParameters.Builder,RedshiftParameters>
      Returns:
      a builder for type T

    • builder

      public static RedshiftParameters.Builder builder()

    • serializableBuilderClass

      public static Class<? extends RedshiftParameters.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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.