interface AthenaParametersProperty

Language	Type name
.NET	`Amazon.CDK.AWS.QuickSight.CfnDataSource.AthenaParametersProperty`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsquicksight#CfnDataSource_AthenaParametersProperty`
Java	`software.amazon.awscdk.services.quicksight.CfnDataSource.AthenaParametersProperty`
Python	`aws_cdk.aws_quicksight.CfnDataSource.AthenaParametersProperty`
TypeScript	`aws-cdk-lib` » `aws_quicksight` » `CfnDataSource` » `AthenaParametersProperty`

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 { aws_quicksight as quicksight } from 'aws-cdk-lib';
const athenaParametersProperty: quicksight.CfnDataSource.AthenaParametersProperty = {
  identityCenterConfiguration: {
    enableIdentityPropagation: false,
  },
  roleArn: 'roleArn',
  workGroup: 'workGroup',
};

Properties

Name	Type	Description
identityCenterConfiguration?	`IResolvable` `\|` `IdentityCenterConfigurationProperty`	An optional parameter that configures IAM Identity Center authentication to grant Amazon QuickSight access to your workgroup.
roleArn?	`string`	Use the `RoleArn` structure to override an account-wide role for a specific Athena data source.
workGroup?	`string`	The workgroup that Amazon Athena uses.

identityCenterConfiguration?

Type: IResolvable | IdentityCenterConfigurationProperty (optional)

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.

roleArn?

Type: string (optional)

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.

workGroup?

Type: string (optional)

The workgroup that Amazon Athena uses.