Creates a data source.
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{
"Type" : "AWS::QuickSight::DataSource",
"Properties" : {
"AlternateDataSourceParameters" : [ DataSourceParameters, ... ],
"AwsAccountId" : String,
"Credentials" : DataSourceCredentials,
"DataSourceId" : String,
"DataSourceParameters" : DataSourceParameters,
"ErrorInfo" : DataSourceErrorInfo,
"FolderArns" : [ String, ... ],
"Name" : String,
"Permissions" : [ ResourcePermission, ... ],
"SslProperties" : SslProperties,
"Tags" : [ Tag, ... ],
"Type" : String,
"VpcConnectionProperties" : VpcConnectionProperties
}
}
YAML
Type: AWS::QuickSight::DataSource
Properties:
AlternateDataSourceParameters:
- DataSourceParameters
AwsAccountId: String
Credentials:
DataSourceCredentials
DataSourceId: String
DataSourceParameters:
DataSourceParameters
ErrorInfo:
DataSourceErrorInfo
FolderArns:
- String
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
DataSourceParametersstructure that's in the request with the structures in theAlternateDataSourceParametersallow list. If the structures are an exact match, the request is allowed to use the credentials from this existing data source. If theAlternateDataSourceParameterslist is null, theCredentialsoriginally used with thisDataSourceParametersare automatically allowed.Required: No
Type: Array of DataSourceParameters
Minimum:
1Maximum:
50Update requires: No interruption
AwsAccountId-
The AWS account ID.
Required: No
Type: String
Pattern:
^[0-9]{12}$Minimum:
12Maximum:
12Update 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 AWS Region for each AWS 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
FolderArnsProperty description not available.
Required: No
Type: Array of String
Minimum:
0Maximum:
10Update requires: No interruption
Name-
A display name for the data source.
Required: Yes
Type: String
Minimum:
1Maximum:
128Update requires: No interruption
Permissions-
A list of resource permissions on the data source.
Required: No
Type: Array of ResourcePermission
Minimum:
1Maximum:
64Update 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
-
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:
1Maximum:
200Update requires: No interruption
Type-
The type of the data source. To return a list of all data sources, use
ListDataSources.Use
AMAZON_ELASTICSEARCHfor Amazon OpenSearch Service.Required: Yes
Type: String
Allowed values:
ADOBE_ANALYTICS | AMAZON_ELASTICSEARCH | AMAZON_OPENSEARCH | ATHENA | AURORA | AURORA_POSTGRESQL | AWS_IOT_ANALYTICS | DATABRICKS | DENODO | DREMIO | DYNAMODB | SAPHANA | DB2_AS400 | EXASOL | FILE | GITHUB | JIRA | MARIADB | MYSQL | ORACLE | POSTGRESQL | PRESTO | REDSHIFT | S3 | S3_TABLES | SALESFORCE | SERVICENOW | SNOWFLAKE | SPARK | SQLSERVER | TERADATA | TIMESTREAM | TWITTER | BIGQUERY | GOOGLE_ANALYTICS | TRINO | STARBURST | MONGO | MONGO_ATLAS | DOCUMENTDB | APPFLOW | IMPALA | GLUEUpdate 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.
