interface StarburstParametersProperty

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

The parameters that are required to connect to a Starburst data source.

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

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 starburstParametersProperty: quicksight.CfnDataSource.StarburstParametersProperty = {
  catalog: 'catalog',
  host: 'host',
  port: 123,

  // the properties below are optional
  authenticationType: 'authenticationType',
  databaseAccessControlRole: 'databaseAccessControlRole',
  oAuthParameters: {
    tokenProviderUrl: 'tokenProviderUrl',

    // the properties below are optional
    identityProviderResourceUri: 'identityProviderResourceUri',
    identityProviderVpcConnectionProperties: {
      vpcConnectionArn: 'vpcConnectionArn',
    },
    oAuthScope: 'oAuthScope',
  },
  productType: 'productType',
};

Properties

Name	Type	Description
catalog	`string`	The catalog name for the Starburst data source.
host	`string`	The host name of the Starburst data source.
port	`number`	The port for the Starburst data source.
authenticationType?	`string`	The authentication type that you want to use for your connection.
databaseAccessControlRole?	`string`	The database access control role.
oAuthParameters?	`IResolvable` `\|` `OAuthParametersProperty`	An object that contains information needed to create a data source connection between an Quick Sight account and Starburst.
productType?	`string`	The product type for the Starburst data source.