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

Interface AthenaParameters.Builder

All Superinterfaces:

Buildable, CopyableBuilder<AthenaParameters.Builder,AthenaParameters>, SdkBuilder<AthenaParameters.Builder,AthenaParameters>, SdkPojo

Enclosing class:

AthenaParameters

@Mutable
@NotThreadSafe
public static interface AthenaParameters.Builder
extends SdkPojo, CopyableBuilder<AthenaParameters.Builder,AthenaParameters>

Method Summary

Modifier and Type	Method	Description
default AthenaParameters.Builder	identityCenterConfiguration(Consumer<IdentityCenterConfiguration.Builder> identityCenterConfiguration)	An optional parameter that configures IAM Identity Center authentication to grant QuickSight access to your workgroup.
AthenaParameters.Builder	identityCenterConfiguration(IdentityCenterConfiguration identityCenterConfiguration)	An optional parameter that configures IAM Identity Center authentication to grant QuickSight access to your workgroup.
AthenaParameters.Builder	roleArn(String roleArn)	Use the RoleArn structure to override an account-wide role for a specific Athena data source.
AthenaParameters.Builder	workGroup(String workGroup)	The workgroup that Amazon Athena uses.

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

copy

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

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Detail

workGroup

AthenaParameters.Builder workGroup(String workGroup)

The workgroup that Amazon Athena uses.

Parameters:

workGroup - The workgroup that Amazon Athena uses.

Returns:

Returns a reference to this object so that method calls can be chained together.

roleArn

AthenaParameters.Builder roleArn(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

identityCenterConfiguration

AthenaParameters.Builder identityCenterConfiguration(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

identityCenterConfiguration

default AthenaParameters.Builder identityCenterConfiguration(Consumer<IdentityCenterConfiguration.Builder> 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.

This is a convenience method that creates an instance of the IdentityCenterConfiguration.Builder avoiding the need to create one manually via IdentityCenterConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to identityCenterConfiguration(IdentityCenterConfiguration).

Parameters:

identityCenterConfiguration - a consumer that will call methods on IdentityCenterConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

identityCenterConfiguration(IdentityCenterConfiguration)