Interface CfnDataSource.DataSourceParametersProperty
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnDataSource.DataSourceParametersProperty.Jsii$Proxy
- Enclosing class:
CfnDataSource
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()
.identityCenterConfiguration(IdentityCenterConfigurationProperty.builder()
.enableIdentityPropagation(false)
.build())
.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)
// the properties below are optional
.useServiceName(false)
.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")
// the properties below are optional
.authenticationType("authenticationType")
.databaseAccessControlRole("databaseAccessControlRole")
.oAuthParameters(OAuthParametersProperty.builder()
.tokenProviderUrl("tokenProviderUrl")
// the properties below are optional
.identityProviderResourceUri("identityProviderResourceUri")
.identityProviderVpcConnectionProperties(VpcConnectionPropertiesProperty.builder()
.vpcConnectionArn("vpcConnectionArn")
.build())
.oAuthScope("oAuthScope")
.build())
.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
.authenticationType("authenticationType")
.databaseAccessControlRole("databaseAccessControlRole")
.oAuthParameters(OAuthParametersProperty.builder()
.tokenProviderUrl("tokenProviderUrl")
// the properties below are optional
.identityProviderResourceUri("identityProviderResourceUri")
.identityProviderVpcConnectionProperties(VpcConnectionPropertiesProperty.builder()
.vpcConnectionArn("vpcConnectionArn")
.build())
.oAuthScope("oAuthScope")
.build())
.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.Returns union: either
IResolvableorCfnDataSource.AmazonElasticsearchParametersProperty- See Also:
-
getAmazonOpenSearchParameters
The parameters for OpenSearch.Returns union: either
IResolvableorCfnDataSource.AmazonOpenSearchParametersProperty- See Also:
-
getAthenaParameters
The parameters for Amazon Athena.Returns union: either
IResolvableorCfnDataSource.AthenaParametersProperty- See Also:
-
getAuroraParameters
The parameters for Amazon Aurora MySQL.Returns union: either
IResolvableorCfnDataSource.AuroraParametersProperty- See Also:
-
getAuroraPostgreSqlParameters
The parameters for Amazon Aurora.Returns union: either
IResolvableorCfnDataSource.AuroraPostgreSqlParametersProperty- See Also:
-
getDatabricksParameters
The required parameters that are needed to connect to a Databricks data source.Returns union: either
IResolvableorCfnDataSource.DatabricksParametersProperty- See Also:
-
getMariaDbParameters
The parameters for MariaDB.Returns union: either
IResolvableorCfnDataSource.MariaDbParametersProperty- See Also:
-
getMySqlParameters
The parameters for MySQL.Returns union: either
IResolvableorCfnDataSource.MySqlParametersProperty- See Also:
-
getOracleParameters
Oracle parameters.Returns union: either
IResolvableorCfnDataSource.OracleParametersProperty- See Also:
-
getPostgreSqlParameters
The parameters for PostgreSQL.Returns union: either
IResolvableorCfnDataSource.PostgreSqlParametersProperty- See Also:
-
getPrestoParameters
The parameters for Presto.Returns union: either
IResolvableorCfnDataSource.PrestoParametersProperty- See Also:
-
getRdsParameters
The parameters for Amazon RDS.Returns union: either
IResolvableorCfnDataSource.RdsParametersProperty- See Also:
-
getRedshiftParameters
The parameters for Amazon Redshift.Returns union: either
IResolvableorCfnDataSource.RedshiftParametersProperty- See Also:
-
getS3Parameters
The parameters for S3.Returns union: either
IResolvableorCfnDataSource.S3ParametersProperty- See Also:
-
getSnowflakeParameters
The parameters for Snowflake.Returns union: either
IResolvableorCfnDataSource.SnowflakeParametersProperty- See Also:
-
getSparkParameters
The parameters for Spark.Returns union: either
IResolvableorCfnDataSource.SparkParametersProperty- See Also:
-
getSqlServerParameters
The parameters for SQL Server.Returns union: either
IResolvableorCfnDataSource.SqlServerParametersProperty- See Also:
-
getStarburstParameters
The parameters that are required to connect to a Starburst data source.Returns union: either
IResolvableorCfnDataSource.StarburstParametersProperty- See Also:
-
getTeradataParameters
The parameters for Teradata.Returns union: either
IResolvableorCfnDataSource.TeradataParametersProperty- See Also:
-
getTrinoParameters
The parameters that are required to connect to a Trino data source.Returns union: either
IResolvableorCfnDataSource.TrinoParametersProperty- See Also:
-
builder
-