AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::QBusiness::Application

CfnApplication

Creates an Amazon Q Business application. > There are new tiers for Amazon Q Business. Not all features in Amazon Q Business Pro are also available in Amazon Q Business Lite. For information on what's included in Amazon Q Business Lite and what's included in Amazon Q Business Pro, see [Amazon Q Business tiers](https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/tiers.html#user-sub-tiers) . You must use the Amazon Q Business console to assign subscription tiers to users. > > An Amazon Q Apps service linked role will be created if it's absent in the AWS account when `QAppsConfiguration` is enabled in the request. For more information, see [Using service-linked roles for Q Apps](https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/using-service-linked-roles-qapps.html) . > > When you create an application, Amazon Q Business may securely transmit data for processing from your selected AWS region, but within your geography. For more information, see [Cross region inference in Amazon Q Business](https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/cross-region-inference.html) .

Import

import { CfnApplication } from 'aws-cdk-lib/aws-qbusiness';

Or use the module namespace:

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

Properties

Configuration passed to the constructor as CfnApplicationProps.

displayNameRequired
string

The name of the Amazon Q Business application.

attachmentsConfigurationOptional
IResolvable | AttachmentsConfigurationProperty

Configuration information for the file upload during chat feature.

autoSubscriptionConfigurationOptional
IResolvable | AutoSubscriptionConfigurationProperty

Subscription configuration information for an Amazon Q Business application using IAM identity federation for user management.

clientIdsForOidcOptional
string[]

The OIDC client ID for a Amazon Q Business application.

descriptionOptional
string

A description for the Amazon Q Business application.

encryptionConfigurationOptional
IResolvable | EncryptionConfigurationProperty

Provides the identifier of the AWS key used to encrypt data indexed by Amazon Q Business. Amazon Q Business doesn't support asymmetric keys.

iamIdentityProviderArnOptional
string

The Amazon Resource Name (ARN) of an identity provider being used by an Amazon Q Business application.

identityCenterInstanceArnOptional
string

The Amazon Resource Name (ARN) of the IAM Identity Center instance you are either creating for—or connecting to—your Amazon Q Business application. *Required* : `Yes`

identityTypeOptional
string

The authentication type being used by a Amazon Q Business application.

personalizationConfigurationOptional
IResolvable | PersonalizationConfigurationProperty

Configuration information about chat response personalization. For more information, see [Personalizing chat responses](https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/personalizing-chat-responses.html) .

qAppsConfigurationOptional
IResolvable | QAppsConfigurationProperty

Configuration information about Amazon Q Apps.

quickSightConfigurationOptional
IResolvable | QuickSightConfigurationProperty

The Amazon Quick Suite configuration for an Amazon Q Business application that uses Quick Suite as the identity provider.

roleArnOptional
string

The Amazon Resource Name (ARN) of an IAM role with permissions to access your Amazon CloudWatch logs and metrics. If this property is not specified, Amazon Q Business will create a [service linked role (SLR)](https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/using-service-linked-roles.html#slr-permissions) and use it as the application's role.

tagsOptional
CfnTag[]

A list of key-value pairs that identify or categorize your Amazon Q Business application. You can also use tags to help control access to the application. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + -

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

LevelL1 (CloudFormation)
Moduleaws-qbusiness
CFN TypeAWS::QBusiness::Application
Properties14

External Links