interface DataSourceCredentialsProperty

Language	Type name
.NET	Amazon.CDK.AWS.QuickSight.CfnDataSource.DataSourceCredentialsProperty
Java	software.amazon.awscdk.services.quicksight.CfnDataSource.DataSourceCredentialsProperty
Python	aws_cdk.aws_quicksight.CfnDataSource.DataSourceCredentialsProperty
TypeScript	@aws-cdk/aws-quicksight » CfnDataSource » DataSourceCredentialsProperty

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 * as quicksight from '@aws-cdk/aws-quicksight';
const dataSourceCredentialsProperty: quicksight.CfnDataSource.DataSourceCredentialsProperty = {
  copySourceArn: 'copySourceArn',
  credentialPair: {
    password: 'password',
    username: 'username',

    // the properties below are optional
    alternateDataSourceParameters: [{
      amazonElasticsearchParameters: {
        domain: 'domain',
      },
      amazonOpenSearchParameters: {
        domain: 'domain',
      },
      athenaParameters: {
        roleArn: 'roleArn',
        workGroup: 'workGroup',
      },
      auroraParameters: {
        database: 'database',
        host: 'host',
        port: 123,
      },
      auroraPostgreSqlParameters: {
        database: 'database',
        host: 'host',
        port: 123,
      },
      databricksParameters: {
        host: 'host',
        port: 123,
        sqlEndpointPath: 'sqlEndpointPath',
      },
      mariaDbParameters: {
        database: 'database',
        host: 'host',
        port: 123,
      },
      mySqlParameters: {
        database: 'database',
        host: 'host',
        port: 123,
      },
      oracleParameters: {
        database: 'database',
        host: 'host',
        port: 123,
      },
      postgreSqlParameters: {
        database: 'database',
        host: 'host',
        port: 123,
      },
      prestoParameters: {
        catalog: 'catalog',
        host: 'host',
        port: 123,
      },
      rdsParameters: {
        database: 'database',
        instanceId: 'instanceId',
      },
      redshiftParameters: {
        database: 'database',

        // the properties below are optional
        clusterId: 'clusterId',
        host: 'host',
        port: 123,
      },
      s3Parameters: {
        manifestFileLocation: {
          bucket: 'bucket',
          key: 'key',
        },

        // the properties below are optional
        roleArn: 'roleArn',
      },
      snowflakeParameters: {
        database: 'database',
        host: 'host',
        warehouse: 'warehouse',
      },
      sparkParameters: {
        host: 'host',
        port: 123,
      },
      sqlServerParameters: {
        database: 'database',
        host: 'host',
        port: 123,
      },
      teradataParameters: {
        database: 'database',
        host: 'host',
        port: 123,
      },
    }],
  },
  secretArn: 'secretArn',
};

Properties

Name	Type	Description
copySourceArn?	string	The Amazon Resource Name (ARN) of a data source that has the credential pair that you want to use.
credentialPair?	IResolvable | CredentialPairProperty	Credential pair.
secretArn?	string	The Amazon Resource Name (ARN) of the secret associated with the data source in AWS Secrets Manager .

---

copySourceArn?

Type: string (optional)

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.

---

credentialPair?

Type: IResolvable | CredentialPairProperty (optional)

Credential pair.

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

---

secretArn?

Type: string (optional)

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