Class CfnDataSourcePropsMixin.StarburstParametersProperty

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

Inheritance

object

CfnDataSourcePropsMixin.StarburstParametersProperty

Implements

CfnDataSourcePropsMixin.IStarburstParametersProperty

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.StarburstParametersProperty : CfnDataSourcePropsMixin.IStarburstParametersProperty

Syntax (vb)

Public Class CfnDataSourcePropsMixin.StarburstParametersProperty Implements CfnDataSourcePropsMixin.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.Mixins.Preview.AWS.QuickSight.Mixins;

             var starburstParametersProperty = new StarburstParametersProperty {
                 AuthenticationType = "authenticationType",
                 Catalog = "catalog",
                 DatabaseAccessControlRole = "databaseAccessControlRole",
                 Host = "host",
                 OAuthParameters = new OAuthParametersProperty {
                     IdentityProviderResourceUri = "identityProviderResourceUri",
                     IdentityProviderVpcConnectionProperties = new VpcConnectionPropertiesProperty {
                         VpcConnectionArn = "vpcConnectionArn"
                     },
                     OAuthScope = "oAuthScope",
                     TokenProviderUrl = "tokenProviderUrl"
                 },
                 Port = 123,
                 ProductType = "productType"
             };

Synopsis

Constructors

StarburstParametersProperty()

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

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 Quick Sight account and Starburst.
Port	The port for the Starburst data source.
ProductType	The product type for the Starburst data source.

Constructors

StarburstParametersProperty()

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

public StarburstParametersProperty()

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.Mixins.Preview.AWS.QuickSight.Mixins;

             var starburstParametersProperty = new StarburstParametersProperty {
                 AuthenticationType = "authenticationType",
                 Catalog = "catalog",
                 DatabaseAccessControlRole = "databaseAccessControlRole",
                 Host = "host",
                 OAuthParameters = new OAuthParametersProperty {
                     IdentityProviderResourceUri = "identityProviderResourceUri",
                     IdentityProviderVpcConnectionProperties = new VpcConnectionPropertiesProperty {
                         VpcConnectionArn = "vpcConnectionArn"
                     },
                     OAuthScope = "oAuthScope",
                     TokenProviderUrl = "tokenProviderUrl"
                 },
                 Port = 123,
                 ProductType = "productType"
             };

Properties

AuthenticationType

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

public string? AuthenticationType { get; set; }

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.

public string? Catalog { get; set; }

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.

public string? DatabaseAccessControlRole { get; set; }

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.

public string? Host { get; set; }

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 Quick Sight account and Starburst.

public object? OAuthParameters { get; set; }

Property Value

object

Remarks

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

Type union: either IResolvable or CfnDataSourcePropsMixin.IOAuthParametersProperty

Port

The port for the Starburst data source.

public double? Port { get; set; }

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.

public string? ProductType { get; set; }

Property Value

string

Remarks

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

Implements

CfnDataSourcePropsMixin.IStarburstParametersProperty