Package software.amazon.awscdk.services.quicksight

Interface CfnDataSourceProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDataSourceProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.129.0 (build eaca441)",
           date="2026-05-13T16:55:15.419Z")
@Stability(Stable)
public interface CfnDataSourceProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnDataSource.

Example:

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-datasource.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnDataSourceProps.Builder	A builder for CfnDataSourceProps
static final class	CfnDataSourceProps.Jsii$Proxy	An implementation for CfnDataSourceProps

Method Summary

Modifier and Type	Method	Description
static CfnDataSourceProps.Builder	builder()
default Object	getAlternateDataSourceParameters()	A set of alternate data source parameters that you want to share for the credentials stored with this data source.
default String	getAwsAccountId()	The AWS account ID.
default Object	getCredentials()	The credentials Amazon Quick Sight that uses to connect to your underlying source.
default String	getDataSourceId()	An ID for the data source.
default Object	getDataSourceParameters()	The parameters that Amazon Quick Sight uses to connect to your underlying source.
default Object	getErrorInfo()	Error information from the last update or the creation of the data source.
default List<String>	getFolderArns()
String	getName()	A display name for the data source.
default Object	getPermissions()	A list of resource permissions on the data source.
default Object	getSslProperties()	Secure Socket Layer (SSL) properties that apply when Amazon Quick Sight connects to your underlying source.
default List<CfnTag>	getTags()	Contains a map of the key-value pairs for the resource tag or tags assigned to the data source.
String	getType()	The type of the data source.
default Object	getVpcConnectionProperties()	Use this parameter only when you want Amazon Quick Sight to use a VPC connection when connecting to your underlying source.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getName

@Stability(Stable)
@NotNull
String getName()

A display name for the data source.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-datasource.html#cfn-quicksight-datasource-name

getType

@Stability(Stable)
@NotNull
String getType()

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

Use AMAZON_ELASTICSEARCH for Amazon OpenSearch Service.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-datasource.html#cfn-quicksight-datasource-type

getAlternateDataSourceParameters

@Stability(Stable)
@Nullable
default Object getAlternateDataSourceParameters()

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.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnDataSource.DataSourceParametersProperty>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-datasource.html#cfn-quicksight-datasource-alternatedatasourceparameters

getAwsAccountId

@Stability(Stable)
@Nullable
default String getAwsAccountId()

The AWS account ID.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-datasource.html#cfn-quicksight-datasource-awsaccountid

getCredentials

@Stability(Stable)
@Nullable
default Object getCredentials()

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

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

Returns union: either IResolvable or CfnDataSource.DataSourceCredentialsProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-datasource.html#cfn-quicksight-datasource-credentials

getDataSourceId

@Stability(Stable)
@Nullable
default String getDataSourceId()

An ID for the data source.

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-datasource.html#cfn-quicksight-datasource-datasourceid

getDataSourceParameters

@Stability(Stable)
@Nullable
default Object getDataSourceParameters()

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

Returns union: either IResolvable or CfnDataSource.DataSourceParametersProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-datasource.html#cfn-quicksight-datasource-datasourceparameters

getErrorInfo

@Stability(Stable)
@Nullable
default Object getErrorInfo()

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

Returns union: either IResolvable or CfnDataSource.DataSourceErrorInfoProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-datasource.html#cfn-quicksight-datasource-errorinfo

getFolderArns

@Stability(Stable)
@Nullable
default List<String> getFolderArns()

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-datasource.html#cfn-quicksight-datasource-folderarns

getPermissions

@Stability(Stable)
@Nullable
default Object getPermissions()

A list of resource permissions on the data source.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnDataSource.ResourcePermissionProperty>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-datasource.html#cfn-quicksight-datasource-permissions

getSslProperties

@Stability(Stable)
@Nullable
default Object getSslProperties()

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

Returns union: either IResolvable or CfnDataSource.SslPropertiesProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-datasource.html#cfn-quicksight-datasource-sslproperties

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-datasource.html#cfn-quicksight-datasource-tags

getVpcConnectionProperties

@Stability(Stable)
@Nullable
default Object getVpcConnectionProperties()

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

Returns union: either IResolvable or CfnDataSource.VpcConnectionPropertiesProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-datasource.html#cfn-quicksight-datasource-vpcconnectionproperties

builder

@Stability(Stable)
static CfnDataSourceProps.Builder builder()

Returns:

a CfnDataSourceProps.Builder of CfnDataSourceProps