Package software.amazon.awscdk.services.quicksight

Interface CfnDataSource.AthenaParametersProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDataSource.AthenaParametersProperty.Jsii$Proxy

Enclosing class:

CfnDataSource

@Stability(Stable)
public static interface CfnDataSource.AthenaParametersProperty
extends software.amazon.jsii.JsiiSerializable

Parameters for Amazon Athena.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.quicksight.*;
 AthenaParametersProperty athenaParametersProperty = AthenaParametersProperty.builder()
         .identityCenterConfiguration(IdentityCenterConfigurationProperty.builder()
                 .enableIdentityPropagation(false)
                 .build())
         .roleArn("roleArn")
         .workGroup("workGroup")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-athenaparameters.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnDataSource.AthenaParametersProperty.Builder	A builder for CfnDataSource.AthenaParametersProperty
static final class	CfnDataSource.AthenaParametersProperty.Jsii$Proxy	An implementation for CfnDataSource.AthenaParametersProperty

Method Summary

Modifier and Type	Method	Description
static CfnDataSource.AthenaParametersProperty.Builder	builder()
default Object	getIdentityCenterConfiguration()	An optional parameter that configures IAM Identity Center authentication to grant Amazon QuickSight access to your workgroup.
default String	getRoleArn()	Use the RoleArn structure to override an account-wide role for a specific Athena data source.
default String	getWorkGroup()	The workgroup that Amazon Athena uses.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getIdentityCenterConfiguration

@Stability(Stable)
@Nullable
default Object getIdentityCenterConfiguration()

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

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-athenaparameters.html#cfn-quicksight-datasource-athenaparameters-identitycenterconfiguration

getRoleArn

@Stability(Stable)
@Nullable
default String getRoleArn()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-athenaparameters.html#cfn-quicksight-datasource-athenaparameters-rolearn

getWorkGroup

@Stability(Stable)
@Nullable
default String getWorkGroup()

The workgroup that Amazon Athena uses.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-athenaparameters.html#cfn-quicksight-datasource-athenaparameters-workgroup

builder

@Stability(Stable)
static CfnDataSource.AthenaParametersProperty.Builder builder()

Returns:

a CfnDataSource.AthenaParametersProperty.Builder of CfnDataSource.AthenaParametersProperty