Class CfnDataSourcePropsMixin.AthenaParametersProperty

Parameters for Amazon Athena.

Inheritance

object

CfnDataSourcePropsMixin.AthenaParametersProperty

Implements

CfnDataSourcePropsMixin.IAthenaParametersProperty

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.Mixins.Preview.AWS.QuickSight.Mixins

Assembly: Amazon.CDK.Mixins.Preview.dll

Syntax (csharp)

public class CfnDataSourcePropsMixin.AthenaParametersProperty : CfnDataSourcePropsMixin.IAthenaParametersProperty

Syntax (vb)

Public Class CfnDataSourcePropsMixin.AthenaParametersProperty Implements CfnDataSourcePropsMixin.IAthenaParametersProperty

Remarks

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.Mixins.Preview.AWS.QuickSight.Mixins;

             var athenaParametersProperty = new AthenaParametersProperty {
                 IdentityCenterConfiguration = new IdentityCenterConfigurationProperty {
                     EnableIdentityPropagation = false
                 },
                 RoleArn = "roleArn",
                 WorkGroup = "workGroup"
             };

Synopsis

Constructors

AthenaParametersProperty()

Parameters for Amazon Athena.

Properties

IdentityCenterConfiguration	An optional parameter that configures IAM Identity Center authentication to grant Quick Sight access to your workgroup.
RoleArn	Use the `RoleArn` structure to override an account-wide role for a specific Athena data source.
WorkGroup	The workgroup that Amazon Athena uses.

Constructors

AthenaParametersProperty()

Parameters for Amazon Athena.

public AthenaParametersProperty()

Remarks

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.Mixins.Preview.AWS.QuickSight.Mixins;

             var athenaParametersProperty = new AthenaParametersProperty {
                 IdentityCenterConfiguration = new IdentityCenterConfigurationProperty {
                     EnableIdentityPropagation = false
                 },
                 RoleArn = "roleArn",
                 WorkGroup = "workGroup"
             };

Properties

IdentityCenterConfiguration

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

public object? IdentityCenterConfiguration { get; set; }

Property Value

object

Remarks

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

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

Type union: either IResolvable or CfnDataSourcePropsMixin.IIdentityCenterConfigurationProperty

RoleArn

Use the RoleArn structure to override an account-wide role for a specific Athena data source.

public string? RoleArn { get; set; }

Property Value

string

Remarks

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: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-athenaparameters.html#cfn-quicksight-datasource-athenaparameters-rolearn

WorkGroup

The workgroup that Amazon Athena uses.

public string? WorkGroup { get; set; }