aws-cdk-lib.aws_quicksight.CfnDataSource.SnowflakeParametersProperty

SnowflakeParametersProperty Struct

The parameters for Snowflake.

Source

Generated code

Type last changed

v2.167.0 · 13 Nov 2024

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 snowflakeParametersProperty: quicksight.CfnDataSource.SnowflakeParametersProperty = {
  database: 'database',
  host: 'host',
  warehouse: 'warehouse',

  // the properties below are optional
  authenticationType: 'authenticationType',
  databaseAccessControlRole: 'databaseAccessControlRole',
  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

snowflake_parameters_property = quicksight.CfnDataSource.SnowflakeParametersProperty(
    database="database",
    host="host",
    warehouse="warehouse",

    # the properties below are optional
    authentication_type="authenticationType",
    database_access_control_role="databaseAccessControlRole",
    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.*;

SnowflakeParametersProperty snowflakeParametersProperty = SnowflakeParametersProperty.builder()
        .database("database")
        .host("host")
        .warehouse("warehouse")

        // 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())
        .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 snowflakeParametersProperty = new SnowflakeParametersProperty {
    Database = "database",
    Host = "host",
    Warehouse = "warehouse",

    // 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"
    }
};

// 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"

snowflakeParametersProperty := &SnowflakeParametersProperty{
	Database: jsii.String("database"),
	Host: jsii.String("host"),
	Warehouse: jsii.String("warehouse"),

	// the properties below are optional
	AuthenticationType: jsii.String("authenticationType"),
	DatabaseAccessControlRole: jsii.String("databaseAccessControlRole"),
	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#

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

This parameter accepts OAuth and non-OAuth authentication types.

databasestringdatabasestrdatabaseStringDatabasestringDatabase*stringrequired#

Database.

databaseAccessControlRole?optionalstringdatabase_access_control_role?optionalstrdatabaseAccessControlRole?optionalStringDatabaseAccessControlRole?optionalstringDatabaseAccessControlRole?optional*string#

The database access control role.

hoststringhoststrhostStringHoststringHost*stringrequired#

Host.

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

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

warehousestringwarehousestrwarehouseStringWarehousestringWarehouse*stringrequired#

Warehouse.