All Superinterfaces:: software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:: CfnDataSourceProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)", date="2025-11-13T16:10:11.769Z") @Stability(Stable) public interface CfnDataSourceProps extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnDataSource.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.quicksight.*;
 CfnDataSourceProps cfnDataSourceProps = CfnDataSourceProps.builder()
         .name("name")
         .type("type")
         // the properties below are optional
         .alternateDataSourceParameters(List.of(DataSourceParametersProperty.builder()
                 .amazonElasticsearchParameters(AmazonElasticsearchParametersProperty.builder()
                         .domain("domain")
                         .build())
                 .amazonOpenSearchParameters(AmazonOpenSearchParametersProperty.builder()
                         .domain("domain")
                         .build())
                 .athenaParameters(AthenaParametersProperty.builder()
                         .identityCenterConfiguration(IdentityCenterConfigurationProperty.builder()
                                 .enableIdentityPropagation(false)
                                 .build())
                         .roleArn("roleArn")
                         .workGroup("workGroup")
                         .build())
                 .auroraParameters(AuroraParametersProperty.builder()
                         .database("database")
                         .host("host")
                         .port(123)
                         .build())
                 .auroraPostgreSqlParameters(AuroraPostgreSqlParametersProperty.builder()
                         .database("database")
                         .host("host")
                         .port(123)
                         .build())
                 .databricksParameters(DatabricksParametersProperty.builder()
                         .host("host")
                         .port(123)
                         .sqlEndpointPath("sqlEndpointPath")
                         .build())
                 .mariaDbParameters(MariaDbParametersProperty.builder()
                         .database("database")
                         .host("host")
                         .port(123)
                         .build())
                 .mySqlParameters(MySqlParametersProperty.builder()
                         .database("database")
                         .host("host")
                         .port(123)
                         .build())
                 .oracleParameters(OracleParametersProperty.builder()
                         .database("database")
                         .host("host")
                         .port(123)
                         // the properties below are optional
                         .useServiceName(false)
                         .build())
                 .postgreSqlParameters(PostgreSqlParametersProperty.builder()
                         .database("database")
                         .host("host")
                         .port(123)
                         .build())
                 .prestoParameters(PrestoParametersProperty.builder()
                         .catalog("catalog")
                         .host("host")
                         .port(123)
                         .build())
                 .rdsParameters(RdsParametersProperty.builder()
                         .database("database")
                         .instanceId("instanceId")
                         .build())
                 .redshiftParameters(RedshiftParametersProperty.builder()
                         .database("database")
                         // the properties below are optional
                         .clusterId("clusterId")
                         .host("host")
                         .iamParameters(RedshiftIAMParametersProperty.builder()
                                 .roleArn("roleArn")
                                 // the properties below are optional
                                 .autoCreateDatabaseUser(false)
                                 .databaseGroups(List.of("databaseGroups"))
                                 .databaseUser("databaseUser")
                                 .build())
                         .identityCenterConfiguration(IdentityCenterConfigurationProperty.builder()
                                 .enableIdentityPropagation(false)
                                 .build())
                         .port(123)
                         .build())
                 .s3Parameters(S3ParametersProperty.builder()
                         .manifestFileLocation(ManifestFileLocationProperty.builder()
                                 .bucket("bucket")
                                 .key("key")
                                 .build())
                         // the properties below are optional
                         .roleArn("roleArn")
                         .build())
                 .snowflakeParameters(SnowflakeParametersProperty.builder()
                         .database("database")
                         .host("host")
                         .warehouse("warehouse")
                         // the properties below are optional
                         .authenticationType("authenticationType")
                         .databaseAccessControlRole("databaseAccessControlRole")
                         .oAuthParameters(OAuthParametersProperty.builder()
                                 .tokenProviderUrl("tokenProviderUrl")
                                 // the properties below are optional
                                 .identityProviderResourceUri("identityProviderResourceUri")
                                 .identityProviderVpcConnectionProperties(VpcConnectionPropertiesProperty.builder()
                                         .vpcConnectionArn("vpcConnectionArn")
                                         .build())
                                 .oAuthScope("oAuthScope")
                                 .build())
                         .build())
                 .sparkParameters(SparkParametersProperty.builder()
                         .host("host")
                         .port(123)
                         .build())
                 .sqlServerParameters(SqlServerParametersProperty.builder()
                         .database("database")
                         .host("host")
                         .port(123)
                         .build())
                 .starburstParameters(StarburstParametersProperty.builder()
                         .catalog("catalog")
                         .host("host")
                         .port(123)
                         // the properties below are optional
                         .authenticationType("authenticationType")
                         .databaseAccessControlRole("databaseAccessControlRole")
                         .oAuthParameters(OAuthParametersProperty.builder()
                                 .tokenProviderUrl("tokenProviderUrl")
                                 // the properties below are optional
                                 .identityProviderResourceUri("identityProviderResourceUri")
                                 .identityProviderVpcConnectionProperties(VpcConnectionPropertiesProperty.builder()
                                         .vpcConnectionArn("vpcConnectionArn")
                                         .build())
                                 .oAuthScope("oAuthScope")
                                 .build())
                         .productType("productType")
                         .build())
                 .teradataParameters(TeradataParametersProperty.builder()
                         .database("database")
                         .host("host")
                         .port(123)
                         .build())
                 .trinoParameters(TrinoParametersProperty.builder()
                         .catalog("catalog")
                         .host("host")
                         .port(123)
                         .build())
                 .build()))
         .awsAccountId("awsAccountId")
         .credentials(DataSourceCredentialsProperty.builder()
                 .copySourceArn("copySourceArn")
                 .credentialPair(CredentialPairProperty.builder()
                         .password("password")
                         .username("username")
                         // the properties below are optional
                         .alternateDataSourceParameters(List.of(DataSourceParametersProperty.builder()
                                 .amazonElasticsearchParameters(AmazonElasticsearchParametersProperty.builder()
                                         .domain("domain")
                                         .build())
                                 .amazonOpenSearchParameters(AmazonOpenSearchParametersProperty.builder()
                                         .domain("domain")
                                         .build())
                                 .athenaParameters(AthenaParametersProperty.builder()
                                         .identityCenterConfiguration(IdentityCenterConfigurationProperty.builder()
                                                 .enableIdentityPropagation(false)
                                                 .build())
                                         .roleArn("roleArn")
                                         .workGroup("workGroup")
                                         .build())
                                 .auroraParameters(AuroraParametersProperty.builder()
                                         .database("database")
                                         .host("host")
                                         .port(123)
                                         .build())
                                 .auroraPostgreSqlParameters(AuroraPostgreSqlParametersProperty.builder()
                                         .database("database")
                                         .host("host")
                                         .port(123)
                                         .build())
                                 .databricksParameters(DatabricksParametersProperty.builder()
                                         .host("host")
                                         .port(123)
                                         .sqlEndpointPath("sqlEndpointPath")
                                         .build())
                                 .mariaDbParameters(MariaDbParametersProperty.builder()
                                         .database("database")
                                         .host("host")
                                         .port(123)
                                         .build())
                                 .mySqlParameters(MySqlParametersProperty.builder()
                                         .database("database")
                                         .host("host")
                                         .port(123)
                                         .build())
                                 .oracleParameters(OracleParametersProperty.builder()
                                         .database("database")
                                         .host("host")
                                         .port(123)
                                         // the properties below are optional
                                         .useServiceName(false)
                                         .build())
                                 .postgreSqlParameters(PostgreSqlParametersProperty.builder()
                                         .database("database")
                                         .host("host")
                                         .port(123)
                                         .build())
                                 .prestoParameters(PrestoParametersProperty.builder()
                                         .catalog("catalog")
                                         .host("host")
                                         .port(123)
                                         .build())
                                 .rdsParameters(RdsParametersProperty.builder()
                                         .database("database")
                                         .instanceId("instanceId")
                                         .build())
                                 .redshiftParameters(RedshiftParametersProperty.builder()
                                         .database("database")
                                         // the properties below are optional
                                         .clusterId("clusterId")
                                         .host("host")
                                         .iamParameters(RedshiftIAMParametersProperty.builder()
                                                 .roleArn("roleArn")
                                                 // the properties below are optional
                                                 .autoCreateDatabaseUser(false)
                                                 .databaseGroups(List.of("databaseGroups"))
                                                 .databaseUser("databaseUser")
                                                 .build())
                                         .identityCenterConfiguration(IdentityCenterConfigurationProperty.builder()
                                                 .enableIdentityPropagation(false)
                                                 .build())
                                         .port(123)
                                         .build())
                                 .s3Parameters(S3ParametersProperty.builder()
                                         .manifestFileLocation(ManifestFileLocationProperty.builder()
                                                 .bucket("bucket")
                                                 .key("key")
                                                 .build())
                                         // the properties below are optional
                                         .roleArn("roleArn")
                                         .build())
                                 .snowflakeParameters(SnowflakeParametersProperty.builder()
                                         .database("database")
                                         .host("host")
                                         .warehouse("warehouse")
                                         // the properties below are optional
                                         .authenticationType("authenticationType")
                                         .databaseAccessControlRole("databaseAccessControlRole")
                                         .oAuthParameters(OAuthParametersProperty.builder()
                                                 .tokenProviderUrl("tokenProviderUrl")
                                                 // the properties below are optional
                                                 .identityProviderResourceUri("identityProviderResourceUri")
                                                 .identityProviderVpcConnectionProperties(VpcConnectionPropertiesProperty.builder()
                                                         .vpcConnectionArn("vpcConnectionArn")
                                                         .build())
                                                 .oAuthScope("oAuthScope")
                                                 .build())
                                         .build())
                                 .sparkParameters(SparkParametersProperty.builder()
                                         .host("host")
                                         .port(123)
                                         .build())
                                 .sqlServerParameters(SqlServerParametersProperty.builder()
                                         .database("database")
                                         .host("host")
                                         .port(123)
                                         .build())
                                 .starburstParameters(StarburstParametersProperty.builder()
                                         .catalog("catalog")
                                         .host("host")
                                         .port(123)
                                         // the properties below are optional
                                         .authenticationType("authenticationType")
                                         .databaseAccessControlRole("databaseAccessControlRole")
                                         .oAuthParameters(OAuthParametersProperty.builder()
                                                 .tokenProviderUrl("tokenProviderUrl")
                                                 // the properties below are optional
                                                 .identityProviderResourceUri("identityProviderResourceUri")
                                                 .identityProviderVpcConnectionProperties(VpcConnectionPropertiesProperty.builder()
                                                         .vpcConnectionArn("vpcConnectionArn")
                                                         .build())
                                                 .oAuthScope("oAuthScope")
                                                 .build())
                                         .productType("productType")
                                         .build())
                                 .teradataParameters(TeradataParametersProperty.builder()
                                         .database("database")
                                         .host("host")
                                         .port(123)
                                         .build())
                                 .trinoParameters(TrinoParametersProperty.builder()
                                         .catalog("catalog")
                                         .host("host")
                                         .port(123)
                                         .build())
                                 .build()))
                         .build())
                 .secretArn("secretArn")
                 .build())
         .dataSourceId("dataSourceId")
         .dataSourceParameters(DataSourceParametersProperty.builder()
                 .amazonElasticsearchParameters(AmazonElasticsearchParametersProperty.builder()
                         .domain("domain")
                         .build())
                 .amazonOpenSearchParameters(AmazonOpenSearchParametersProperty.builder()
                         .domain("domain")
                         .build())
                 .athenaParameters(AthenaParametersProperty.builder()
                         .identityCenterConfiguration(IdentityCenterConfigurationProperty.builder()
                                 .enableIdentityPropagation(false)
                                 .build())
                         .roleArn("roleArn")
                         .workGroup("workGroup")
                         .build())
                 .auroraParameters(AuroraParametersProperty.builder()
                         .database("database")
                         .host("host")
                         .port(123)
                         .build())
                 .auroraPostgreSqlParameters(AuroraPostgreSqlParametersProperty.builder()
                         .database("database")
                         .host("host")
                         .port(123)
                         .build())
                 .databricksParameters(DatabricksParametersProperty.builder()
                         .host("host")
                         .port(123)
                         .sqlEndpointPath("sqlEndpointPath")
                         .build())
                 .mariaDbParameters(MariaDbParametersProperty.builder()
                         .database("database")
                         .host("host")
                         .port(123)
                         .build())
                 .mySqlParameters(MySqlParametersProperty.builder()
                         .database("database")
                         .host("host")
                         .port(123)
                         .build())
                 .oracleParameters(OracleParametersProperty.builder()
                         .database("database")
                         .host("host")
                         .port(123)
                         // the properties below are optional
                         .useServiceName(false)
                         .build())
                 .postgreSqlParameters(PostgreSqlParametersProperty.builder()
                         .database("database")
                         .host("host")
                         .port(123)
                         .build())
                 .prestoParameters(PrestoParametersProperty.builder()
                         .catalog("catalog")
                         .host("host")
                         .port(123)
                         .build())
                 .rdsParameters(RdsParametersProperty.builder()
                         .database("database")
                         .instanceId("instanceId")
                         .build())
                 .redshiftParameters(RedshiftParametersProperty.builder()
                         .database("database")
                         // the properties below are optional
                         .clusterId("clusterId")
                         .host("host")
                         .iamParameters(RedshiftIAMParametersProperty.builder()
                                 .roleArn("roleArn")
                                 // the properties below are optional
                                 .autoCreateDatabaseUser(false)
                                 .databaseGroups(List.of("databaseGroups"))
                                 .databaseUser("databaseUser")
                                 .build())
                         .identityCenterConfiguration(IdentityCenterConfigurationProperty.builder()
                                 .enableIdentityPropagation(false)
                                 .build())
                         .port(123)
                         .build())
                 .s3Parameters(S3ParametersProperty.builder()
                         .manifestFileLocation(ManifestFileLocationProperty.builder()
                                 .bucket("bucket")
                                 .key("key")
                                 .build())
                         // the properties below are optional
                         .roleArn("roleArn")
                         .build())
                 .snowflakeParameters(SnowflakeParametersProperty.builder()
                         .database("database")
                         .host("host")
                         .warehouse("warehouse")
                         // the properties below are optional
                         .authenticationType("authenticationType")
                         .databaseAccessControlRole("databaseAccessControlRole")
                         .oAuthParameters(OAuthParametersProperty.builder()
                                 .tokenProviderUrl("tokenProviderUrl")
                                 // the properties below are optional
                                 .identityProviderResourceUri("identityProviderResourceUri")
                                 .identityProviderVpcConnectionProperties(VpcConnectionPropertiesProperty.builder()
                                         .vpcConnectionArn("vpcConnectionArn")
                                         .build())
                                 .oAuthScope("oAuthScope")
                                 .build())
                         .build())
                 .sparkParameters(SparkParametersProperty.builder()
                         .host("host")
                         .port(123)
                         .build())
                 .sqlServerParameters(SqlServerParametersProperty.builder()
                         .database("database")
                         .host("host")
                         .port(123)
                         .build())
                 .starburstParameters(StarburstParametersProperty.builder()
                         .catalog("catalog")
                         .host("host")
                         .port(123)
                         // the properties below are optional
                         .authenticationType("authenticationType")
                         .databaseAccessControlRole("databaseAccessControlRole")
                         .oAuthParameters(OAuthParametersProperty.builder()
                                 .tokenProviderUrl("tokenProviderUrl")
                                 // the properties below are optional
                                 .identityProviderResourceUri("identityProviderResourceUri")
                                 .identityProviderVpcConnectionProperties(VpcConnectionPropertiesProperty.builder()
                                         .vpcConnectionArn("vpcConnectionArn")
                                         .build())
                                 .oAuthScope("oAuthScope")
                                 .build())
                         .productType("productType")
                         .build())
                 .teradataParameters(TeradataParametersProperty.builder()
                         .database("database")
                         .host("host")
                         .port(123)
                         .build())
                 .trinoParameters(TrinoParametersProperty.builder()
                         .catalog("catalog")
                         .host("host")
                         .port(123)
                         .build())
                 .build())
         .errorInfo(DataSourceErrorInfoProperty.builder()
                 .message("message")
                 .type("type")
                 .build())
         .folderArns(List.of("folderArns"))
         .permissions(List.of(ResourcePermissionProperty.builder()
                 .actions(List.of("actions"))
                 .principal("principal")
                 // the properties below are optional
                 .resource("resource")
                 .build()))
         .sslProperties(SslPropertiesProperty.builder()
                 .disableSsl(false)
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .vpcConnectionProperties(VpcConnectionPropertiesProperty.builder()
                 .vpcConnectionArn("vpcConnectionArn")
                 .build())
         .build();

See Also:

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

Interface CfnDataSourceProps

Nested Class Summary

Method Summary

Methods inherited from interface software.amazon.jsii.JsiiSerializable

Method Details

getName

getType

getAlternateDataSourceParameters

getAwsAccountId

getCredentials

getDataSourceId

getDataSourceParameters

getErrorInfo

getFolderArns

getPermissions

getSslProperties

getTags

getVpcConnectionProperties

builder