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")
.iamParameters(RedshiftIAMParametersProperty.builder()
.roleArn("roleArn")
// the properties below are optional
.autoCreateDatabaseUser(false)
.databaseGroups(List.of("databaseGroups"))
.databaseUser("databaseUser")
.build())
.identityCenterConfiguration(IdentityCenterConfigurationProperty.builder()
.enableIdentityPropagation(false)
.build())
.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())
.starburstParameters(StarburstParametersProperty.builder()
.catalog("catalog")
.host("host")
.port(123)
// the properties below are optional
.productType("productType")
.build())
.teradataParameters(TeradataParametersProperty.builder()
.database("database")
.host("host")
.port(123)
.build())
.trinoParameters(TrinoParametersProperty.builder()
.catalog("catalog")
.host("host")
.port(123)
.build())
.build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final classA builder forCfnDataSource.DataSourceParametersPropertystatic final classAn implementation forCfnDataSource.DataSourceParametersProperty -
Method Summary
Modifier and TypeMethodDescriptionbuilder()default ObjectThe parameters for OpenSearch.default ObjectThe parameters for OpenSearch.default ObjectThe parameters for Amazon Athena.default ObjectThe parameters for Amazon Aurora MySQL.default ObjectThe parameters for Amazon Aurora.default ObjectThe required parameters that are needed to connect to a Databricks data source.default ObjectThe parameters for MariaDB.default ObjectThe parameters for MySQL.default ObjectOracle parameters.default ObjectThe parameters for PostgreSQL.default ObjectThe parameters for Presto.default ObjectThe parameters for Amazon RDS.default ObjectThe parameters for Amazon Redshift.default ObjectThe parameters for S3.default ObjectThe parameters for Snowflake.default ObjectThe parameters for Spark.default ObjectThe parameters for SQL Server.default ObjectThe parameters that are required to connect to a Starburst data source.default ObjectThe parameters for Teradata.default ObjectThe parameters that are required to connect to a Trino data source.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getAmazonElasticsearchParameters
The parameters for OpenSearch.- See Also:
-
getAmazonOpenSearchParameters
The parameters for OpenSearch.- See Also:
-
getAthenaParameters
The parameters for Amazon Athena.- See Also:
-
getAuroraParameters
The parameters for Amazon Aurora MySQL.- See Also:
-
getAuroraPostgreSqlParameters
The parameters for Amazon Aurora.- See Also:
-
getDatabricksParameters
The required parameters that are needed to connect to a Databricks data source.- See Also:
-
getMariaDbParameters
The parameters for MariaDB.- See Also:
-
getMySqlParameters
The parameters for MySQL.- See Also:
-
getOracleParameters
Oracle parameters.- See Also:
-
getPostgreSqlParameters
The parameters for PostgreSQL.- See Also:
-
getPrestoParameters
The parameters for Presto.- See Also:
-
getRdsParameters
The parameters for Amazon RDS.- See Also:
-
getRedshiftParameters
The parameters for Amazon Redshift.- See Also:
-
getS3Parameters
The parameters for S3.- See Also:
-
getSnowflakeParameters
The parameters for Snowflake.- See Also:
-
getSparkParameters
The parameters for Spark.- See Also:
-
getSqlServerParameters
The parameters for SQL Server.- See Also:
-
getStarburstParameters
The parameters that are required to connect to a Starburst data source.- See Also:
-
getTeradataParameters
The parameters for Teradata.- See Also:
-
getTrinoParameters
The parameters that are required to connect to a Trino data source.- See Also:
-
builder
-