Interface CfnDataSource.IStarburstParametersProperty

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

Namespace: Amazon.CDK.AWS.QuickSight

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface CfnDataSource.IStarburstParametersProperty

Syntax (vb)

Public Interface CfnDataSource.IStarburstParametersProperty

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-starburstparameters.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.AWS.QuickSight;

             var starburstParametersProperty = new StarburstParametersProperty {
                 Catalog = "catalog",
                 Host = "host",
                 Port = 123,

                 // the properties below are optional
                 AuthenticationType = "authenticationType",
                 DatabaseAccessControlRole = "databaseAccessControlRole",
                 OAuthParameters = new OAuthParametersProperty {
                     TokenProviderUrl = "tokenProviderUrl",

                     // the properties below are optional
                     IdentityProviderResourceUri = "identityProviderResourceUri",
                     IdentityProviderVpcConnectionProperties = new VpcConnectionPropertiesProperty {
                         VpcConnectionArn = "vpcConnectionArn"
                     },
                     OAuthScope = "oAuthScope"
                 },
                 ProductType = "productType"
             };

Synopsis

Properties

AuthenticationType	The authentication type that you want to use for your connection.
Catalog	The catalog name for the Starburst data source.
DatabaseAccessControlRole	The database access control role.
Host	The host name of the Starburst data source.
OAuthParameters	An object that contains information needed to create a data source connection between an Amazon QuickSight account and Starburst.
Port	The port for the Starburst data source.
ProductType	The product type for the Starburst data source.

Properties

AuthenticationType

The authentication type that you want to use for your connection.

string? AuthenticationType { get; }

Property Value

string

Remarks

This parameter accepts OAuth and non-OAuth authentication types.

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

Catalog

The catalog name for the Starburst data source.

string Catalog { get; }

Property Value

string

Remarks

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

DatabaseAccessControlRole

The database access control role.

string? DatabaseAccessControlRole { get; }

Property Value

string

Remarks

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

Host

The host name of the Starburst data source.

string Host { get; }

Property Value

string

Remarks

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

OAuthParameters

An object that contains information needed to create a data source connection between an Amazon QuickSight account and Starburst.

object? OAuthParameters { get; }

Property Value

object

Remarks

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

Port

The port for the Starburst data source.

double Port { get; }

Property Value

double

Remarks

Default: - 0

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

ProductType

The product type for the Starburst data source.

string? ProductType { get; }

Property Value

string

Remarks

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