Package software.amazon.awscdk.services.quicksight

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 Classes

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

Method Summary

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAmazonElasticsearchParameters

@Stability(Stable)
@Nullable
default Object getAmazonElasticsearchParameters()

The parameters for OpenSearch.

getAmazonOpenSearchParameters

@Stability(Stable)
@Nullable
default Object getAmazonOpenSearchParameters()

The parameters for OpenSearch.

getAthenaParameters

@Stability(Stable)
@Nullable
default Object getAthenaParameters()

The parameters for Amazon Athena.

getAuroraParameters

@Stability(Stable)
@Nullable
default Object getAuroraParameters()

The parameters for Amazon Aurora MySQL.

getAuroraPostgreSqlParameters

@Stability(Stable)
@Nullable
default Object getAuroraPostgreSqlParameters()

The parameters for Amazon Aurora.

getDatabricksParameters

@Stability(Stable)
@Nullable
default Object getDatabricksParameters()

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

getMariaDbParameters

@Stability(Stable)
@Nullable
default Object getMariaDbParameters()

The parameters for MariaDB.

getMySqlParameters

@Stability(Stable)
@Nullable
default Object getMySqlParameters()

The parameters for MySQL.

getOracleParameters

@Stability(Stable)
@Nullable
default Object getOracleParameters()

Oracle parameters.

getPostgreSqlParameters

@Stability(Stable)
@Nullable
default Object getPostgreSqlParameters()

The parameters for PostgreSQL.

getPrestoParameters

@Stability(Stable)
@Nullable
default Object getPrestoParameters()

The parameters for Presto.

getRdsParameters

@Stability(Stable)
@Nullable
default Object getRdsParameters()

The parameters for Amazon RDS.

getRedshiftParameters

@Stability(Stable)
@Nullable
default Object getRedshiftParameters()

The parameters for Amazon Redshift.

getS3Parameters

@Stability(Stable)
@Nullable
default Object getS3Parameters()

The parameters for S3.

getSnowflakeParameters

@Stability(Stable)
@Nullable
default Object getSnowflakeParameters()

The parameters for Snowflake.

getSparkParameters

@Stability(Stable)
@Nullable
default Object getSparkParameters()

The parameters for Spark.

getSqlServerParameters

@Stability(Stable)
@Nullable
default Object getSqlServerParameters()

The parameters for SQL Server.

getTeradataParameters

@Stability(Stable)
@Nullable
default Object getTeradataParameters()

The parameters for Teradata.

builder

@Stability(Stable)
static CfnDataSource.DataSourceParametersProperty.Builder builder()

Returns:

a CfnDataSource.DataSourceParametersProperty.Builder of CfnDataSource.DataSourceParametersProperty