Interface CfnDataSource.DataSourceParametersProperty
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnDataSource.DataSourceParametersProperty.Jsii$Proxy
- Enclosing class:
CfnDataSource
@Stability(Stable)
public static interface CfnDataSource.DataSourceParametersProperty
extends software.amazon.jsii.JsiiSerializable
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 software.amazon.awscdk.services.quicksight.*; DataSourceParametersProperty dataSourceParametersProperty = DataSourceParametersProperty.builder() .amazonElasticsearchParameters(AmazonElasticsearchParametersProperty.builder() .domain("domain") .build()) .amazonOpenSearchParameters(AmazonOpenSearchParametersProperty.builder() .domain("domain") .build()) .athenaParameters(AthenaParametersProperty.builder() .roleArn("roleArn") .workGroup("workGroup") .build()) .auroraParameters(AuroraParametersProperty.builder() .database("database") .host("host") .port(123) .build()) .auroraPostgreSqlParameters(AuroraPostgreSqlParametersProperty.builder() .database("database") .host("host") .port(123) .build()) .databricksParameters(DatabricksParametersProperty.builder() .host("host") .port(123) .sqlEndpointPath("sqlEndpointPath") .build()) .mariaDbParameters(MariaDbParametersProperty.builder() .database("database") .host("host") .port(123) .build()) .mySqlParameters(MySqlParametersProperty.builder() .database("database") .host("host") .port(123) .build()) .oracleParameters(OracleParametersProperty.builder() .database("database") .host("host") .port(123) .build()) .postgreSqlParameters(PostgreSqlParametersProperty.builder() .database("database") .host("host") .port(123) .build()) .prestoParameters(PrestoParametersProperty.builder() .catalog("catalog") .host("host") .port(123) .build()) .rdsParameters(RdsParametersProperty.builder() .database("database") .instanceId("instanceId") .build()) .redshiftParameters(RedshiftParametersProperty.builder() .database("database") // the properties below are optional .clusterId("clusterId") .host("host") .port(123) .build()) .s3Parameters(S3ParametersProperty.builder() .manifestFileLocation(ManifestFileLocationProperty.builder() .bucket("bucket") .key("key") .build()) // the properties below are optional .roleArn("roleArn") .build()) .snowflakeParameters(SnowflakeParametersProperty.builder() .database("database") .host("host") .warehouse("warehouse") .build()) .sparkParameters(SparkParametersProperty.builder() .host("host") .port(123) .build()) .sqlServerParameters(SqlServerParametersProperty.builder() .database("database") .host("host") .port(123) .build()) .teradataParameters(TeradataParametersProperty.builder() .database("database") .host("host") .port(123) .build()) .build();
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final class
A builder forCfnDataSource.DataSourceParametersProperty
static final class
An implementation forCfnDataSource.DataSourceParametersProperty
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
default Object
The parameters for OpenSearch.default Object
The parameters for OpenSearch.default Object
The parameters for Amazon Athena.default Object
The parameters for Amazon Aurora MySQL.default Object
The parameters for Amazon Aurora.default Object
The required parameters that are needed to connect to a Databricks data source.default Object
The parameters for MariaDB.default Object
The parameters for MySQL.default Object
Oracle parameters.default Object
The parameters for PostgreSQL.default Object
The parameters for Presto.default Object
The parameters for Amazon RDS.default Object
The parameters for Amazon Redshift.default Object
The parameters for S3.default Object
The parameters for Snowflake.default Object
The parameters for Spark.default Object
The parameters for SQL Server.default Object
The parameters for Teradata.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getAmazonElasticsearchParameters
The parameters for OpenSearch. -
getAmazonOpenSearchParameters
The parameters for OpenSearch. -
getAthenaParameters
The parameters for Amazon Athena. -
getAuroraParameters
The parameters for Amazon Aurora MySQL. -
getAuroraPostgreSqlParameters
The parameters for Amazon Aurora. -
getDatabricksParameters
The required parameters that are needed to connect to a Databricks data source. -
getMariaDbParameters
The parameters for MariaDB. -
getMySqlParameters
The parameters for MySQL. -
getOracleParameters
Oracle parameters. -
getPostgreSqlParameters
The parameters for PostgreSQL. -
getPrestoParameters
The parameters for Presto. -
getRdsParameters
The parameters for Amazon RDS. -
getRedshiftParameters
The parameters for Amazon Redshift. -
getS3Parameters
The parameters for S3. -
getSnowflakeParameters
The parameters for Snowflake. -
getSparkParameters
The parameters for Spark. -
getSqlServerParameters
The parameters for SQL Server. -
getTeradataParameters
The parameters for Teradata. -
builder
-