Package software.amazon.awscdk.cfnpropertymixins.services.qbusiness

Interface CfnDataAccessorPropsMixin.DataAccessorAuthenticationDetailProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDataAccessorPropsMixin.DataAccessorAuthenticationDetailProperty.Jsii$Proxy

Enclosing class:

CfnDataAccessorPropsMixin

@Stability(Stable)
public static interface CfnDataAccessorPropsMixin.DataAccessorAuthenticationDetailProperty
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.cfnpropertymixins.services.qbusiness.*;
 DataAccessorAuthenticationDetailProperty dataAccessorAuthenticationDetailProperty = DataAccessorAuthenticationDetailProperty.builder()
         .authenticationConfiguration(DataAccessorAuthenticationConfigurationProperty.builder()
                 .idcTrustedTokenIssuerConfiguration(DataAccessorIdcTrustedTokenIssuerConfigurationProperty.builder()
                         .idcTrustedTokenIssuerArn("idcTrustedTokenIssuerArn")
                         .build())
                 .build())
         .authenticationType("authenticationType")
         .externalIds(List.of("externalIds"))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-dataaccessor-dataaccessorauthenticationdetail.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnDataAccessorPropsMixin.DataAccessorAuthenticationDetailProperty.Builder	builder()
default Object	getAuthenticationConfiguration()	The specific authentication configuration based on the authentication type.
default String	getAuthenticationType()	The type of authentication to use for the data accessor.
default List<String>	getExternalIds()	A list of external identifiers associated with this authentication configuration.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAuthenticationConfiguration

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

The specific authentication configuration based on the authentication type.

Returns union: either IResolvable or CfnDataAccessorPropsMixin.DataAccessorAuthenticationConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-dataaccessor-dataaccessorauthenticationdetail.html#cfn-qbusiness-dataaccessor-dataaccessorauthenticationdetail-authenticationconfiguration

getAuthenticationType

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

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-dataaccessor-dataaccessorauthenticationdetail.html#cfn-qbusiness-dataaccessor-dataaccessorauthenticationdetail-authenticationtype

getExternalIds

@Stability(Stable)
@Nullable
default List<String> getExternalIds()

A list of external identifiers associated with this authentication configuration.

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-dataaccessor-dataaccessorauthenticationdetail.html#cfn-qbusiness-dataaccessor-dataaccessorauthenticationdetail-externalids

builder

@Stability(Stable)
static CfnDataAccessorPropsMixin.DataAccessorAuthenticationDetailProperty.Builder builder()

Returns:

a CfnDataAccessorPropsMixin.DataAccessorAuthenticationDetailProperty.Builder of CfnDataAccessorPropsMixin.DataAccessorAuthenticationDetailProperty