interface CredentialPairProperty

Language	Type name
.NET	Amazon.CDK.AWS.QuickSight.CfnDataSource.CredentialPairProperty
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsquicksight#CfnDataSource_CredentialPairProperty
Java	software.amazon.awscdk.services.quicksight.CfnDataSource.CredentialPairProperty
Python	aws_cdk.aws_quicksight.CfnDataSource.CredentialPairProperty
TypeScript	aws-cdk-lib » aws_quicksight » CfnDataSource » CredentialPairProperty

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-credentialpair.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_quicksight as quicksight } from 'aws-cdk-lib';
const credentialPairProperty: quicksight.CfnDataSource.CredentialPairProperty = {
  password: 'password',
  username: 'username',

  // the properties below are optional
  alternateDataSourceParameters: [{
    amazonElasticsearchParameters: {
      domain: 'domain',
    },
    amazonOpenSearchParameters: {
      domain: 'domain',
    },
    athenaParameters: {
      identityCenterConfiguration: {
        enableIdentityPropagation: false,
      },
      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,

      // the properties below are optional
      useServiceName: false,
    },
    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',
      iamParameters: {
        roleArn: 'roleArn',

        // the properties below are optional
        autoCreateDatabaseUser: false,
        databaseGroups: ['databaseGroups'],
        databaseUser: 'databaseUser',
      },
      identityCenterConfiguration: {
        enableIdentityPropagation: false,
      },
      port: 123,
    },
    s3Parameters: {
      manifestFileLocation: {
        bucket: 'bucket',
        key: 'key',
      },

      // the properties below are optional
      roleArn: 'roleArn',
    },
    snowflakeParameters: {
      database: 'database',
      host: 'host',
      warehouse: 'warehouse',

      // the properties below are optional
      authenticationType: 'authenticationType',
      databaseAccessControlRole: 'databaseAccessControlRole',
      oAuthParameters: {
        tokenProviderUrl: 'tokenProviderUrl',

        // the properties below are optional
        identityProviderResourceUri: 'identityProviderResourceUri',
        identityProviderVpcConnectionProperties: {
          vpcConnectionArn: 'vpcConnectionArn',
        },
        oAuthScope: 'oAuthScope',
      },
    },
    sparkParameters: {
      host: 'host',
      port: 123,
    },
    sqlServerParameters: {
      database: 'database',
      host: 'host',
      port: 123,
    },
    starburstParameters: {
      catalog: 'catalog',
      host: 'host',
      port: 123,

      // the properties below are optional
      authenticationType: 'authenticationType',
      databaseAccessControlRole: 'databaseAccessControlRole',
      oAuthParameters: {
        tokenProviderUrl: 'tokenProviderUrl',

        // the properties below are optional
        identityProviderResourceUri: 'identityProviderResourceUri',
        identityProviderVpcConnectionProperties: {
          vpcConnectionArn: 'vpcConnectionArn',
        },
        oAuthScope: 'oAuthScope',
      },
      productType: 'productType',
    },
    teradataParameters: {
      database: 'database',
      host: 'host',
      port: 123,
    },
    trinoParameters: {
      catalog: 'catalog',
      host: 'host',
      port: 123,
    },
  }],
};

Properties

Name	Type	Description
password	string	Password.
username	string	User name.
alternateDataSourceParameters?	IResolvable | (IResolvable | DataSourceParametersProperty)[]	A set of alternate data source parameters that you want to share for these credentials.

---

password

Type: string

Password.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-credentialpair.html#cfn-quicksight-datasource-credentialpair-password

---

username

Type: string

User name.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-credentialpair.html#cfn-quicksight-datasource-credentialpair-username

---

alternateDataSourceParameters?

Type: IResolvable | (IResolvable | DataSourceParametersProperty)[] (optional)

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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-credentialpair.html#cfn-quicksight-datasource-credentialpair-alternatedatasourceparameters