AWS::QuickSight::DataSource - Amazon CloudFormation
SyntaxPropertiesReturn values
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

AWS::QuickSight::DataSource

Creates a data source.

Syntax

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

JSON

{
  "Type" : "AWS::QuickSight::DataSource",
  "Properties" : {
      "AlternateDataSourceParameters" : [ DataSourceParameters, ... ],
      "AwsAccountId" : String,
      "Credentials" : DataSourceCredentials,
      "DataSourceId" : String,
      "DataSourceParameters" : DataSourceParameters,
      "ErrorInfo" : DataSourceErrorInfo,
      "Name" : String,
      "Permissions" : [ ResourcePermission, ... ],
      "SslProperties" : SslProperties,
      "Tags" : [ Tag, ... ],
      "Type" : String,
      "VpcConnectionProperties" : VpcConnectionProperties
    }
}

Properties

AlternateDataSourceParameters

A set of alternate data source parameters that you want to share for the credentials stored with this data source. The credentials are applied in tandem with the data source parameters when you copy a data source by using a create or update request. The API operation compares the DataSourceParameters structure that's in the request with the structures in the AlternateDataSourceParameters allow list. If the structures are an exact match, the request is allowed to use the credentials from this existing data source. If the AlternateDataSourceParameters list is null, the Credentials originally used with this DataSourceParameters are automatically allowed.

Required: No

Type: Array of DataSourceParameters

Minimum: 1

Maximum: 50

Update requires: No interruption

AwsAccountId

The Amazon account ID.

Required: No

Type: String

Pattern: ^[0-9]{12}$

Minimum: 12

Maximum: 12

Update requires: Replacement

Credentials

The credentials Amazon QuickSight that uses to connect to your underlying source. Currently, only credentials based on user name and password are supported.

Required: No

Type: DataSourceCredentials

Update requires: No interruption

DataSourceId

An ID for the data source. This ID is unique per Amazon Web Services Region for each Amazon account.

Required: No

Type: String

Update requires: Replacement

DataSourceParameters

The parameters that Amazon QuickSight uses to connect to your underlying source.

Required: No

Type: DataSourceParameters

Update requires: No interruption

ErrorInfo

Error information from the last update or the creation of the data source.

Required: No

Type: DataSourceErrorInfo

Update requires: No interruption

Name

A display name for the data source.

Required: No

Type: String

Minimum: 1

Maximum: 128

Update requires: No interruption

Permissions

A list of resource permissions on the data source.

Required: No

Type: Array of ResourcePermission

Minimum: 1

Maximum: 64

Update requires: No interruption

SslProperties

Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying source.

Required: No

Type: SslProperties

Update requires: No interruption

Tags

Contains a map of the key-value pairs for the resource tag or tags assigned to the data source.

Required: No

Type: Array of Tag

Minimum: 1

Maximum: 200

Update requires: No interruption

Type

The type of the data source. To return a list of all data sources, use ListDataSources.

Use AMAZON_ELASTICSEARCH for Amazon OpenSearch Service.

Required: No

Type: String

Allowed values: ADOBE_ANALYTICS | AMAZON_ELASTICSEARCH | AMAZON_OPENSEARCH | ATHENA | AURORA | AURORA_POSTGRESQL | AWS_IOT_ANALYTICS | DATABRICKS | GITHUB | JIRA | MARIADB | MYSQL | ORACLE | POSTGRESQL | PRESTO | REDSHIFT | S3 | SALESFORCE | SERVICENOW | SNOWFLAKE | SPARK | SQLSERVER | TERADATA | TWITTER | TIMESTREAM | STARBURST | TRINO

Update requires: Replacement

VpcConnectionProperties

Use this parameter only when you want Amazon QuickSight to use a VPC connection when connecting to your underlying source.

Required: No

Type: VpcConnectionProperties

Update requires: No interruption

Return values

Fn::GetAtt

Arn

The Amazon Resource Name (ARN) of the dataset.

CreatedTime

The time that this data source was created.

LastUpdatedTime

The last time that this data source was updated.

Status

The HTTP status of the request.