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

Class CfnDataAccessorPropsMixin

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.Mixin

software.amazon.awscdk.cfnpropertymixins.services.qbusiness.CfnDataAccessorPropsMixin

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable, software.constructs.IMixin

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-04-02T21:55:30.877Z")
@Stability(Stable)
public class CfnDataAccessorPropsMixin
extends Mixin
implements software.constructs.IMixin

Creates a new data accessor for an ISV to access data from a Amazon Q Business application.

The data accessor is an entity that represents the ISV's access to the Amazon Q Business application's data. It includes the IAM role ARN for the ISV, a friendly name, and a set of action configurations that define the specific actions the ISV is allowed to perform and any associated data filters. When the data accessor is created, an IAM Identity Center application is also created to manage the ISV's identity and authentication for accessing the Amazon Q Business application.

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.*;
 import software.amazon.awscdk.*;
 AttributeFilterProperty attributeFilterProperty_;
 IMergeStrategy mergeStrategy;
 CfnDataAccessorPropsMixin cfnDataAccessorPropsMixin = CfnDataAccessorPropsMixin.Builder.create(CfnDataAccessorMixinProps.builder()
         .actionConfigurations(List.of(ActionConfigurationProperty.builder()
                 .action("action")
                 .filterConfiguration(ActionFilterConfigurationProperty.builder()
                         .documentAttributeFilter(AttributeFilterProperty.builder()
                                 .andAllFilters(List.of(attributeFilterProperty_))
                                 .containsAll(DocumentAttributeProperty.builder()
                                         .name("name")
                                         .value(DocumentAttributeValueProperty.builder()
                                                 .dateValue("dateValue")
                                                 .longValue(123)
                                                 .stringListValue(List.of("stringListValue"))
                                                 .stringValue("stringValue")
                                                 .build())
                                         .build())
                                 .containsAny(DocumentAttributeProperty.builder()
                                         .name("name")
                                         .value(DocumentAttributeValueProperty.builder()
                                                 .dateValue("dateValue")
                                                 .longValue(123)
                                                 .stringListValue(List.of("stringListValue"))
                                                 .stringValue("stringValue")
                                                 .build())
                                         .build())
                                 .equalsTo(DocumentAttributeProperty.builder()
                                         .name("name")
                                         .value(DocumentAttributeValueProperty.builder()
                                                 .dateValue("dateValue")
                                                 .longValue(123)
                                                 .stringListValue(List.of("stringListValue"))
                                                 .stringValue("stringValue")
                                                 .build())
                                         .build())
                                 .greaterThan(DocumentAttributeProperty.builder()
                                         .name("name")
                                         .value(DocumentAttributeValueProperty.builder()
                                                 .dateValue("dateValue")
                                                 .longValue(123)
                                                 .stringListValue(List.of("stringListValue"))
                                                 .stringValue("stringValue")
                                                 .build())
                                         .build())
                                 .greaterThanOrEquals(DocumentAttributeProperty.builder()
                                         .name("name")
                                         .value(DocumentAttributeValueProperty.builder()
                                                 .dateValue("dateValue")
                                                 .longValue(123)
                                                 .stringListValue(List.of("stringListValue"))
                                                 .stringValue("stringValue")
                                                 .build())
                                         .build())
                                 .lessThan(DocumentAttributeProperty.builder()
                                         .name("name")
                                         .value(DocumentAttributeValueProperty.builder()
                                                 .dateValue("dateValue")
                                                 .longValue(123)
                                                 .stringListValue(List.of("stringListValue"))
                                                 .stringValue("stringValue")
                                                 .build())
                                         .build())
                                 .lessThanOrEquals(DocumentAttributeProperty.builder()
                                         .name("name")
                                         .value(DocumentAttributeValueProperty.builder()
                                                 .dateValue("dateValue")
                                                 .longValue(123)
                                                 .stringListValue(List.of("stringListValue"))
                                                 .stringValue("stringValue")
                                                 .build())
                                         .build())
                                 .notFilter(attributeFilterProperty_)
                                 .orAllFilters(List.of(attributeFilterProperty_))
                                 .build())
                         .build())
                 .build()))
         .applicationId("applicationId")
         .authenticationDetail(DataAccessorAuthenticationDetailProperty.builder()
                 .authenticationConfiguration(DataAccessorAuthenticationConfigurationProperty.builder()
                         .idcTrustedTokenIssuerConfiguration(DataAccessorIdcTrustedTokenIssuerConfigurationProperty.builder()
                                 .idcTrustedTokenIssuerArn("idcTrustedTokenIssuerArn")
                                 .build())
                         .build())
                 .authenticationType("authenticationType")
                 .externalIds(List.of("externalIds"))
                 .build())
         .displayName("displayName")
         .principal("principal")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build())
 .strategy(mergeStrategy)
 .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CfnDataAccessorPropsMixin.ActionConfigurationProperty	Specifies an allowed action and its associated filter configuration.
static interface	CfnDataAccessorPropsMixin.ActionFilterConfigurationProperty	Specifies filters to apply to an allowed action.
static interface	CfnDataAccessorPropsMixin.AttributeFilterProperty	Enables filtering of responses based on document attributes or metadata fields.
static final class	CfnDataAccessorPropsMixin.Builder	A fluent builder for CfnDataAccessorPropsMixin.
static interface	CfnDataAccessorPropsMixin.DataAccessorAuthenticationConfigurationProperty	A union type that contains the specific authentication configuration based on the authentication type selected.
static interface	CfnDataAccessorPropsMixin.DataAccessorAuthenticationDetailProperty	Contains the authentication configuration details for a data accessor.
static interface	CfnDataAccessorPropsMixin.DataAccessorIdcTrustedTokenIssuerConfigurationProperty	Configuration details for IAM Identity Center Trusted Token Issuer (TTI) authentication.
static interface	CfnDataAccessorPropsMixin.DocumentAttributeProperty	A document attribute or metadata field.
static interface	CfnDataAccessorPropsMixin.DocumentAttributeValueProperty	The value of a document attribute.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IMixin

software.constructs.IMixin.Jsii$Default, software.constructs.IMixin.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
protected static final List<String>	CFN_PROPERTY_KEYS

Constructor Summary

Constructors

Modifier	Constructor	Description
	CfnDataAccessorPropsMixin(CfnDataAccessorMixinProps props)	Create a mixin to apply properties to AWS::QBusiness::DataAccessor.
	CfnDataAccessorPropsMixin(CfnDataAccessorMixinProps props, CfnPropertyMixinOptions options)	Create a mixin to apply properties to AWS::QBusiness::DataAccessor.
protected	CfnDataAccessorPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnDataAccessorPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
void	applyTo(software.constructs.IConstruct construct)	Apply the mixin properties to the construct.
protected CfnDataAccessorMixinProps	getProps()
protected IMergeStrategy	getStrategy()
Boolean	supports(software.constructs.IConstruct construct)	Check if this mixin supports the given construct.

Methods inherited from class software.amazon.awscdk.Mixin

isMixin

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_PROPERTY_KEYS

@Stability(Stable)
protected static final List<String> CFN_PROPERTY_KEYS

Constructor Details

CfnDataAccessorPropsMixin

protected CfnDataAccessorPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

CfnDataAccessorPropsMixin

protected CfnDataAccessorPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnDataAccessorPropsMixin

@Stability(Stable)
public CfnDataAccessorPropsMixin(@NotNull
 CfnDataAccessorMixinProps props,
 @Nullable
 CfnPropertyMixinOptions options)

Create a mixin to apply properties to AWS::QBusiness::DataAccessor.

Parameters:

props - L1 properties to apply. This parameter is required.

options - Mixin options.

CfnDataAccessorPropsMixin

@Stability(Stable)
public CfnDataAccessorPropsMixin(@NotNull
 CfnDataAccessorMixinProps props)

Create a mixin to apply properties to AWS::QBusiness::DataAccessor.

Parameters:

props - L1 properties to apply. This parameter is required.

Method Details

applyTo

@Stability(Stable)
public void applyTo(@NotNull
 software.constructs.IConstruct construct)

Apply the mixin properties to the construct.

Specified by:

applyTo in interface software.constructs.IMixin

Specified by:

applyTo in class Mixin

Parameters:

construct - This parameter is required.

supports

@Stability(Stable)
@NotNull
public Boolean supports(@NotNull
 software.constructs.IConstruct construct)

Check if this mixin supports the given construct.

Specified by:

supports in interface software.constructs.IMixin

Overrides:

supports in class Mixin

Parameters:

construct - This parameter is required.

getProps

@Stability(Stable)
@NotNull
protected CfnDataAccessorMixinProps getProps()

getStrategy

@Stability(Stable)
@NotNull
protected IMergeStrategy getStrategy()