Package software.amazon.awssdk.services.quicksight.model

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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	AthenaParameters.Builder

Method Summary

Modifier and Type	Method	Description
static AthenaParameters.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
IdentityCenterConfiguration	identityCenterConfiguration()	An optional parameter that configures IAM Identity Center authentication to grant QuickSight access to your workgroup.
String	roleArn()	Use the RoleArn structure to override an account-wide role for a specific Athena data source.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends AthenaParameters.Builder>	serializableBuilderClass()
AthenaParameters.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	workGroup()	The workgroup that Amazon Athena uses.

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

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 QuickSight access to your workgroup.

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

Returns:

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

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

toBuilder

public AthenaParameters.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AthenaParameters.Builder,AthenaParameters>

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo