aws-cdk-lib.aws_qbusiness

AWS::QBusiness Construct Library

---

All classes with the Cfn prefix in this module (CFN Resources) are always stable and safe to use.

---

This module is part of the AWS Cloud Development Kit project.

import * as qbusiness from 'aws-cdk-lib/aws-qbusiness';

import aws_cdk.aws_qbusiness as qbusiness

import software.amazon.awscdk.services.qbusiness.*;

using Amazon.CDK.AWS.QBusiness;

import qbusiness "github.com/aws/aws-cdk-go/awscdk"

There are no official hand-written (L2) constructs for this service yet. Here are some suggestions on how to proceed:

• Search Construct Hub for QBusiness construct libraries
• Use the automatically generated L1 constructs, in the same way you would use the CloudFormation AWS::QBusiness resources directly.

There are no hand-written (L2) constructs for this service yet. However, you can still use the automatically generated L1 constructs, and use this service exactly as you would using CloudFormation directly.

For more information on the resources and properties available for this service, see the CloudFormation documentation for AWS::QBusiness.

(Read the CDK Contributing Guide and submit an RFC if you are interested in contributing to this construct library.)

Types

Name	Kind	Summary
CfnApplication	Construct (L1)	Creates an Amazon Q Business application.
CfnDataAccessor	Construct (L1)	Creates a new data accessor for an ISV to access data from a Amazon Q Business application.
CfnDataSource	Construct (L1)	Creates a data source connector for an Amazon Q Business application.
CfnIndex	Construct (L1)	Creates an Amazon Q Business index.
CfnPermission	Construct (L1)	Adds or updates a permission policy for a Amazon Q Business application, allowing cross-account access for an ISV.
CfnPlugin	Construct (L1)	Information about an Amazon Q Business plugin and its configuration.
CfnRetriever	Construct (L1)	Adds a retriever to your Amazon Q Business application.
CfnWebExperience	Construct (L1)	Creates an Amazon Q Business web experience.
CfnApplication.AttachmentsConfigurationProperty	Struct	Configuration information for the file upload during chat feature.
CfnApplication.AutoSubscriptionConfigurationProperty	Struct	Subscription configuration information for an Amazon Q Business application using IAM identity federation for user management.
CfnApplication.EncryptionConfigurationProperty	Struct	Provides the identifier of the AWS key used to encrypt data indexed by Amazon Q Business.
CfnApplication.PersonalizationConfigurationProperty	Struct	Configuration information about chat response personalization.
CfnApplication.QAppsConfigurationProperty	Struct	Configuration information about Amazon Q Apps.
CfnApplication.QuickSightConfigurationProperty	Struct	The Amazon Quick Suite configuration for an Amazon Q Business application that uses Quick Suite as the identity provider.
CfnApplicationProps	Struct	Properties for defining a CfnApplication.
CfnDataAccessor.ActionConfigurationProperty	Struct	Specifies an allowed action and its associated filter configuration.
CfnDataAccessor.ActionFilterConfigurationProperty	Struct	Specifies filters to apply to an allowed action.
CfnDataAccessor.AttributeFilterProperty	Struct	Enables filtering of responses based on document attributes or metadata fields.
CfnDataAccessor.DataAccessorAuthenticationConfigurationProperty	Struct	A union type that contains the specific authentication configuration based on the authentication type selected.
CfnDataAccessor.DataAccessorAuthenticationDetailProperty	Struct	Contains the authentication configuration details for a data accessor.
CfnDataAccessor.DataAccessorIdcTrustedTokenIssuerConfigurationProperty	Struct	Configuration details for IAM Identity Center Trusted Token Issuer (TTI) authentication.
CfnDataAccessor.DocumentAttributeProperty	Struct	A document attribute or metadata field.
CfnDataAccessor.DocumentAttributeValueProperty	Struct	The value of a document attribute.
CfnDataAccessorProps	Struct	Properties for defining a CfnDataAccessor.
CfnDataSource.AudioExtractionConfigurationProperty	Struct	Configuration settings for audio content extraction and processing.
CfnDataSource.DataSourceVpcConfigurationProperty	Struct	Provides configuration information needed to connect to an Amazon VPC (Virtual Private Cloud).
CfnDataSource.DocumentAttributeConditionProperty	Struct	The condition used for the target document attribute or metadata field when ingesting documents into Amazon Q Business.
CfnDataSource.DocumentAttributeTargetProperty	Struct	The target document attribute or metadata field you want to alter when ingesting documents into Amazon Q Business.
CfnDataSource.DocumentAttributeValueProperty	Struct	The value of a document attribute.
CfnDataSource.DocumentEnrichmentConfigurationProperty	Struct	Provides the configuration information for altering document metadata and content during the document ingestion process.
CfnDataSource.HookConfigurationProperty	Struct	Provides the configuration information for invoking a Lambda function in AWS Lambda to alter document metadata and content when ingesting documents into Amazon Q Business.
CfnDataSource.ImageExtractionConfigurationProperty	Struct	The configuration for extracting semantic meaning from images in documents.
CfnDataSource.InlineDocumentEnrichmentConfigurationProperty	Struct	Provides the configuration information for applying basic logic to alter document metadata and content when ingesting documents into Amazon Q Business.
CfnDataSource.MediaExtractionConfigurationProperty	Struct	The configuration for extracting information from media in documents.
CfnDataSource.VideoExtractionConfigurationProperty	Struct	Configuration settings for video content extraction and processing.
CfnDataSourceProps	Struct	Properties for defining a CfnDataSource.
CfnIndex.DocumentAttributeConfigurationProperty	Struct	Configuration information for document attributes.
CfnIndex.IndexCapacityConfigurationProperty	Struct	Provides information about index capacity configuration.
CfnIndex.IndexStatisticsProperty	Struct	Provides information about the number of documents in an index.
CfnIndex.TextDocumentStatisticsProperty	Struct	Provides information about text documents in an index.
CfnIndexProps	Struct	Properties for defining a CfnIndex.
CfnPermission.ConditionProperty	Struct
CfnPermissionProps	Struct	Properties for defining a CfnPermission.
CfnPlugin.APISchemaProperty	Struct	Contains details about the OpenAPI schema for a custom plugin.
CfnPlugin.BasicAuthConfigurationProperty	Struct	Information about the basic authentication credentials used to configure a plugin.
CfnPlugin.CustomPluginConfigurationProperty	Struct	Configuration information required to create a custom plugin.
CfnPlugin.OAuth2ClientCredentialConfigurationProperty	Struct	Information about the OAuth 2.0 authentication credential/token used to configure a plugin.
CfnPlugin.PluginAuthConfigurationProperty	Struct	Authentication configuration information for an Amazon Q Business plugin.
CfnPlugin.S3Property	Struct	Information required for Amazon Q Business to find a specific file in an Amazon S3 bucket.
CfnPluginProps	Struct	Properties for defining a CfnPlugin.
CfnRetriever.KendraIndexConfigurationProperty	Struct	Stores an Amazon Kendra index as a retriever.
CfnRetriever.NativeIndexConfigurationProperty	Struct	Configuration information for an Amazon Q Business index.
CfnRetriever.RetrieverConfigurationProperty	Struct	Provides information on how the retriever used for your Amazon Q Business application is configured.
CfnRetrieverProps	Struct	Properties for defining a CfnRetriever.
CfnWebExperience.BrowserExtensionConfigurationProperty	Struct	The container for browser extension configuration for an Amazon Q Business web experience.
CfnWebExperience.CustomizationConfigurationProperty	Struct	Contains the configuration information to customize the logo, font, and color of an Amazon Q Business web experience with individual files for each property or a CSS file for them all.
CfnWebExperience.IdentityProviderConfigurationProperty	Struct	Provides information about the identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.
CfnWebExperience.OpenIDConnectProviderConfigurationProperty	Struct	Information about the OIDC-compliant identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.
CfnWebExperience.SamlProviderConfigurationProperty	Struct	Information about the SAML 2.0-compliant identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.
CfnWebExperienceProps	Struct	Properties for defining a CfnWebExperience.