AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::QuickSight::DataSource

CfnDataSource

Creates a data source.

Import

import { CfnDataSource } from 'aws-cdk-lib/aws-quicksight';

Or use the module namespace:

import * as quicksight from 'aws-cdk-lib/aws-quicksight';
// quicksight.CfnDataSource

Properties

Configuration passed to the constructor as CfnDataSourceProps.

nameRequired
string

A display name for the data source.

typeRequired
string

The type of the data source. To return a list of all data sources, use `ListDataSources` . Use `AMAZON_ELASTICSEARCH` for Amazon OpenSearch Service.

alternateDataSourceParametersOptional
IResolvable | IResolvable | DataSourceParametersProperty[]

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.

awsAccountIdOptional
string

The AWS account ID.

credentialsOptional
IResolvable | DataSourceCredentialsProperty

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

dataSourceIdOptional
string

An ID for the data source. This ID is unique per AWS Region for each AWS account.

dataSourceParametersOptional
IResolvable | DataSourceParametersProperty

The parameters that Amazon Quick Sight uses to connect to your underlying source.

errorInfoOptional
IResolvable | DataSourceErrorInfoProperty

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

folderArnsOptional
string[]
permissionsOptional
IResolvable | IResolvable | ResourcePermissionProperty[]

A list of resource permissions on the data source.

sslPropertiesOptional
IResolvable | SslPropertiesProperty

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

tagsOptional
CfnTag[]

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

vpcConnectionPropertiesOptional
IResolvable | VpcConnectionPropertiesProperty

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

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

AWS::QuickSight::DataSourceView in CloudFormation Explorer

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

LevelL1 (CloudFormation)
Moduleaws-quicksight
CFN TypeAWS::QuickSight::DataSource
Properties13

Related Constructs

Explore This Service

External Links