interface DataSourceParametersProperty

Language	Type name
.NET	`Amazon.CDK.AWS.QuickSight.CfnDataSource.DataSourceParametersProperty`
Java	`software.amazon.awscdk.services.quicksight.CfnDataSource.DataSourceParametersProperty`
Python	`aws_cdk.aws_quicksight.CfnDataSource.DataSourceParametersProperty`
TypeScript	`@aws-cdk/aws-quicksight` » `CfnDataSource` » `DataSourceParametersProperty`

The parameters that Amazon QuickSight uses to connect to your underlying data source.

This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as quicksight from '@aws-cdk/aws-quicksight';
const dataSourceParametersProperty: quicksight.CfnDataSource.DataSourceParametersProperty = {
  amazonElasticsearchParameters: {
    domain: 'domain',
  },
  amazonOpenSearchParameters: {
    domain: 'domain',
  },
  athenaParameters: {
    roleArn: 'roleArn',
    workGroup: 'workGroup',
  },
  auroraParameters: {
    database: 'database',
    host: 'host',
    port: 123,
  },
  auroraPostgreSqlParameters: {
    database: 'database',
    host: 'host',
    port: 123,
  },
  databricksParameters: {
    host: 'host',
    port: 123,
    sqlEndpointPath: 'sqlEndpointPath',
  },
  mariaDbParameters: {
    database: 'database',
    host: 'host',
    port: 123,
  },
  mySqlParameters: {
    database: 'database',
    host: 'host',
    port: 123,
  },
  oracleParameters: {
    database: 'database',
    host: 'host',
    port: 123,
  },
  postgreSqlParameters: {
    database: 'database',
    host: 'host',
    port: 123,
  },
  prestoParameters: {
    catalog: 'catalog',
    host: 'host',
    port: 123,
  },
  rdsParameters: {
    database: 'database',
    instanceId: 'instanceId',
  },
  redshiftParameters: {
    database: 'database',

    // the properties below are optional
    clusterId: 'clusterId',
    host: 'host',
    port: 123,
  },
  s3Parameters: {
    manifestFileLocation: {
      bucket: 'bucket',
      key: 'key',
    },

    // the properties below are optional
    roleArn: 'roleArn',
  },
  snowflakeParameters: {
    database: 'database',
    host: 'host',
    warehouse: 'warehouse',
  },
  sparkParameters: {
    host: 'host',
    port: 123,
  },
  sqlServerParameters: {
    database: 'database',
    host: 'host',
    port: 123,
  },
  teradataParameters: {
    database: 'database',
    host: 'host',
    port: 123,
  },
};

Properties

Name	Type	Description
amazonElasticsearchParameters?	`IResolvable` `\|` `AmazonElasticsearchParametersProperty`	The parameters for OpenSearch.
amazonOpenSearchParameters?	`IResolvable` `\|` `AmazonOpenSearchParametersProperty`	The parameters for OpenSearch.
athenaParameters?	`IResolvable` `\|` `AthenaParametersProperty`	The parameters for Amazon Athena.
auroraParameters?	`IResolvable` `\|` `AuroraParametersProperty`	The parameters for Amazon Aurora MySQL.
auroraPostgreSqlParameters?	`IResolvable` `\|` `AuroraPostgreSqlParametersProperty`	The parameters for Amazon Aurora.
databricksParameters?	`IResolvable` `\|` `DatabricksParametersProperty`	The required parameters that are needed to connect to a Databricks data source.
mariaDbParameters?	`IResolvable` `\|` `MariaDbParametersProperty`	The parameters for MariaDB.
mySqlParameters?	`IResolvable` `\|` `MySqlParametersProperty`	The parameters for MySQL.
oracleParameters?	`IResolvable` `\|` `OracleParametersProperty`	Oracle parameters.
postgreSqlParameters?	`IResolvable` `\|` `PostgreSqlParametersProperty`	The parameters for PostgreSQL.
prestoParameters?	`IResolvable` `\|` `PrestoParametersProperty`	The parameters for Presto.
rdsParameters?	`IResolvable` `\|` `RdsParametersProperty`	The parameters for Amazon RDS.
redshiftParameters?	`IResolvable` `\|` `RedshiftParametersProperty`	The parameters for Amazon Redshift.
s3Parameters?	`IResolvable` `\|` `S3ParametersProperty`	The parameters for S3.
snowflakeParameters?	`IResolvable` `\|` `SnowflakeParametersProperty`	The parameters for Snowflake.
sparkParameters?	`IResolvable` `\|` `SparkParametersProperty`	The parameters for Spark.
sqlServerParameters?	`IResolvable` `\|` `SqlServerParametersProperty`	The parameters for SQL Server.
teradataParameters?	`IResolvable` `\|` `TeradataParametersProperty`	The parameters for Teradata.