aws-cdk-lib.aws_quicksight.CfnDataSourceProps

CfnDataSourceProps Struct

Properties for defining a CfnDataSource.

CfnDataSourceProps

used as props by

• CfnDataSource

Source

Generated code

Type last changed

v2.163.0 · 22 Oct 2024

Example

// The generated example for this type would exceed 500 lines,
// and has been elided for readability.

Properties

alternateDataSourceParametersIResolvable | IResolvable | CfnDataSource.DataSourceParametersProperty[]alternate_data_source_parameterstyping.Union[IResolvable, typing.List[typing.Union[IResolvable, DataSourceParametersProperty]]]alternateDataSourceParametersIResolvableAlternateDataSourceParametersIResolvableAlternateDataSourceParametersinterface{}#

A set of alternate data source parameters that you want to share for the credentials stored with this data source.

notes

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.

awsAccountIdstringaws_account_idstrawsAccountIdStringAwsAccountIdstringAwsAccountId*string#

The AWS account ID.

credentialsIResolvable | CfnDataSource.DataSourceCredentialsPropertycredentialstyping.Union[IResolvable, DataSourceCredentialsProperty]credentialsIResolvableCredentialsIResolvableCredentialsinterface{}#

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

Currently, only credentials based on user name and password are supported.

dataSourceIdstringdata_source_idstrdataSourceIdStringDataSourceIdstringDataSourceId*string#

An ID for the data source.

This ID is unique per AWS Region for each AWS account.

dataSourceParametersIResolvable | CfnDataSource.DataSourceParametersPropertydata_source_parameterstyping.Union[IResolvable, DataSourceParametersProperty]dataSourceParametersIResolvableDataSourceParametersIResolvableDataSourceParametersinterface{}#

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

errorInfoIResolvable | CfnDataSource.DataSourceErrorInfoPropertyerror_infotyping.Union[IResolvable, DataSourceErrorInfoProperty]errorInfoIResolvableErrorInfoIResolvableErrorInfointerface{}#

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

folderArnsstring[]folder_arnstyping.List[str]folderArnsList<String>FolderArnsstring[]FolderArns*[]*string#

namestringnamestrnameStringNamestringName*stringrequired#

A display name for the data source.

permissionsIResolvable | IResolvable | CfnDataSource.ResourcePermissionProperty[]permissionstyping.Union[IResolvable, typing.List[typing.Union[IResolvable, ResourcePermissionProperty]]]permissionsIResolvablePermissionsIResolvablePermissionsinterface{}#

A list of resource permissions on the data source.

sslPropertiesIResolvable | CfnDataSource.SslPropertiesPropertyssl_propertiestyping.Union[IResolvable, SslPropertiesProperty]sslPropertiesIResolvableSslPropertiesIResolvableSslPropertiesinterface{}#

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

tagsCfnTag[]tagstyping.List[CfnTag]tagsList<CfnTag>TagsCfnTag[]Tags*[]CfnTag#

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

typestringtypestrtypeStringTypestringType*stringrequired#

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

Use AMAZON_ELASTICSEARCH for Amazon OpenSearch Service.

vpcConnectionPropertiesIResolvable | CfnDataSource.VpcConnectionPropertiesPropertyvpc_connection_propertiestyping.Union[IResolvable, VpcConnectionPropertiesProperty]vpcConnectionPropertiesIResolvableVpcConnectionPropertiesIResolvableVpcConnectionPropertiesinterface{}#

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