aws-cdk-lib.aws_quicksight.CfnDataSource.DataSourceParametersProperty

interface DataSourceParametersProperty

LanguageType name
.NETAmazon.CDK.AWS.QuickSight.CfnDataSource.DataSourceParametersProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsquicksight#CfnDataSource_DataSourceParametersProperty
Javasoftware.amazon.awscdk.services.quicksight.CfnDataSource.DataSourceParametersProperty
Pythonaws_cdk.aws_quicksight.CfnDataSource.DataSourceParametersProperty
TypeScript aws-cdk-lib » 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 { aws_quicksight as quicksight } from 'aws-cdk-lib';
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

NameTypeDescription
amazonElasticsearchParameters?IResolvable | AmazonElasticsearchParametersPropertyThe parameters for OpenSearch.
amazonOpenSearchParameters?IResolvable | AmazonOpenSearchParametersPropertyThe parameters for OpenSearch.
athenaParameters?IResolvable | AthenaParametersPropertyThe parameters for Amazon Athena.
auroraParameters?IResolvable | AuroraParametersPropertyThe parameters for Amazon Aurora MySQL.
auroraPostgreSqlParameters?IResolvable | AuroraPostgreSqlParametersPropertyThe parameters for Amazon Aurora.
databricksParameters?IResolvable | DatabricksParametersPropertyThe required parameters that are needed to connect to a Databricks data source.
mariaDbParameters?IResolvable | MariaDbParametersPropertyThe parameters for MariaDB.
mySqlParameters?IResolvable | MySqlParametersPropertyThe parameters for MySQL.
oracleParameters?IResolvable | OracleParametersPropertyOracle parameters.
postgreSqlParameters?IResolvable | PostgreSqlParametersPropertyThe parameters for PostgreSQL.
prestoParameters?IResolvable | PrestoParametersPropertyThe parameters for Presto.
rdsParameters?IResolvable | RdsParametersPropertyThe parameters for Amazon RDS.
redshiftParameters?IResolvable | RedshiftParametersPropertyThe parameters for Amazon Redshift.
s3Parameters?IResolvable | S3ParametersPropertyThe parameters for S3.
snowflakeParameters?IResolvable | SnowflakeParametersPropertyThe parameters for Snowflake.
sparkParameters?IResolvable | SparkParametersPropertyThe parameters for Spark.
sqlServerParameters?IResolvable | SqlServerParametersPropertyThe parameters for SQL Server.
teradataParameters?IResolvable | TeradataParametersPropertyThe parameters for Teradata.

amazonElasticsearchParameters?

Type: IResolvable | AmazonElasticsearchParametersProperty (optional)

The parameters for OpenSearch.


amazonOpenSearchParameters?

Type: IResolvable | AmazonOpenSearchParametersProperty (optional)

The parameters for OpenSearch.


athenaParameters?

Type: IResolvable | AthenaParametersProperty (optional)

The parameters for Amazon Athena.


auroraParameters?

Type: IResolvable | AuroraParametersProperty (optional)

The parameters for Amazon Aurora MySQL.


auroraPostgreSqlParameters?

Type: IResolvable | AuroraPostgreSqlParametersProperty (optional)

The parameters for Amazon Aurora.


databricksParameters?

Type: IResolvable | DatabricksParametersProperty (optional)

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


mariaDbParameters?

Type: IResolvable | MariaDbParametersProperty (optional)

The parameters for MariaDB.


mySqlParameters?

Type: IResolvable | MySqlParametersProperty (optional)

The parameters for MySQL.


oracleParameters?

Type: IResolvable | OracleParametersProperty (optional)

Oracle parameters.


postgreSqlParameters?

Type: IResolvable | PostgreSqlParametersProperty (optional)

The parameters for PostgreSQL.


prestoParameters?

Type: IResolvable | PrestoParametersProperty (optional)

The parameters for Presto.


rdsParameters?

Type: IResolvable | RdsParametersProperty (optional)

The parameters for Amazon RDS.


redshiftParameters?

Type: IResolvable | RedshiftParametersProperty (optional)

The parameters for Amazon Redshift.


s3Parameters?

Type: IResolvable | S3ParametersProperty (optional)

The parameters for S3.


snowflakeParameters?

Type: IResolvable | SnowflakeParametersProperty (optional)

The parameters for Snowflake.


sparkParameters?

Type: IResolvable | SparkParametersProperty (optional)

The parameters for Spark.


sqlServerParameters?

Type: IResolvable | SqlServerParametersProperty (optional)

The parameters for SQL Server.


teradataParameters?

Type: IResolvable | TeradataParametersProperty (optional)

The parameters for Teradata.