aws-cdk-lib.aws_quicksight.CfnDataSource.DatabricksParametersProperty

DatabricksParametersProperty Struct

The required parameters that are needed to connect to a Databricks data source.

Source

Generated code

Type last changed

v2.274.0 · 20 Oct 2026

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 databricksParametersProperty: quicksight.CfnDataSource.DatabricksParametersProperty = {
  host: 'host',
  port: 123,
  sqlEndpointPath: 'sqlEndpointPath',

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

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

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_quicksight as quicksight

databricks_parameters_property = quicksight.CfnDataSource.DatabricksParametersProperty(
    host="host",
    port=123,
    sql_endpoint_path="sqlEndpointPath",

    # the properties below are optional
    authentication_type="authenticationType",
    o_auth_parameters=quicksight.CfnDataSource.OAuthParametersProperty(
        token_provider_url="tokenProviderUrl",

        # the properties below are optional
        identity_provider_resource_uri="identityProviderResourceUri",
        identity_provider_vpc_connection_properties=quicksight.CfnDataSource.VpcConnectionPropertiesProperty(
            vpc_connection_arn="vpcConnectionArn"
        ),
        o_auth_scope="oAuthScope"
    )
)

// 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.*;

DatabricksParametersProperty databricksParametersProperty = DatabricksParametersProperty.builder()
        .host("host")
        .port(123)
        .sqlEndpointPath("sqlEndpointPath")

        // the properties below are optional
        .authenticationType("authenticationType")
        .oAuthParameters(OAuthParametersProperty.builder()
                .tokenProviderUrl("tokenProviderUrl")

                // the properties below are optional
                .identityProviderResourceUri("identityProviderResourceUri")
                .identityProviderVpcConnectionProperties(VpcConnectionPropertiesProperty.builder()
                        .vpcConnectionArn("vpcConnectionArn")
                        .build())
                .oAuthScope("oAuthScope")
                .build())
        .build();

// Install: dotnet add package Amazon.CDK.Lib
// 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 databricksParametersProperty = new DatabricksParametersProperty {
    Host = "host",
    Port = 123,
    SqlEndpointPath = "sqlEndpointPath",

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

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

// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

databricksParametersProperty := &DatabricksParametersProperty{
	Host: jsii.String("host"),
	Port: jsii.Number(123),
	SqlEndpointPath: jsii.String("sqlEndpointPath"),

	// the properties below are optional
	AuthenticationType: jsii.String("authenticationType"),
	OAuthParameters: &OAuthParametersProperty{
		TokenProviderUrl: jsii.String("tokenProviderUrl"),

		// the properties below are optional
		IdentityProviderResourceUri: jsii.String("identityProviderResourceUri"),
		IdentityProviderVpcConnectionProperties: &VpcConnectionPropertiesProperty{
			VpcConnectionArn: jsii.String("vpcConnectionArn"),
		},
		OAuthScope: jsii.String("oAuthScope"),
	},
}

Properties

authenticationType?optionalstringauthentication_type?optionalstrauthenticationType?optionalStringAuthenticationType?optionalstringAuthenticationType?optional*string#

hoststringhoststrhostStringHoststringHost*stringrequired#

The host name of the Databricks data source.

oAuthParameters?optionalIResolvable | CfnDataSource.OAuthParametersPropertyo_auth_parameters?optionaltyping.Union[IResolvable, OAuthParametersProperty]oAuthParameters?optionalIResolvableOAuthParameters?optionalIResolvableOAuthParameters?optionalinterface{}#

portnumberportint | floatportNumberPortdoublePort*float64= 0required#

The port for the Databricks data source.

sqlEndpointPathstringsql_endpoint_pathstrsqlEndpointPathStringSqlEndpointPathstringSqlEndpointPath*stringrequired#

The HTTP path of the Databricks data source.