Package software.amazon.awscdk.services.qbusiness

Class CfnDataAccessor

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.qbusiness.CfnDataAccessor

All Implemented Interfaces:

IInspectable, IEnvironmentAware, IDataAccessorRef, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)",
           date="2025-11-20T23:37:26.358Z")
@Stability(Stable)
public class CfnDataAccessor
extends CfnResource
implements IInspectable, IDataAccessorRef, ITaggableV2

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.services.qbusiness.*;
 AttributeFilterProperty attributeFilterProperty_;
 CfnDataAccessor cfnDataAccessor = CfnDataAccessor.Builder.create(this, "MyCfnDataAccessor")
         .actionConfigurations(List.of(ActionConfigurationProperty.builder()
                 .action("action")
                 // the properties below are optional
                 .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")
         .displayName("displayName")
         .principal("principal")
         // the properties below are optional
         .authenticationDetail(DataAccessorAuthenticationDetailProperty.builder()
                 .authenticationType("authenticationType")
                 // the properties below are optional
                 .authenticationConfiguration(DataAccessorAuthenticationConfigurationProperty.builder()
                         .idcTrustedTokenIssuerConfiguration(DataAccessorIdcTrustedTokenIssuerConfigurationProperty.builder()
                                 .idcTrustedTokenIssuerArn("idcTrustedTokenIssuerArn")
                                 .build())
                         .build())
                 .externalIds(List.of("externalIds"))
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .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	CfnDataAccessor.ActionConfigurationProperty	Specifies an allowed action and its associated filter configuration.
static interface	CfnDataAccessor.ActionFilterConfigurationProperty	Specifies filters to apply to an allowed action.
static interface	CfnDataAccessor.AttributeFilterProperty	Enables filtering of responses based on document attributes or metadata fields.
static final class	CfnDataAccessor.Builder	A fluent builder for CfnDataAccessor.
static interface	CfnDataAccessor.DataAccessorAuthenticationConfigurationProperty	A union type that contains the specific authentication configuration based on the authentication type selected.
static interface	CfnDataAccessor.DataAccessorAuthenticationDetailProperty	Contains the authentication configuration details for a data accessor.
static interface	CfnDataAccessor.DataAccessorIdcTrustedTokenIssuerConfigurationProperty	Configuration details for IAM Identity Center Trusted Token Issuer (TTI) authentication.
static interface	CfnDataAccessor.DocumentAttributeProperty	A document attribute or metadata field.
static interface	CfnDataAccessor.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.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.interfaces.qbusiness.IDataAccessorRef

IDataAccessorRef.Jsii$Default, IDataAccessorRef.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.ITaggableV2

ITaggableV2.Jsii$Default, ITaggableV2.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnDataAccessor(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnDataAccessor(software.amazon.jsii.JsiiObjectRef objRef)
	CfnDataAccessor(software.constructs.Construct scope, String id, CfnDataAccessorProps props)	Create a new AWS::QBusiness::DataAccessor.

Method Summary

Modifier and Type	Method	Description
static String	arnForDataAccessor(IDataAccessorRef resource)
Object	getActionConfigurations()	A list of action configurations specifying the allowed actions and any associated filters.
String	getApplicationId()	The unique identifier of the Amazon Q Business application.
String	getAttrCreatedAt()	The timestamp when the data accessor was created.
String	getAttrDataAccessorArn()	The Amazon Resource Name (ARN) of the data accessor.
String	getAttrDataAccessorId()	The unique identifier of the data accessor.
String	getAttrIdcApplicationArn()	The Amazon Resource Name (ARN) of the associated IAM Identity Center application.
String	getAttrUpdatedAt()	The timestamp when the data accessor was last updated.
Object	getAuthenticationDetail()	The authentication configuration details for the data accessor.
TagManager	getCdkTagManager()	Tag Manager which manages the tags for this resource.
protected Map<String,Object>	getCfnProperties()
DataAccessorReference	getDataAccessorRef()	A reference to a DataAccessor resource.
String	getDisplayName()	The friendly name of the data accessor.
String	getPrincipal()	The Amazon Resource Name (ARN) of the IAM role for the ISV associated with this data accessor.
List<CfnTag>	getTags()	The tags to associate with the data accessor.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setActionConfigurations(List<Object> value)	A list of action configurations specifying the allowed actions and any associated filters.
void	setActionConfigurations(IResolvable value)	A list of action configurations specifying the allowed actions and any associated filters.
void	setApplicationId(String value)	The unique identifier of the Amazon Q Business application.
void	setAuthenticationDetail(IResolvable value)	The authentication configuration details for the data accessor.
void	setAuthenticationDetail(CfnDataAccessor.DataAccessorAuthenticationDetailProperty value)	The authentication configuration details for the data accessor.
void	setDisplayName(String value)	The friendly name of the data accessor.
void	setPrincipal(String value)	The Amazon Resource Name (ARN) of the IAM role for the ISV associated with this data accessor.
void	setTags(List<CfnTag> value)	The tags to associate with the data accessor.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getEnv, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

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, wait, wait, wait

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.awscdk.interfaces.IEnvironmentAware

getEnv

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_RESOURCE_TYPE_NAME

@Stability(Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Details

CfnDataAccessor

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

CfnDataAccessor

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

CfnDataAccessor

@Stability(Stable)
public CfnDataAccessor(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnDataAccessorProps props)

Create a new AWS::QBusiness::DataAccessor.

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

props - Resource properties. This parameter is required.

Method Details

arnForDataAccessor

@Stability(Stable)
@NotNull
public static String arnForDataAccessor(@NotNull
 IDataAccessorRef resource)

Parameters:

resource - This parameter is required.

inspect

@Stability(Stable)
public void inspect(@NotNull
 TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> renderProperties(@NotNull
 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrCreatedAt

@Stability(Stable)
@NotNull
public String getAttrCreatedAt()

The timestamp when the data accessor was created.

getAttrDataAccessorArn

@Stability(Stable)
@NotNull
public String getAttrDataAccessorArn()

The Amazon Resource Name (ARN) of the data accessor.

getAttrDataAccessorId

@Stability(Stable)
@NotNull
public String getAttrDataAccessorId()

The unique identifier of the data accessor.

getAttrIdcApplicationArn

@Stability(Stable)
@NotNull
public String getAttrIdcApplicationArn()

The Amazon Resource Name (ARN) of the associated IAM Identity Center application.

getAttrUpdatedAt

@Stability(Stable)
@NotNull
public String getAttrUpdatedAt()

The timestamp when the data accessor was last updated.

getCdkTagManager

@Stability(Stable)
@NotNull
public TagManager getCdkTagManager()

Tag Manager which manages the tags for this resource.

Specified by:

getCdkTagManager in interface ITaggableV2

getCfnProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getDataAccessorRef

@Stability(Stable)
@NotNull
public DataAccessorReference getDataAccessorRef()

A reference to a DataAccessor resource.

Specified by:

getDataAccessorRef in interface IDataAccessorRef

getActionConfigurations

@Stability(Stable)
@NotNull
public Object getActionConfigurations()

A list of action configurations specifying the allowed actions and any associated filters.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnDataAccessor.ActionConfigurationProperty>

setActionConfigurations

@Stability(Stable)
public void setActionConfigurations(@NotNull
 IResolvable value)

A list of action configurations specifying the allowed actions and any associated filters.

setActionConfigurations

@Stability(Stable)
public void setActionConfigurations(@NotNull
 List<Object> value)

A list of action configurations specifying the allowed actions and any associated filters.

getApplicationId

@Stability(Stable)
@NotNull
public String getApplicationId()

The unique identifier of the Amazon Q Business application.

setApplicationId

@Stability(Stable)
public void setApplicationId(@NotNull
 String value)

The unique identifier of the Amazon Q Business application.

getDisplayName

@Stability(Stable)
@NotNull
public String getDisplayName()

The friendly name of the data accessor.

setDisplayName

@Stability(Stable)
public void setDisplayName(@NotNull
 String value)

The friendly name of the data accessor.

getPrincipal

@Stability(Stable)
@NotNull
public String getPrincipal()

The Amazon Resource Name (ARN) of the IAM role for the ISV associated with this data accessor.

setPrincipal

@Stability(Stable)
public void setPrincipal(@NotNull
 String value)

The Amazon Resource Name (ARN) of the IAM role for the ISV associated with this data accessor.

getAuthenticationDetail

@Stability(Stable)
@Nullable
public Object getAuthenticationDetail()

The authentication configuration details for the data accessor.

Returns union: either IResolvable or CfnDataAccessor.DataAccessorAuthenticationDetailProperty

setAuthenticationDetail

@Stability(Stable)
public void setAuthenticationDetail(@Nullable
 IResolvable value)

The authentication configuration details for the data accessor.

setAuthenticationDetail

@Stability(Stable)
public void setAuthenticationDetail(@Nullable
 CfnDataAccessor.DataAccessorAuthenticationDetailProperty value)

The authentication configuration details for the data accessor.

getTags

@Stability(Stable)
@Nullable
public List<CfnTag> getTags()

The tags to associate with the data accessor.

setTags

@Stability(Stable)
public void setTags(@Nullable
 List<CfnTag> value)

The tags to associate with the data accessor.