interface DataAccessorAuthenticationDetailProperty

Language	Type name
.NET	`Amazon.CDK.aws_qbusiness.CfnDataAccessor.DataAccessorAuthenticationDetailProperty`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsqbusiness#CfnDataAccessor_DataAccessorAuthenticationDetailProperty`
Java	`software.amazon.awscdk.services.qbusiness.CfnDataAccessor.DataAccessorAuthenticationDetailProperty`
Python	`aws_cdk.aws_qbusiness.CfnDataAccessor.DataAccessorAuthenticationDetailProperty`
TypeScript	`aws-cdk-lib` » `aws_qbusiness` » `CfnDataAccessor` » `DataAccessorAuthenticationDetailProperty`

Contains the authentication configuration details for a data accessor.

This structure defines how the ISV authenticates when accessing data through the data accessor.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_qbusiness as qbusiness } from 'aws-cdk-lib';
const dataAccessorAuthenticationDetailProperty: qbusiness.CfnDataAccessor.DataAccessorAuthenticationDetailProperty = {
  authenticationType: 'authenticationType',

  // the properties below are optional
  authenticationConfiguration: {
    idcTrustedTokenIssuerConfiguration: {
      idcTrustedTokenIssuerArn: 'idcTrustedTokenIssuerArn',
    },
  },
  externalIds: ['externalIds'],
};

Properties

Name	Type	Description
authenticationType	`string`	The type of authentication to use for the data accessor.
authenticationConfiguration?	`IResolvable` `\|` `DataAccessorAuthenticationConfigurationProperty`	The specific authentication configuration based on the authentication type.
externalIds?	`string[]`	A list of external identifiers associated with this authentication configuration.

authenticationType

Type: string

The type of authentication to use for the data accessor.

This determines how the ISV authenticates when accessing data. You can use one of two authentication types:

AWS_IAM_IDC_TTI - Authentication using IAM Identity Center Trusted Token Issuer (TTI). This authentication type allows the ISV to use a trusted token issuer to generate tokens for accessing the data.
AWS_IAM_IDC_AUTH_CODE - Authentication using IAM Identity Center authorization code flow. This authentication type uses the standard OAuth 2.0 authorization code flow for authentication.

authenticationConfiguration?

Type: IResolvable | DataAccessorAuthenticationConfigurationProperty (optional)

The specific authentication configuration based on the authentication type.

externalIds?

Type: string[] (optional)

A list of external identifiers associated with this authentication configuration.

These are used to correlate the data accessor with external systems.