Package software.amazon.awscdk.services.qbusiness

Interface CfnDataAccessorProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDataAccessorProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.121.0 (build d7af9b9)",
           date="2025-12-18T18:20:14.595Z")
@Stability(Stable)
public interface CfnDataAccessorProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnDataAccessor.

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_;
 CfnDataAccessorProps cfnDataAccessorProps = CfnDataAccessorProps.builder()
         .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	Interface	Description
static final class	CfnDataAccessorProps.Builder	A builder for CfnDataAccessorProps
static final class	CfnDataAccessorProps.Jsii$Proxy	An implementation for CfnDataAccessorProps

Method Summary

Modifier and Type	Method	Description
static CfnDataAccessorProps.Builder	builder()
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.
default Object	getAuthenticationDetail()	The authentication configuration details for the data accessor.
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.
default List<CfnTag>	getTags()	The tags to associate with the data accessor.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getActionConfigurations

@Stability(Stable)
@NotNull
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>

See Also:

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

getApplicationId

@Stability(Stable)
@NotNull
String getApplicationId()

The unique identifier of the Amazon Q Business application.

See Also:

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

getDisplayName

@Stability(Stable)
@NotNull
String getDisplayName()

The friendly name of the data accessor.

See Also:

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

getPrincipal

@Stability(Stable)
@NotNull
String getPrincipal()

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

See Also:

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

getAuthenticationDetail

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

The authentication configuration details for the data accessor.

This specifies how the ISV authenticates when accessing data through this data accessor.

Returns union: either IResolvable or CfnDataAccessor.DataAccessorAuthenticationDetailProperty

See Also:

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

getTags

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

The tags to associate with the data accessor.

See Also:

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

builder

@Stability(Stable)
static CfnDataAccessorProps.Builder builder()

Returns:

a CfnDataAccessorProps.Builder of CfnDataAccessorProps