interface DataSourceParametersProperty
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.QuickSight.CfnDataSource.DataSourceParametersProperty |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsquicksight#CfnDataSource_DataSourceParametersProperty |
![]() | software.amazon.awscdk.services.quicksight.CfnDataSource.DataSourceParametersProperty |
![]() | aws_cdk.aws_quicksight.CfnDataSource.DataSourceParametersProperty |
![]() | 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',
iamParameters: {
roleArn: 'roleArn',
// the properties below are optional
autoCreateDatabaseUser: false,
databaseGroups: ['databaseGroups'],
databaseUser: 'databaseUser',
},
identityCenterConfiguration: {
enableIdentityPropagation: false,
},
port: 123,
},
s3Parameters: {
manifestFileLocation: {
bucket: 'bucket',
key: 'key',
},
// the properties below are optional
roleArn: 'roleArn',
},
snowflakeParameters: {
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',
},
},
sparkParameters: {
host: 'host',
port: 123,
},
sqlServerParameters: {
database: 'database',
host: 'host',
port: 123,
},
starburstParameters: {
catalog: 'catalog',
host: 'host',
port: 123,
// the properties below are optional
authenticationType: 'authenticationType',
databaseAccessControlRole: 'databaseAccessControlRole',
oAuthParameters: {
tokenProviderUrl: 'tokenProviderUrl',
// the properties below are optional
identityProviderResourceUri: 'identityProviderResourceUri',
identityProviderVpcConnectionProperties: {
vpcConnectionArn: 'vpcConnectionArn',
},
oAuthScope: 'oAuthScope',
},
productType: 'productType',
},
teradataParameters: {
database: 'database',
host: 'host',
port: 123,
},
trinoParameters: {
catalog: 'catalog',
host: 'host',
port: 123,
},
};
Properties
Name | Type | Description |
---|---|---|
amazon | IResolvable | Amazon | The parameters for OpenSearch. |
amazon | IResolvable | Amazon | The parameters for OpenSearch. |
athena | IResolvable | Athena | The parameters for Amazon Athena. |
aurora | IResolvable | Aurora | The parameters for Amazon Aurora MySQL. |
aurora | IResolvable | Aurora | The parameters for Amazon Aurora. |
databricks | IResolvable | Databricks | The required parameters that are needed to connect to a Databricks data source. |
maria | IResolvable | Maria | The parameters for MariaDB. |
my | IResolvable | My | The parameters for MySQL. |
oracle | IResolvable | Oracle | Oracle parameters. |
postgre | IResolvable | Postgre | The parameters for PostgreSQL. |
presto | IResolvable | Presto | The parameters for Presto. |
rds | IResolvable | Rds | The parameters for Amazon RDS. |
redshift | IResolvable | Redshift | The parameters for Amazon Redshift. |
s3 | IResolvable | S3 | The parameters for S3. |
snowflake | IResolvable | Snowflake | The parameters for Snowflake. |
spark | IResolvable | Spark | The parameters for Spark. |
sql | IResolvable | Sql | The parameters for SQL Server. |
starburst | IResolvable | Starburst | The parameters that are required to connect to a Starburst data source. |
teradata | IResolvable | Teradata | The parameters for Teradata. |
trino | IResolvable | Trino | The parameters that are required to connect to a Trino data source. |
amazonElasticsearchParameters?
Type:
IResolvable
|
Amazon
(optional)
The parameters for OpenSearch.
amazonOpenSearchParameters?
Type:
IResolvable
|
Amazon
(optional)
The parameters for OpenSearch.
athenaParameters?
Type:
IResolvable
|
Athena
(optional)
The parameters for Amazon Athena.
auroraParameters?
Type:
IResolvable
|
Aurora
(optional)
The parameters for Amazon Aurora MySQL.
auroraPostgreSqlParameters?
Type:
IResolvable
|
Aurora
(optional)
The parameters for Amazon Aurora.
databricksParameters?
Type:
IResolvable
|
Databricks
(optional)
The required parameters that are needed to connect to a Databricks data source.
mariaDbParameters?
Type:
IResolvable
|
Maria
(optional)
The parameters for MariaDB.
mySqlParameters?
Type:
IResolvable
|
My
(optional)
The parameters for MySQL.
oracleParameters?
Type:
IResolvable
|
Oracle
(optional)
Oracle parameters.
postgreSqlParameters?
Type:
IResolvable
|
Postgre
(optional)
The parameters for PostgreSQL.
prestoParameters?
Type:
IResolvable
|
Presto
(optional)
The parameters for Presto.
rdsParameters?
Type:
IResolvable
|
Rds
(optional)
The parameters for Amazon RDS.
redshiftParameters?
Type:
IResolvable
|
Redshift
(optional)
The parameters for Amazon Redshift.
s3Parameters?
Type:
IResolvable
|
S3
(optional)
The parameters for S3.
snowflakeParameters?
Type:
IResolvable
|
Snowflake
(optional)
The parameters for Snowflake.
sparkParameters?
Type:
IResolvable
|
Spark
(optional)
The parameters for Spark.
sqlServerParameters?
Type:
IResolvable
|
Sql
(optional)
The parameters for SQL Server.
starburstParameters?
Type:
IResolvable
|
Starburst
(optional)
The parameters that are required to connect to a Starburst data source.
teradataParameters?
Type:
IResolvable
|
Teradata
(optional)
The parameters for Teradata.
trinoParameters?
Type:
IResolvable
|
Trino
(optional)
The parameters that are required to connect to a Trino data source.