Interface CfnDataSource.IDataSourceParametersProperty
The parameters that Amazon QuickSight uses to connect to your underlying data source.
Namespace: Amazon.CDK.AWS.QuickSight
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface IDataSourceParametersProperty
Syntax (vb)
Public Interface IDataSourceParametersProperty
Remarks
This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.
ExampleMetadata: fixture=_generated
Examples
// 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 dataSourceParametersProperty = new DataSourceParametersProperty {
AmazonElasticsearchParameters = new AmazonElasticsearchParametersProperty {
Domain = "domain"
},
AmazonOpenSearchParameters = new AmazonOpenSearchParametersProperty {
Domain = "domain"
},
AthenaParameters = new AthenaParametersProperty {
RoleArn = "roleArn",
WorkGroup = "workGroup"
},
AuroraParameters = new AuroraParametersProperty {
Database = "database",
Host = "host",
Port = 123
},
AuroraPostgreSqlParameters = new AuroraPostgreSqlParametersProperty {
Database = "database",
Host = "host",
Port = 123
},
DatabricksParameters = new DatabricksParametersProperty {
Host = "host",
Port = 123,
SqlEndpointPath = "sqlEndpointPath"
},
MariaDbParameters = new MariaDbParametersProperty {
Database = "database",
Host = "host",
Port = 123
},
MySqlParameters = new MySqlParametersProperty {
Database = "database",
Host = "host",
Port = 123
},
OracleParameters = new OracleParametersProperty {
Database = "database",
Host = "host",
Port = 123
},
PostgreSqlParameters = new PostgreSqlParametersProperty {
Database = "database",
Host = "host",
Port = 123
},
PrestoParameters = new PrestoParametersProperty {
Catalog = "catalog",
Host = "host",
Port = 123
},
RdsParameters = new RdsParametersProperty {
Database = "database",
InstanceId = "instanceId"
},
RedshiftParameters = new RedshiftParametersProperty {
Database = "database",
// the properties below are optional
ClusterId = "clusterId",
Host = "host",
Port = 123
},
S3Parameters = new S3ParametersProperty {
ManifestFileLocation = new ManifestFileLocationProperty {
Bucket = "bucket",
Key = "key"
},
// the properties below are optional
RoleArn = "roleArn"
},
SnowflakeParameters = new SnowflakeParametersProperty {
Database = "database",
Host = "host",
Warehouse = "warehouse"
},
SparkParameters = new SparkParametersProperty {
Host = "host",
Port = 123
},
SqlServerParameters = new SqlServerParametersProperty {
Database = "database",
Host = "host",
Port = 123
},
StarburstParameters = new StarburstParametersProperty {
Catalog = "catalog",
Host = "host",
Port = 123,
// the properties below are optional
ProductType = "productType"
},
TeradataParameters = new TeradataParametersProperty {
Database = "database",
Host = "host",
Port = 123
},
TrinoParameters = new TrinoParametersProperty {
Catalog = "catalog",
Host = "host",
Port = 123
}
};
Synopsis
Properties
AmazonElasticsearchParameters | The parameters for OpenSearch. |
AmazonOpenSearchParameters | The parameters for OpenSearch. |
AthenaParameters | The parameters for Amazon Athena. |
AuroraParameters | The parameters for Amazon Aurora MySQL. |
AuroraPostgreSqlParameters | The parameters for Amazon Aurora. |
DatabricksParameters | The required parameters that are needed to connect to a Databricks data source. |
MariaDbParameters | The parameters for MariaDB. |
MySqlParameters | The parameters for MySQL. |
OracleParameters | Oracle parameters. |
PostgreSqlParameters | The parameters for PostgreSQL. |
PrestoParameters | The parameters for Presto. |
RdsParameters | The parameters for Amazon RDS. |
RedshiftParameters | The parameters for Amazon Redshift. |
S3Parameters | The parameters for S3. |
SnowflakeParameters | The parameters for Snowflake. |
SparkParameters | The parameters for Spark. |
SqlServerParameters | The parameters for SQL Server. |
StarburstParameters | The parameters that are required to connect to a Starburst data source. |
TeradataParameters | The parameters for Teradata. |
TrinoParameters | The parameters that are required to connect to a Trino data source. |
Properties
AmazonElasticsearchParameters
The parameters for OpenSearch.
virtual object AmazonElasticsearchParameters { get; }
Property Value
System.Object
Remarks
AmazonOpenSearchParameters
The parameters for OpenSearch.
virtual object AmazonOpenSearchParameters { get; }
Property Value
System.Object
Remarks
AthenaParameters
The parameters for Amazon Athena.
virtual object AthenaParameters { get; }
Property Value
System.Object
Remarks
AuroraParameters
The parameters for Amazon Aurora MySQL.
virtual object AuroraParameters { get; }
Property Value
System.Object
Remarks
AuroraPostgreSqlParameters
The parameters for Amazon Aurora.
virtual object AuroraPostgreSqlParameters { get; }
Property Value
System.Object
Remarks
DatabricksParameters
The required parameters that are needed to connect to a Databricks data source.
virtual object DatabricksParameters { get; }
Property Value
System.Object
Remarks
MariaDbParameters
The parameters for MariaDB.
virtual object MariaDbParameters { get; }
Property Value
System.Object
Remarks
MySqlParameters
The parameters for MySQL.
virtual object MySqlParameters { get; }
Property Value
System.Object
Remarks
OracleParameters
Oracle parameters.
virtual object OracleParameters { get; }
Property Value
System.Object
Remarks
PostgreSqlParameters
The parameters for PostgreSQL.
virtual object PostgreSqlParameters { get; }
Property Value
System.Object
Remarks
PrestoParameters
The parameters for Presto.
virtual object PrestoParameters { get; }
Property Value
System.Object
Remarks
RdsParameters
The parameters for Amazon RDS.
virtual object RdsParameters { get; }
Property Value
System.Object
Remarks
RedshiftParameters
The parameters for Amazon Redshift.
virtual object RedshiftParameters { get; }
Property Value
System.Object
Remarks
S3Parameters
The parameters for S3.
virtual object S3Parameters { get; }
Property Value
System.Object
Remarks
SnowflakeParameters
The parameters for Snowflake.
virtual object SnowflakeParameters { get; }
Property Value
System.Object
Remarks
SparkParameters
The parameters for Spark.
virtual object SparkParameters { get; }
Property Value
System.Object
Remarks
SqlServerParameters
The parameters for SQL Server.
virtual object SqlServerParameters { get; }
Property Value
System.Object
Remarks
StarburstParameters
The parameters that are required to connect to a Starburst data source.
virtual object StarburstParameters { get; }
Property Value
System.Object
Remarks
TeradataParameters
The parameters for Teradata.
virtual object TeradataParameters { get; }
Property Value
System.Object
Remarks
TrinoParameters
The parameters that are required to connect to a Trino data source.
virtual object TrinoParameters { get; }
Property Value
System.Object