Package software.amazon.awscdk.services.quicksight

Interface CfnDataSource.CredentialPairProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDataSource.CredentialPairProperty.Jsii$Proxy

Enclosing class:

CfnDataSource

@Stability(Stable)
public static interface CfnDataSource.CredentialPairProperty
extends software.amazon.jsii.JsiiSerializable

The combination of user name and password that are used as credentials.

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.*;
 CredentialPairProperty credentialPairProperty = 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()
                         .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)
                         .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())
                         // the properties below are optional
                         .roleArn("roleArn")
                         .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();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnDataSource.CredentialPairProperty.Builder	builder()
default Object	getAlternateDataSourceParameters()	A set of alternate data source parameters that you want to share for these credentials.
String	getPassword()	Password.
String	getUsername()	User name.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getPassword

@Stability(Stable)
@NotNull
String getPassword()

Password.

getUsername

@Stability(Stable)
@NotNull
String getUsername()

User name.

getAlternateDataSourceParameters

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

A set of alternate data source parameters that you want to share for these credentials.

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 new data source with the existing credentials. If the AlternateDataSourceParameters list is null, the DataSourceParameters originally used with these Credentials is automatically allowed.

builder

@Stability(Stable)
static CfnDataSource.CredentialPairProperty.Builder builder()

Returns:

a CfnDataSource.CredentialPairProperty.Builder of CfnDataSource.CredentialPairProperty