Package software.amazon.awscdk.services.quicksight

Interface CfnDataSource.StarburstParametersProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDataSource.StarburstParametersProperty.Jsii$Proxy

Enclosing class:

CfnDataSource

@Stability(Stable)
public static interface CfnDataSource.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.services.quicksight.*;
 StarburstParametersProperty starburstParametersProperty = StarburstParametersProperty.builder()
         .catalog("catalog")
         .host("host")
         .port(123)
         // the properties below are optional
         .authenticationType("authenticationType")
         .databaseAccessControlRole("databaseAccessControlRole")
         .oAuthParameters(OAuthParametersProperty.builder()
                 .tokenProviderUrl("tokenProviderUrl")
                 // the properties below are optional
                 .identityProviderResourceUri("identityProviderResourceUri")
                 .identityProviderVpcConnectionProperties(VpcConnectionPropertiesProperty.builder()
                         .vpcConnectionArn("vpcConnectionArn")
                         .build())
                 .oAuthScope("oAuthScope")
                 .build())
         .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	CfnDataSource.StarburstParametersProperty.Builder	A builder for CfnDataSource.StarburstParametersProperty
static final class	CfnDataSource.StarburstParametersProperty.Jsii$Proxy	An implementation for CfnDataSource.StarburstParametersProperty

Method Summary

Modifier and Type	Method	Description
static CfnDataSource.StarburstParametersProperty.Builder	builder()
default String	getAuthenticationType()	The authentication type that you want to use for your connection.
String	getCatalog()	The catalog name for the Starburst data source.
default String	getDatabaseAccessControlRole()	The database access control role.
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 Amazon QuickSight account and Starburst.
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

getCatalog

@Stability(Stable)
@NotNull
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

getHost

@Stability(Stable)
@NotNull
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

getPort

@Stability(Stable)
@NotNull
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

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

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

getOAuthParameters

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

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

See Also:

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

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 CfnDataSource.StarburstParametersProperty.Builder builder()

Returns:

a CfnDataSource.StarburstParametersProperty.Builder of CfnDataSource.StarburstParametersProperty