Package 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(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()
                                 .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")
                                 .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();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	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.
default String	getSecretArn()	The Amazon Resource Name (ARN) of the secret associated with the data source in AWS Secrets Manager .

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getCopySourceArn

@Stability(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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-datasourcecredentials.html#cfn-quicksight-datasource-datasourcecredentials-copysourcearn

getCredentialPair

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

Credential pair.

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-datasourcecredentials.html#cfn-quicksight-datasource-datasourcecredentials-credentialpair

getSecretArn

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

The Amazon Resource Name (ARN) of the secret associated with the data source in AWS Secrets Manager .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-datasourcecredentials.html#cfn-quicksight-datasource-datasourcecredentials-secretarn

builder

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

Returns:

a CfnDataSource.DataSourceCredentialsProperty.Builder of CfnDataSource.DataSourceCredentialsProperty