Class AthenaParameters

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

Parameters for Amazon Athena.

See Also:

  • Method Details

    • workGroup

      public final String workGroup()

      The workgroup that Amazon Athena uses.

      Returns:
      The workgroup that Amazon Athena uses.

    • roleArn

      public final String roleArn()

      Use the RoleArn structure to override an account-wide role for a specific Athena data source. For example, say an account administrator has turned off all Athena access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow Athena access for the single Athena data source that is specified in the structure, even if the account-wide role forbidding Athena access is still active.

      Returns:
      Use the RoleArn structure to override an account-wide role for a specific Athena data source. For example, say an account administrator has turned off all Athena access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow Athena access for the single Athena data source that is specified in the structure, even if the account-wide role forbidding Athena access is still active.

    • identityCenterConfiguration

      public final IdentityCenterConfiguration identityCenterConfiguration()

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

      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 workgroup.

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

    • toBuilder

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

    • builder

      public static AthenaParameters.Builder builder()

    • serializableBuilderClass

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