Package software.amazon.awscdk.services.qbusiness
package software.amazon.awscdk.services.qbusiness
AWS::QBusiness Construct Library
---
All classes with the
Cfnprefix in this module (CFN Resources) are always stable and safe to use.
This module is part of the AWS Cloud Development Kit project.
import software.amazon.awscdk.services.qbusiness.*;
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.)
-
ClassDescriptionA reference to a Application resource.A builder for
ApplicationReferenceAn implementation forApplicationReferenceCreates an Amazon Q Business application.Configuration information for the file upload during chat feature.A builder forCfnApplication.AttachmentsConfigurationPropertyAn implementation forCfnApplication.AttachmentsConfigurationPropertySubscription configuration information for an Amazon Q Business application using IAM identity federation for user management.A builder forCfnApplication.AutoSubscriptionConfigurationPropertyAn implementation forCfnApplication.AutoSubscriptionConfigurationPropertyA fluent builder forCfnApplication.Provides the identifier of the AWS KMS key used to encrypt data indexed by Amazon Q Business.A builder forCfnApplication.EncryptionConfigurationPropertyAn implementation forCfnApplication.EncryptionConfigurationPropertyConfiguration information about chat response personalization.A builder forCfnApplication.PersonalizationConfigurationPropertyAn implementation forCfnApplication.PersonalizationConfigurationPropertyConfiguration information about Amazon Q Apps.A builder forCfnApplication.QAppsConfigurationPropertyAn implementation forCfnApplication.QAppsConfigurationPropertyThe Amazon QuickSight configuration for an Amazon Q Business application that uses QuickSight as the identity provider.A builder forCfnApplication.QuickSightConfigurationPropertyAn implementation forCfnApplication.QuickSightConfigurationPropertyProperties for defining aCfnApplication.A builder forCfnApplicationPropsAn implementation forCfnApplicationPropsCreates a new data accessor for an ISV to access data from a Amazon Q Business application.Specifies an allowed action and its associated filter configuration.A builder forCfnDataAccessor.ActionConfigurationPropertyAn implementation forCfnDataAccessor.ActionConfigurationPropertySpecifies filters to apply to an allowed action.A builder forCfnDataAccessor.ActionFilterConfigurationPropertyAn implementation forCfnDataAccessor.ActionFilterConfigurationPropertyEnables filtering of responses based on document attributes or metadata fields.A builder forCfnDataAccessor.AttributeFilterPropertyAn implementation forCfnDataAccessor.AttributeFilterPropertyA fluent builder forCfnDataAccessor.A union type that contains the specific authentication configuration based on the authentication type selected.An implementation forCfnDataAccessor.DataAccessorAuthenticationConfigurationPropertyContains the authentication configuration details for a data accessor.A builder forCfnDataAccessor.DataAccessorAuthenticationDetailPropertyAn implementation forCfnDataAccessor.DataAccessorAuthenticationDetailPropertyConfiguration details for IAM Identity Center Trusted Token Issuer (TTI) authentication.An implementation forCfnDataAccessor.DataAccessorIdcTrustedTokenIssuerConfigurationPropertyA document attribute or metadata field.A builder forCfnDataAccessor.DocumentAttributePropertyAn implementation forCfnDataAccessor.DocumentAttributePropertyThe value of a document attribute.A builder forCfnDataAccessor.DocumentAttributeValuePropertyAn implementation forCfnDataAccessor.DocumentAttributeValuePropertyProperties for defining aCfnDataAccessor.A builder forCfnDataAccessorPropsAn implementation forCfnDataAccessorPropsCreates a data source connector for an Amazon Q Business application.Configuration settings for audio content extraction and processing.A builder forCfnDataSource.AudioExtractionConfigurationPropertyAn implementation forCfnDataSource.AudioExtractionConfigurationPropertyA fluent builder forCfnDataSource.Provides configuration information needed to connect to an Amazon VPC (Virtual Private Cloud).A builder forCfnDataSource.DataSourceVpcConfigurationPropertyAn implementation forCfnDataSource.DataSourceVpcConfigurationPropertyThe condition used for the target document attribute or metadata field when ingesting documents into Amazon Q Business.A builder forCfnDataSource.DocumentAttributeConditionPropertyAn implementation forCfnDataSource.DocumentAttributeConditionPropertyThe target document attribute or metadata field you want to alter when ingesting documents into Amazon Q Business.A builder forCfnDataSource.DocumentAttributeTargetPropertyAn implementation forCfnDataSource.DocumentAttributeTargetPropertyThe value of a document attribute.A builder forCfnDataSource.DocumentAttributeValuePropertyAn implementation forCfnDataSource.DocumentAttributeValuePropertyProvides the configuration information for altering document metadata and content during the document ingestion process.A builder forCfnDataSource.DocumentEnrichmentConfigurationPropertyAn implementation forCfnDataSource.DocumentEnrichmentConfigurationPropertyProvides the configuration information for invoking a Lambda function in AWS Lambda to alter document metadata and content when ingesting documents into Amazon Q Business.A builder forCfnDataSource.HookConfigurationPropertyAn implementation forCfnDataSource.HookConfigurationPropertyThe configuration for extracting semantic meaning from images in documents.A builder forCfnDataSource.ImageExtractionConfigurationPropertyAn implementation forCfnDataSource.ImageExtractionConfigurationPropertyProvides the configuration information for applying basic logic to alter document metadata and content when ingesting documents into Amazon Q Business.An implementation forCfnDataSource.InlineDocumentEnrichmentConfigurationPropertyThe configuration for extracting information from media in documents.A builder forCfnDataSource.MediaExtractionConfigurationPropertyAn implementation forCfnDataSource.MediaExtractionConfigurationPropertyConfiguration settings for video content extraction and processing.A builder forCfnDataSource.VideoExtractionConfigurationPropertyAn implementation forCfnDataSource.VideoExtractionConfigurationPropertyProperties for defining aCfnDataSource.A builder forCfnDataSourcePropsAn implementation forCfnDataSourcePropsCreates an Amazon Q Business index.A fluent builder forCfnIndex.Configuration information for document attributes.A builder forCfnIndex.DocumentAttributeConfigurationPropertyAn implementation forCfnIndex.DocumentAttributeConfigurationPropertyProvides information about index capacity configuration.A builder forCfnIndex.IndexCapacityConfigurationPropertyAn implementation forCfnIndex.IndexCapacityConfigurationPropertyProvides information about the number of documents in an index.A builder forCfnIndex.IndexStatisticsPropertyAn implementation forCfnIndex.IndexStatisticsPropertyProvides information about text documents in an index.A builder forCfnIndex.TextDocumentStatisticsPropertyAn implementation forCfnIndex.TextDocumentStatisticsPropertyProperties for defining aCfnIndex.A builder forCfnIndexPropsAn implementation forCfnIndexPropsAdds or updates a permission policy for a Amazon Q Business application, allowing cross-account access for an ISV.A fluent builder forCfnPermission.Example:A builder forCfnPermission.ConditionPropertyAn implementation forCfnPermission.ConditionPropertyProperties for defining aCfnPermission.A builder forCfnPermissionPropsAn implementation forCfnPermissionPropsInformation about an Amazon Q Business plugin and its configuration.Contains details about the OpenAPI schema for a custom plugin.A builder forCfnPlugin.APISchemaPropertyAn implementation forCfnPlugin.APISchemaPropertyInformation about the basic authentication credentials used to configure a plugin.A builder forCfnPlugin.BasicAuthConfigurationPropertyAn implementation forCfnPlugin.BasicAuthConfigurationPropertyA fluent builder forCfnPlugin.Configuration information required to create a custom plugin.A builder forCfnPlugin.CustomPluginConfigurationPropertyAn implementation forCfnPlugin.CustomPluginConfigurationPropertyInformation about the OAuth 2.0 authentication credential/token used to configure a plugin.A builder forCfnPlugin.OAuth2ClientCredentialConfigurationPropertyAn implementation forCfnPlugin.OAuth2ClientCredentialConfigurationPropertyAuthentication configuration information for an Amazon Q Business plugin.A builder forCfnPlugin.PluginAuthConfigurationPropertyAn implementation forCfnPlugin.PluginAuthConfigurationPropertyInformation required for Amazon Q Business to find a specific file in an Amazon S3 bucket.A builder forCfnPlugin.S3PropertyAn implementation forCfnPlugin.S3PropertyProperties for defining aCfnPlugin.A builder forCfnPluginPropsAn implementation forCfnPluginPropsAdds a retriever to your Amazon Q Business application.A fluent builder forCfnRetriever.Stores an Amazon Kendra index as a retriever.A builder forCfnRetriever.KendraIndexConfigurationPropertyAn implementation forCfnRetriever.KendraIndexConfigurationPropertyConfiguration information for an Amazon Q Business index.A builder forCfnRetriever.NativeIndexConfigurationPropertyAn implementation forCfnRetriever.NativeIndexConfigurationPropertyProvides information on how the retriever used for your Amazon Q Business application is configured.A builder forCfnRetriever.RetrieverConfigurationPropertyAn implementation forCfnRetriever.RetrieverConfigurationPropertyProperties for defining aCfnRetriever.A builder forCfnRetrieverPropsAn implementation forCfnRetrieverPropsCreates an Amazon Q Business web experience.The container for browser extension configuration for an Amazon Q Business web experience.A builder forCfnWebExperience.BrowserExtensionConfigurationPropertyAn implementation forCfnWebExperience.BrowserExtensionConfigurationPropertyA fluent builder forCfnWebExperience.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.A builder forCfnWebExperience.CustomizationConfigurationPropertyAn implementation forCfnWebExperience.CustomizationConfigurationPropertyProvides information about the identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.A builder forCfnWebExperience.IdentityProviderConfigurationPropertyAn implementation forCfnWebExperience.IdentityProviderConfigurationPropertyInformation about the OIDC-compliant identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.An implementation forCfnWebExperience.OpenIDConnectProviderConfigurationPropertyInformation about the SAML 2.0-compliant identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.A builder forCfnWebExperience.SamlProviderConfigurationPropertyAn implementation forCfnWebExperience.SamlProviderConfigurationPropertyProperties for defining aCfnWebExperience.A builder forCfnWebExperiencePropsAn implementation forCfnWebExperiencePropsA reference to a DataAccessor resource.A builder forDataAccessorReferenceAn implementation forDataAccessorReferenceA reference to a DataSource resource.A builder forDataSourceReferenceAn implementation forDataSourceReference(experimental) Indicates that this resource can be referenced as a Application.Internal default implementation forIApplicationRef.A proxy class which represents a concrete javascript instance of this type.(experimental) Indicates that this resource can be referenced as a DataAccessor.Internal default implementation forIDataAccessorRef.A proxy class which represents a concrete javascript instance of this type.(experimental) Indicates that this resource can be referenced as a DataSource.Internal default implementation forIDataSourceRef.A proxy class which represents a concrete javascript instance of this type.(experimental) Indicates that this resource can be referenced as a Index.Internal default implementation forIIndexRef.A proxy class which represents a concrete javascript instance of this type.A reference to a Index resource.A builder forIndexReferenceAn implementation forIndexReference(experimental) Indicates that this resource can be referenced as a Permission.Internal default implementation forIPermissionRef.A proxy class which represents a concrete javascript instance of this type.(experimental) Indicates that this resource can be referenced as a Plugin.Internal default implementation forIPluginRef.A proxy class which represents a concrete javascript instance of this type.(experimental) Indicates that this resource can be referenced as a Retriever.Internal default implementation forIRetrieverRef.A proxy class which represents a concrete javascript instance of this type.(experimental) Indicates that this resource can be referenced as a WebExperience.Internal default implementation forIWebExperienceRef.A proxy class which represents a concrete javascript instance of this type.A reference to a Permission resource.A builder forPermissionReferenceAn implementation forPermissionReferenceA reference to a Plugin resource.A builder forPluginReferenceAn implementation forPluginReferenceA reference to a Retriever resource.A builder forRetrieverReferenceAn implementation forRetrieverReferenceA reference to a WebExperience resource.A builder forWebExperienceReferenceAn implementation forWebExperienceReference