AWS::QuickSight::DataSource DataSourceParameters

The parameters that Quick Sight 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.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "AmazonElasticsearchParameters" : AmazonElasticsearchParameters,
  "AmazonOpenSearchParameters" : AmazonOpenSearchParameters,
  "AthenaParameters" : AthenaParameters,
  "AuroraParameters" : AuroraParameters,
  "AuroraPostgreSqlParameters" : AuroraPostgreSqlParameters,
  "DatabricksParameters" : DatabricksParameters,
  "MariaDbParameters" : MariaDbParameters,
  "MySqlParameters" : MySqlParameters,
  "OracleParameters" : OracleParameters,
  "PostgreSqlParameters" : PostgreSqlParameters,
  "PrestoParameters" : PrestoParameters,
  "RdsParameters" : RdsParameters,
  "RedshiftParameters" : RedshiftParameters,
  "S3Parameters" : S3Parameters,
  "SnowflakeParameters" : SnowflakeParameters,
  "SparkParameters" : SparkParameters,
  "SqlServerParameters" : SqlServerParameters,
  "StarburstParameters" : StarburstParameters,
  "TeradataParameters" : TeradataParameters,
  "TrinoParameters" : TrinoParameters
}

YAML

  AmazonElasticsearchParameters: 
    AmazonElasticsearchParameters
  AmazonOpenSearchParameters: 
    AmazonOpenSearchParameters
  AthenaParameters: 
    AthenaParameters
  AuroraParameters: 
    AuroraParameters
  AuroraPostgreSqlParameters: 
    AuroraPostgreSqlParameters
  DatabricksParameters: 
    DatabricksParameters
  MariaDbParameters: 
    MariaDbParameters
  MySqlParameters: 
    MySqlParameters
  OracleParameters: 
    OracleParameters
  PostgreSqlParameters: 
    PostgreSqlParameters
  PrestoParameters: 
    PrestoParameters
  RdsParameters: 
    RdsParameters
  RedshiftParameters: 
    RedshiftParameters
  S3Parameters: 
    S3Parameters
  SnowflakeParameters: 
    SnowflakeParameters
  SparkParameters: 
    SparkParameters
  SqlServerParameters: 
    SqlServerParameters
  StarburstParameters: 
    StarburstParameters
  TeradataParameters: 
    TeradataParameters
  TrinoParameters: 
    TrinoParameters

Properties

AmazonElasticsearchParameters

The parameters for OpenSearch.

Required: No

Type: AmazonElasticsearchParameters

Update requires: No interruption

AmazonOpenSearchParameters

The parameters for OpenSearch.

Required: No

Type: AmazonOpenSearchParameters

Update requires: No interruption

AthenaParameters

The parameters for Amazon Athena.

Required: No

Type: AthenaParameters

Update requires: No interruption

AuroraParameters

The parameters for Amazon Aurora MySQL.

Required: No

Type: AuroraParameters

Update requires: No interruption

AuroraPostgreSqlParameters

The parameters for Amazon Aurora.

Required: No

Type: AuroraPostgreSqlParameters

Update requires: No interruption

DatabricksParameters

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

Required: No

Type: DatabricksParameters

Update requires: No interruption

MariaDbParameters

The parameters for MariaDB.

Required: No

Type: MariaDbParameters

Update requires: No interruption

MySqlParameters

The parameters for MySQL.

Required: No

Type: MySqlParameters

Update requires: No interruption

OracleParameters

Oracle parameters.

Required: No

Type: OracleParameters

Update requires: No interruption

PostgreSqlParameters

The parameters for PostgreSQL.

Required: No

Type: PostgreSqlParameters

Update requires: No interruption

PrestoParameters

The parameters for Presto.

Required: No

Type: PrestoParameters

Update requires: No interruption

RdsParameters

The parameters for Amazon RDS.

Required: No

Type: RdsParameters

Update requires: No interruption

RedshiftParameters

The parameters for Amazon Redshift.

Required: No

Type: RedshiftParameters

Update requires: No interruption

S3Parameters

The parameters for S3.

Required: No

Type: S3Parameters

Update requires: No interruption

SnowflakeParameters

The parameters for Snowflake.

Required: No

Type: SnowflakeParameters

Update requires: No interruption

SparkParameters

The parameters for Spark.

Required: No

Type: SparkParameters

Update requires: No interruption

SqlServerParameters

The parameters for SQL Server.

Required: No

Type: SqlServerParameters

Update requires: No interruption

StarburstParameters

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

Required: No

Type: StarburstParameters

Update requires: No interruption

TeradataParameters

The parameters for Teradata.

Required: No

Type: TeradataParameters

Update requires: No interruption

TrinoParameters

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

Required: No

Type: TrinoParameters

Update requires: No interruption