Package software.amazon.awscdk.cfnpropertymixins.services.quicksight

Interface CfnDataSourcePropsMixin.StarburstParametersProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDataSourcePropsMixin.StarburstParametersProperty.Jsii$Proxy

Enclosing class:

CfnDataSourcePropsMixin

@Stability(Stable)
public static interface CfnDataSourcePropsMixin.StarburstParametersProperty
extends software.amazon.jsii.JsiiSerializable

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

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.quicksight.*;
 StarburstParametersProperty starburstParametersProperty = StarburstParametersProperty.builder()
         .authenticationType("authenticationType")
         .catalog("catalog")
         .databaseAccessControlRole("databaseAccessControlRole")
         .host("host")
         .oAuthParameters(OAuthParametersProperty.builder()
                 .identityProviderResourceUri("identityProviderResourceUri")
                 .identityProviderVpcConnectionProperties(VpcConnectionPropertiesProperty.builder()
                         .vpcConnectionArn("vpcConnectionArn")
                         .build())
                 .oAuthScope("oAuthScope")
                 .tokenProviderUrl("tokenProviderUrl")
                 .build())
         .port(123)
         .productType("productType")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnDataSourcePropsMixin.StarburstParametersProperty.Builder	A builder for CfnDataSourcePropsMixin.StarburstParametersProperty
static final class	CfnDataSourcePropsMixin.StarburstParametersProperty.Jsii$Proxy	An implementation for CfnDataSourcePropsMixin.StarburstParametersProperty

Method Summary

Modifier and Type	Method	Description
static CfnDataSourcePropsMixin.StarburstParametersProperty.Builder	builder()
default String	getAuthenticationType()	The authentication type that you want to use for your connection.
default String	getCatalog()	The catalog name for the Starburst data source.
default String	getDatabaseAccessControlRole()	The database access control role.
default String	getHost()	The host name of the Starburst data source.
default Object	getOAuthParameters()	An object that contains information needed to create a data source connection between an Quick Sight account and Starburst.
default Number	getPort()	The port for the Starburst data source.
default String	getProductType()	The product type for the Starburst data source.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAuthenticationType

@Stability(Stable)
@Nullable
default String getAuthenticationType()

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

This parameter accepts OAuth and non-OAuth authentication types.

See Also:

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

getCatalog

@Stability(Stable)
@Nullable
default String getCatalog()

The catalog name for the Starburst data source.

See Also:

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

getDatabaseAccessControlRole

@Stability(Stable)
@Nullable
default String getDatabaseAccessControlRole()

The database access control role.

See Also:

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

getHost

@Stability(Stable)
@Nullable
default String getHost()

The host name of the Starburst data source.

See Also:

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

getOAuthParameters

@Stability(Stable)
@Nullable
default Object getOAuthParameters()

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

Returns union: either IResolvable or CfnDataSourcePropsMixin.OAuthParametersProperty

See Also:

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

getPort

@Stability(Stable)
@Nullable
default Number getPort()

The port for the Starburst data source.

Default: - 0

See Also:

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

getProductType

@Stability(Stable)
@Nullable
default String getProductType()

The product type for the Starburst data source.

See Also:

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

builder

@Stability(Stable)
static CfnDataSourcePropsMixin.StarburstParametersProperty.Builder builder()

Returns:

a CfnDataSourcePropsMixin.StarburstParametersProperty.Builder of CfnDataSourcePropsMixin.StarburstParametersProperty