quicksight/aws.sdk.kotlin.services.quicksight.model/DataSourceParameters

DataSourceParameters

sealed class DataSourceParameters

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.

Inheritors

Types

AmazonElasticsearchParameters

data class AmazonElasticsearchParameters(val value: AmazonElasticsearchParameters) : DataSourceParameters

The parameters for OpenSearch.

AmazonOpenSearchParameters

data class AmazonOpenSearchParameters(val value: AmazonOpenSearchParameters) : DataSourceParameters

The parameters for OpenSearch.

AthenaParameters

data class AthenaParameters(val value: AthenaParameters) : DataSourceParameters

The parameters for Amazon Athena.

AuroraParameters

data class AuroraParameters(val value: AuroraParameters) : DataSourceParameters

The parameters for Amazon Aurora MySQL.

AuroraPostgreSqlParameters

data class AuroraPostgreSqlParameters(val value: AuroraPostgreSqlParameters) : DataSourceParameters

The parameters for Amazon Aurora.

AwsIotAnalyticsParameters

data class AwsIotAnalyticsParameters(val value: AwsIotAnalyticsParameters) : DataSourceParameters

The parameters for IoT Analytics.

BigQueryParameters

data class BigQueryParameters(val value: BigQueryParameters) : DataSourceParameters

The parameters that are required to connect to a Google BigQuery data source.

DatabricksParameters

data class DatabricksParameters(val value: DatabricksParameters) : DataSourceParameters

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

ExasolParameters

data class ExasolParameters(val value: ExasolParameters) : DataSourceParameters

The parameters for Exasol.

data class JiraParameters(val value: JiraParameters) : DataSourceParameters

The parameters for Jira.

MariaDbParameters

data class MariaDbParameters(val value: MariaDbParameters) : DataSourceParameters

The parameters for MariaDB.

MySqlParameters

data class MySqlParameters(val value: MySqlParameters) : DataSourceParameters

The parameters for MySQL.

OracleParameters

data class OracleParameters(val value: OracleParameters) : DataSourceParameters

The parameters for Oracle.

PostgreSqlParameters

data class PostgreSqlParameters(val value: PostgreSqlParameters) : DataSourceParameters

The parameters for PostgreSQL.

PrestoParameters

data class PrestoParameters(val value: PrestoParameters) : DataSourceParameters

The parameters for Presto.

data class RdsParameters(val value: RdsParameters) : DataSourceParameters

The parameters for Amazon RDS.

RedshiftParameters

data class RedshiftParameters(val value: RedshiftParameters) : DataSourceParameters

The parameters for Amazon Redshift.

data class S3Parameters(val value: S3Parameters) : DataSourceParameters

The parameters for S3.

object SdkUnknown : DataSourceParameters

ServiceNowParameters

data class ServiceNowParameters(val value: ServiceNowParameters) : DataSourceParameters

The parameters for ServiceNow.

SnowflakeParameters

data class SnowflakeParameters(val value: SnowflakeParameters) : DataSourceParameters

The parameters for Snowflake.

SparkParameters

data class SparkParameters(val value: SparkParameters) : DataSourceParameters

The parameters for Spark.

SqlServerParameters

data class SqlServerParameters(val value: SqlServerParameters) : DataSourceParameters

The parameters for SQL Server.

StarburstParameters

data class StarburstParameters(val value: StarburstParameters) : DataSourceParameters

The parameters that are required to connect to a Starburst data source.

TeradataParameters

data class TeradataParameters(val value: TeradataParameters) : DataSourceParameters

The parameters for Teradata.

TrinoParameters

data class TrinoParameters(val value: TrinoParameters) : DataSourceParameters

The parameters that are required to connect to a Trino data source.

TwitterParameters

data class TwitterParameters(val value: TwitterParameters) : DataSourceParameters

The parameters for Twitter.

Functions

asAmazonElasticsearchParameters

fun asAmazonElasticsearchParameters(): AmazonElasticsearchParameters

Casts this DataSourceParameters as a AmazonElasticsearchParameters and retrieves its aws.sdk.kotlin.services.quicksight.model.AmazonElasticsearchParameters value. Throws an exception if the DataSourceParameters is not a AmazonElasticsearchParameters.

asAmazonElasticsearchParametersOrNull

fun asAmazonElasticsearchParametersOrNull(): AmazonElasticsearchParameters?

Casts this DataSourceParameters as a AmazonElasticsearchParameters and retrieves its aws.sdk.kotlin.services.quicksight.model.AmazonElasticsearchParameters value. Returns null if the DataSourceParameters is not a AmazonElasticsearchParameters.

asAmazonOpenSearchParameters

fun asAmazonOpenSearchParameters(): AmazonOpenSearchParameters

Casts this DataSourceParameters as a AmazonOpenSearchParameters and retrieves its aws.sdk.kotlin.services.quicksight.model.AmazonOpenSearchParameters value. Throws an exception if the DataSourceParameters is not a AmazonOpenSearchParameters.

asAmazonOpenSearchParametersOrNull

fun asAmazonOpenSearchParametersOrNull(): AmazonOpenSearchParameters?

Casts this DataSourceParameters as a AmazonOpenSearchParameters and retrieves its aws.sdk.kotlin.services.quicksight.model.AmazonOpenSearchParameters value. Returns null if the DataSourceParameters is not a AmazonOpenSearchParameters.

asAthenaParameters

fun asAthenaParameters(): AthenaParameters

Casts this DataSourceParameters as a AthenaParameters and retrieves its aws.sdk.kotlin.services.quicksight.model.AthenaParameters value. Throws an exception if the DataSourceParameters is not a AthenaParameters.

asAthenaParametersOrNull

fun asAthenaParametersOrNull(): AthenaParameters?

Casts this DataSourceParameters as a AthenaParameters and retrieves its aws.sdk.kotlin.services.quicksight.model.AthenaParameters value. Returns null if the DataSourceParameters is not a AthenaParameters.

asAuroraParameters

fun asAuroraParameters(): AuroraParameters

Casts this DataSourceParameters as a AuroraParameters and retrieves its aws.sdk.kotlin.services.quicksight.model.AuroraParameters value. Throws an exception if the DataSourceParameters is not a AuroraParameters.

asAuroraParametersOrNull

fun asAuroraParametersOrNull(): AuroraParameters?

Casts this DataSourceParameters as a AuroraParameters and retrieves its aws.sdk.kotlin.services.quicksight.model.AuroraParameters value. Returns null if the DataSourceParameters is not a AuroraParameters.

asAuroraPostgreSqlParameters

fun asAuroraPostgreSqlParameters(): AuroraPostgreSqlParameters

Casts this DataSourceParameters as a AuroraPostgreSqlParameters and retrieves its aws.sdk.kotlin.services.quicksight.model.AuroraPostgreSqlParameters value. Throws an exception if the DataSourceParameters is not a AuroraPostgreSqlParameters.

asAuroraPostgreSqlParametersOrNull

fun asAuroraPostgreSqlParametersOrNull(): AuroraPostgreSqlParameters?

Casts this DataSourceParameters as a AuroraPostgreSqlParameters and retrieves its aws.sdk.kotlin.services.quicksight.model.AuroraPostgreSqlParameters value. Returns null if the DataSourceParameters is not a AuroraPostgreSqlParameters.

asAwsIotAnalyticsParameters

fun asAwsIotAnalyticsParameters(): AwsIotAnalyticsParameters

Casts this DataSourceParameters as a AwsIotAnalyticsParameters and retrieves its aws.sdk.kotlin.services.quicksight.model.AwsIotAnalyticsParameters value. Throws an exception if the DataSourceParameters is not a AwsIotAnalyticsParameters.

asAwsIotAnalyticsParametersOrNull

fun asAwsIotAnalyticsParametersOrNull(): AwsIotAnalyticsParameters?

Casts this DataSourceParameters as a AwsIotAnalyticsParameters and retrieves its aws.sdk.kotlin.services.quicksight.model.AwsIotAnalyticsParameters value. Returns null if the DataSourceParameters is not a AwsIotAnalyticsParameters.

asBigQueryParameters

fun asBigQueryParameters(): BigQueryParameters

Casts this DataSourceParameters as a BigQueryParameters and retrieves its aws.sdk.kotlin.services.quicksight.model.BigQueryParameters value. Throws an exception if the DataSourceParameters is not a BigQueryParameters.

asBigQueryParametersOrNull

fun asBigQueryParametersOrNull(): BigQueryParameters?

Casts this DataSourceParameters as a BigQueryParameters and retrieves its aws.sdk.kotlin.services.quicksight.model.BigQueryParameters value. Returns null if the DataSourceParameters is not a BigQueryParameters.

asDatabricksParameters

fun asDatabricksParameters(): DatabricksParameters

Casts this DataSourceParameters as a DatabricksParameters and retrieves its aws.sdk.kotlin.services.quicksight.model.DatabricksParameters value. Throws an exception if the DataSourceParameters is not a DatabricksParameters.

asDatabricksParametersOrNull

fun asDatabricksParametersOrNull(): DatabricksParameters?

Casts this DataSourceParameters as a DatabricksParameters and retrieves its aws.sdk.kotlin.services.quicksight.model.DatabricksParameters value. Returns null if the DataSourceParameters is not a DatabricksParameters.

asExasolParameters

fun asExasolParameters(): ExasolParameters

Casts this DataSourceParameters as a ExasolParameters and retrieves its aws.sdk.kotlin.services.quicksight.model.ExasolParameters value. Throws an exception if the DataSourceParameters is not a ExasolParameters.

asExasolParametersOrNull

fun asExasolParametersOrNull(): ExasolParameters?

Casts this DataSourceParameters as a ExasolParameters and retrieves its aws.sdk.kotlin.services.quicksight.model.ExasolParameters value. Returns null if the DataSourceParameters is not a ExasolParameters.

asJiraParameters

fun asJiraParameters(): JiraParameters

Casts this DataSourceParameters as a JiraParameters and retrieves its aws.sdk.kotlin.services.quicksight.model.JiraParameters value. Throws an exception if the DataSourceParameters is not a JiraParameters.

asJiraParametersOrNull

fun asJiraParametersOrNull(): JiraParameters?

Casts this DataSourceParameters as a JiraParameters and retrieves its aws.sdk.kotlin.services.quicksight.model.JiraParameters value. Returns null if the DataSourceParameters is not a JiraParameters.

asMariaDbParameters

fun asMariaDbParameters(): MariaDbParameters

Casts this DataSourceParameters as a MariaDbParameters and retrieves its aws.sdk.kotlin.services.quicksight.model.MariaDbParameters value. Throws an exception if the DataSourceParameters is not a MariaDbParameters.

asMariaDbParametersOrNull

fun asMariaDbParametersOrNull(): MariaDbParameters?

Casts this DataSourceParameters as a MariaDbParameters and retrieves its aws.sdk.kotlin.services.quicksight.model.MariaDbParameters value. Returns null if the DataSourceParameters is not a MariaDbParameters.

asMySqlParameters

fun asMySqlParameters(): MySqlParameters

Casts this DataSourceParameters as a MySqlParameters and retrieves its aws.sdk.kotlin.services.quicksight.model.MySqlParameters value. Throws an exception if the DataSourceParameters is not a MySqlParameters.

asMySqlParametersOrNull

fun asMySqlParametersOrNull(): MySqlParameters?

Casts this DataSourceParameters as a MySqlParameters and retrieves its aws.sdk.kotlin.services.quicksight.model.MySqlParameters value. Returns null if the DataSourceParameters is not a MySqlParameters.

asOracleParameters

fun asOracleParameters(): OracleParameters

Casts this DataSourceParameters as a OracleParameters and retrieves its aws.sdk.kotlin.services.quicksight.model.OracleParameters value. Throws an exception if the DataSourceParameters is not a OracleParameters.

asOracleParametersOrNull

fun asOracleParametersOrNull(): OracleParameters?

Casts this DataSourceParameters as a OracleParameters and retrieves its aws.sdk.kotlin.services.quicksight.model.OracleParameters value. Returns null if the DataSourceParameters is not a OracleParameters.

asPostgreSqlParameters

fun asPostgreSqlParameters(): PostgreSqlParameters

Casts this DataSourceParameters as a PostgreSqlParameters and retrieves its aws.sdk.kotlin.services.quicksight.model.PostgreSqlParameters value. Throws an exception if the DataSourceParameters is not a PostgreSqlParameters.

asPostgreSqlParametersOrNull

fun asPostgreSqlParametersOrNull(): PostgreSqlParameters?

Casts this DataSourceParameters as a PostgreSqlParameters and retrieves its aws.sdk.kotlin.services.quicksight.model.PostgreSqlParameters value. Returns null if the DataSourceParameters is not a PostgreSqlParameters.

asPrestoParameters

fun asPrestoParameters(): PrestoParameters

Casts this DataSourceParameters as a PrestoParameters and retrieves its aws.sdk.kotlin.services.quicksight.model.PrestoParameters value. Throws an exception if the DataSourceParameters is not a PrestoParameters.

asPrestoParametersOrNull

fun asPrestoParametersOrNull(): PrestoParameters?

Casts this DataSourceParameters as a PrestoParameters and retrieves its aws.sdk.kotlin.services.quicksight.model.PrestoParameters value. Returns null if the DataSourceParameters is not a PrestoParameters.

asRdsParameters

fun asRdsParameters(): RdsParameters

Casts this DataSourceParameters as a RdsParameters and retrieves its aws.sdk.kotlin.services.quicksight.model.RdsParameters value. Throws an exception if the DataSourceParameters is not a RdsParameters.

asRdsParametersOrNull

fun asRdsParametersOrNull(): RdsParameters?

Casts this DataSourceParameters as a RdsParameters and retrieves its aws.sdk.kotlin.services.quicksight.model.RdsParameters value. Returns null if the DataSourceParameters is not a RdsParameters.

asRedshiftParameters

fun asRedshiftParameters(): RedshiftParameters

Casts this DataSourceParameters as a RedshiftParameters and retrieves its aws.sdk.kotlin.services.quicksight.model.RedshiftParameters value. Throws an exception if the DataSourceParameters is not a RedshiftParameters.

asRedshiftParametersOrNull

fun asRedshiftParametersOrNull(): RedshiftParameters?

Casts this DataSourceParameters as a RedshiftParameters and retrieves its aws.sdk.kotlin.services.quicksight.model.RedshiftParameters value. Returns null if the DataSourceParameters is not a RedshiftParameters.

fun asS3Parameters(): S3Parameters

Casts this DataSourceParameters as a S3Parameters and retrieves its aws.sdk.kotlin.services.quicksight.model.S3Parameters value. Throws an exception if the DataSourceParameters is not a S3Parameters.

asS3ParametersOrNull

fun asS3ParametersOrNull(): S3Parameters?

Casts this DataSourceParameters as a S3Parameters and retrieves its aws.sdk.kotlin.services.quicksight.model.S3Parameters value. Returns null if the DataSourceParameters is not a S3Parameters.

asServiceNowParameters

fun asServiceNowParameters(): ServiceNowParameters

Casts this DataSourceParameters as a ServiceNowParameters and retrieves its aws.sdk.kotlin.services.quicksight.model.ServiceNowParameters value. Throws an exception if the DataSourceParameters is not a ServiceNowParameters.

asServiceNowParametersOrNull

fun asServiceNowParametersOrNull(): ServiceNowParameters?

Casts this DataSourceParameters as a ServiceNowParameters and retrieves its aws.sdk.kotlin.services.quicksight.model.ServiceNowParameters value. Returns null if the DataSourceParameters is not a ServiceNowParameters.

asSnowflakeParameters

fun asSnowflakeParameters(): SnowflakeParameters

Casts this DataSourceParameters as a SnowflakeParameters and retrieves its aws.sdk.kotlin.services.quicksight.model.SnowflakeParameters value. Throws an exception if the DataSourceParameters is not a SnowflakeParameters.

asSnowflakeParametersOrNull

fun asSnowflakeParametersOrNull(): SnowflakeParameters?

Casts this DataSourceParameters as a SnowflakeParameters and retrieves its aws.sdk.kotlin.services.quicksight.model.SnowflakeParameters value. Returns null if the DataSourceParameters is not a SnowflakeParameters.

asSparkParameters

fun asSparkParameters(): SparkParameters

Casts this DataSourceParameters as a SparkParameters and retrieves its aws.sdk.kotlin.services.quicksight.model.SparkParameters value. Throws an exception if the DataSourceParameters is not a SparkParameters.

asSparkParametersOrNull

fun asSparkParametersOrNull(): SparkParameters?

Casts this DataSourceParameters as a SparkParameters and retrieves its aws.sdk.kotlin.services.quicksight.model.SparkParameters value. Returns null if the DataSourceParameters is not a SparkParameters.

asSqlServerParameters

fun asSqlServerParameters(): SqlServerParameters

Casts this DataSourceParameters as a SqlServerParameters and retrieves its aws.sdk.kotlin.services.quicksight.model.SqlServerParameters value. Throws an exception if the DataSourceParameters is not a SqlServerParameters.

asSqlServerParametersOrNull

fun asSqlServerParametersOrNull(): SqlServerParameters?

Casts this DataSourceParameters as a SqlServerParameters and retrieves its aws.sdk.kotlin.services.quicksight.model.SqlServerParameters value. Returns null if the DataSourceParameters is not a SqlServerParameters.

asStarburstParameters

fun asStarburstParameters(): StarburstParameters

Casts this DataSourceParameters as a StarburstParameters and retrieves its aws.sdk.kotlin.services.quicksight.model.StarburstParameters value. Throws an exception if the DataSourceParameters is not a StarburstParameters.

asStarburstParametersOrNull

fun asStarburstParametersOrNull(): StarburstParameters?

Casts this DataSourceParameters as a StarburstParameters and retrieves its aws.sdk.kotlin.services.quicksight.model.StarburstParameters value. Returns null if the DataSourceParameters is not a StarburstParameters.

asTeradataParameters

fun asTeradataParameters(): TeradataParameters

Casts this DataSourceParameters as a TeradataParameters and retrieves its aws.sdk.kotlin.services.quicksight.model.TeradataParameters value. Throws an exception if the DataSourceParameters is not a TeradataParameters.

asTeradataParametersOrNull

fun asTeradataParametersOrNull(): TeradataParameters?

Casts this DataSourceParameters as a TeradataParameters and retrieves its aws.sdk.kotlin.services.quicksight.model.TeradataParameters value. Returns null if the DataSourceParameters is not a TeradataParameters.

asTrinoParameters

fun asTrinoParameters(): TrinoParameters

Casts this DataSourceParameters as a TrinoParameters and retrieves its aws.sdk.kotlin.services.quicksight.model.TrinoParameters value. Throws an exception if the DataSourceParameters is not a TrinoParameters.

asTrinoParametersOrNull

fun asTrinoParametersOrNull(): TrinoParameters?

Casts this DataSourceParameters as a TrinoParameters and retrieves its aws.sdk.kotlin.services.quicksight.model.TrinoParameters value. Returns null if the DataSourceParameters is not a TrinoParameters.

asTwitterParameters

fun asTwitterParameters(): TwitterParameters

Casts this DataSourceParameters as a TwitterParameters and retrieves its aws.sdk.kotlin.services.quicksight.model.TwitterParameters value. Throws an exception if the DataSourceParameters is not a TwitterParameters.

asTwitterParametersOrNull

fun asTwitterParametersOrNull(): TwitterParameters?

Casts this DataSourceParameters as a TwitterParameters and retrieves its aws.sdk.kotlin.services.quicksight.model.TwitterParameters value. Returns null if the DataSourceParameters is not a TwitterParameters.