software.amazon.awscdk.services.quicksight

Interface CfnDataSource.DataSourceParametersProperty

All Known Implementing Classes:

CfnDataSource.DataSourceParametersProperty.Jsii$Proxy

Enclosing class:

CfnDataSource

public static interface 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 software.amazon.awscdk.services.quicksight.*;
 DataSourceParametersProperty dataSourceParametersProperty = DataSourceParametersProperty.builder()
         .amazonElasticsearchParameters(AmazonElasticsearchParametersProperty.builder()
                 .domain("domain")
                 .build())
         .amazonOpenSearchParameters(AmazonOpenSearchParametersProperty.builder()
                 .domain("domain")
                 .build())
         .athenaParameters(AthenaParametersProperty.builder()
                 .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())
                 .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 Classes

Modifier and Type	Interface and Description
static class	CfnDataSource.DataSourceParametersProperty.Builder A builder for CfnDataSource.DataSourceParametersProperty
static class	CfnDataSource.DataSourceParametersProperty.Jsii$Proxy An implementation for CfnDataSource.DataSourceParametersProperty

Method Summary

Modifier and Type	Method and Description
static CfnDataSource.DataSourceParametersProperty.Builder	builder()
default java.lang.Object	getAmazonElasticsearchParameters() The parameters for OpenSearch.
default java.lang.Object	getAmazonOpenSearchParameters() The parameters for OpenSearch.
default java.lang.Object	getAthenaParameters() The parameters for Amazon Athena.
default java.lang.Object	getAuroraParameters() The parameters for Amazon Aurora MySQL.
default java.lang.Object	getAuroraPostgreSqlParameters() The parameters for Amazon Aurora.
default java.lang.Object	getDatabricksParameters() The required parameters that are needed to connect to a Databricks data source.
default java.lang.Object	getMariaDbParameters() The parameters for MariaDB.
default java.lang.Object	getMySqlParameters() The parameters for MySQL.
default java.lang.Object	getOracleParameters() Oracle parameters.
default java.lang.Object	getPostgreSqlParameters() The parameters for PostgreSQL.
default java.lang.Object	getPrestoParameters() The parameters for Presto.
default java.lang.Object	getRdsParameters() The parameters for Amazon RDS.
default java.lang.Object	getRedshiftParameters() The parameters for Amazon Redshift.
default java.lang.Object	getS3Parameters() The parameters for S3.
default java.lang.Object	getSnowflakeParameters() The parameters for Snowflake.
default java.lang.Object	getSparkParameters() The parameters for Spark.
default java.lang.Object	getSqlServerParameters() The parameters for SQL Server.
default java.lang.Object	getTeradataParameters() The parameters for Teradata.

Method Detail

getAmazonElasticsearchParameters

default java.lang.Object getAmazonElasticsearchParameters()

The parameters for OpenSearch.

getAmazonOpenSearchParameters

default java.lang.Object getAmazonOpenSearchParameters()

The parameters for OpenSearch.

getAthenaParameters

default java.lang.Object getAthenaParameters()

The parameters for Amazon Athena.

getAuroraParameters

default java.lang.Object getAuroraParameters()

The parameters for Amazon Aurora MySQL.

getAuroraPostgreSqlParameters

default java.lang.Object getAuroraPostgreSqlParameters()

The parameters for Amazon Aurora.

getDatabricksParameters

default java.lang.Object getDatabricksParameters()

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

getMariaDbParameters

default java.lang.Object getMariaDbParameters()

The parameters for MariaDB.

getMySqlParameters

default java.lang.Object getMySqlParameters()

The parameters for MySQL.

getOracleParameters

default java.lang.Object getOracleParameters()

Oracle parameters.

getPostgreSqlParameters

default java.lang.Object getPostgreSqlParameters()

The parameters for PostgreSQL.

getPrestoParameters

default java.lang.Object getPrestoParameters()

The parameters for Presto.

getRdsParameters

default java.lang.Object getRdsParameters()

The parameters for Amazon RDS.

getRedshiftParameters

default java.lang.Object getRedshiftParameters()

The parameters for Amazon Redshift.

getS3Parameters

default java.lang.Object getS3Parameters()

The parameters for S3.

getSnowflakeParameters

default java.lang.Object getSnowflakeParameters()

The parameters for Snowflake.

getSparkParameters

default java.lang.Object getSparkParameters()

The parameters for Spark.

getSqlServerParameters

default java.lang.Object getSqlServerParameters()

The parameters for SQL Server.

getTeradataParameters

default java.lang.Object getTeradataParameters()

The parameters for Teradata.

builder

static CfnDataSource.DataSourceParametersProperty.Builder builder()

Returns:

a CfnDataSource.DataSourceParametersProperty.Builder of CfnDataSource.DataSourceParametersProperty