software.amazon.awscdk.services.quicksight

Interface CfnDataSource.DataSourceCredentialsProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDataSource.DataSourceCredentialsProperty.Jsii$Proxy

Enclosing class:

CfnDataSource

@Stability(value=Stable)
public static interface CfnDataSource.DataSourceCredentialsProperty
extends software.amazon.jsii.JsiiSerializable

Data source credentials.

This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.

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.*;
 DataSourceCredentialsProperty dataSourceCredentialsProperty = 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()
                                 .workGroup("workGroup")
                                 .build())
                         .auroraParameters(AuroraParametersProperty.builder()
                                 .database("database")
                                 .host("host")
                                 .port(123)
                                 .build())
                         .auroraPostgreSqlParameters(AuroraPostgreSqlParametersProperty.builder()
                                 .database("database")
                                 .host("host")
                                 .port(123)
                                 .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)
                                 .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")
                                 .port(123)
                                 .build())
                         .s3Parameters(S3ParametersProperty.builder()
                                 .manifestFileLocation(ManifestFileLocationProperty.builder()
                                         .bucket("bucket")
                                         .key("key")
                                         .build())
                                 .build())
                         .snowflakeParameters(SnowflakeParametersProperty.builder()
                                 .database("database")
                                 .host("host")
                                 .warehouse("warehouse")
                                 .build())
                         .sparkParameters(SparkParametersProperty.builder()
                                 .host("host")
                                 .port(123)
                                 .build())
                         .sqlServerParameters(SqlServerParametersProperty.builder()
                                 .database("database")
                                 .host("host")
                                 .port(123)
                                 .build())
                         .teradataParameters(TeradataParametersProperty.builder()
                                 .database("database")
                                 .host("host")
                                 .port(123)
                                 .build())
                         .build()))
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnDataSource.DataSourceCredentialsProperty.Builder	builder()
default String	getCopySourceArn() The Amazon Resource Name (ARN) of a data source that has the credential pair that you want to use.
default Object	getCredentialPair() Credential pair.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getCopySourceArn

@Stability(value=Stable)
 @Nullable
default String getCopySourceArn()

The Amazon Resource Name (ARN) of a data source that has the credential pair that you want to use.

When CopySourceArn is not null, the credential pair from the data source in the ARN is used as the credentials for the DataSourceCredentials structure.

getCredentialPair

@Stability(value=Stable)
 @Nullable
default Object getCredentialPair()

Credential pair.

For more information, see [CredentialPair](https://docs.aws.amazon.com/quicksight/latest/APIReference/API_CredentialPair.html) .

builder

@Stability(value=Stable)
static CfnDataSource.DataSourceCredentialsProperty.Builder builder()

Returns:

a CfnDataSource.DataSourceCredentialsProperty.Builder of CfnDataSource.DataSourceCredentialsProperty