AWS::QBusiness::Application

Creates an Amazon Q Business application.

Note

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. You must use the Amazon Q Business console to assign subscription tiers to users.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::QBusiness::Application",
  "Properties" : {
      "AttachmentsConfiguration" : AttachmentsConfiguration,
      "AutoSubscriptionConfiguration" : AutoSubscriptionConfiguration,
      "ClientIdsForOIDC" : [ String, ... ],
      "Description" : String,
      "DisplayName" : String,
      "EncryptionConfiguration" : EncryptionConfiguration,
      "IamIdentityProviderArn" : String,
      "IdentityCenterInstanceArn" : String,
      "IdentityType" : String,
      "PersonalizationConfiguration" : PersonalizationConfiguration,
      "QAppsConfiguration" : QAppsConfiguration,
      "RoleArn" : String,
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::QBusiness::Application
Properties:
  AttachmentsConfiguration: 
    AttachmentsConfiguration
  AutoSubscriptionConfiguration: 
    AutoSubscriptionConfiguration
  ClientIdsForOIDC: 
    - String
  Description: String
  DisplayName: String
  EncryptionConfiguration: 
    EncryptionConfiguration
  IamIdentityProviderArn: String
  IdentityCenterInstanceArn: String
  IdentityType: String
  PersonalizationConfiguration: 
    PersonalizationConfiguration
  QAppsConfiguration: 
    QAppsConfiguration
  RoleArn: String
  Tags: 
    - Tag

Properties

AttachmentsConfiguration

Configuration information for the file upload during chat feature.

Required: No

Type: AttachmentsConfiguration

Update requires: No interruption

AutoSubscriptionConfiguration

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

Required: No

Type: AutoSubscriptionConfiguration

Update requires: No interruption

ClientIdsForOIDC

Property description not available.

Required: No

Type: Array of String

Minimum: 1

Maximum: 255

Update requires: Replacement

Description

A description for the Amazon Q Business application.

Required: No

Type: String

Pattern: ^[\s\S]*$

Minimum: 0

Maximum: 1000

Update requires: No interruption

DisplayName

The name of the Amazon Q Business application.

Required: Yes

Type: String

Pattern: ^[a-zA-Z0-9][a-zA-Z0-9_-]*$

Minimum: 1

Maximum: 1000

Update requires: No interruption

EncryptionConfiguration

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

Required: No

Type: EncryptionConfiguration

Update requires: Replacement

IamIdentityProviderArn

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

Required: No

Type: String

Pattern: ^arn:aws:iam::\d{12}:(oidc-provider|saml-provider)/[a-zA-Z0-9_\.\/@\-]+$

Minimum: 20

Maximum: 2048

Update requires: Replacement

IdentityCenterInstanceArn

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

Required: Conditional

Type: String

Pattern: ^arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso:::instance/(sso)?ins-[a-zA-Z0-9-.]{16}$

Minimum: 10

Maximum: 1224

Update requires: No interruption

IdentityType

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

Required: No

Type: String

Allowed values: AWS_IAM_IDP_SAML | AWS_IAM_IDP_OIDC | AWS_IAM_IDC

Update requires: Replacement

PersonalizationConfiguration

Configuration information about chat response personalization. For more information, see Personalizing chat responses.

Required: No

Type: PersonalizationConfiguration

Update requires: No interruption

QAppsConfiguration

Configuration information about Amazon Q Apps.

Required: No

Type: QAppsConfiguration

Update requires: No interruption

RoleArn

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) and use it as the application's role.

Required: No

Type: String

Pattern: ^arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}$

Minimum: 0

Maximum: 1284

Update requires: No interruption

Tags

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: _ . : / = + - @.

Required: No

Type: Array of Tag

Minimum: 0

Maximum: 200

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the application ID. For example:

{"Ref": "ApplicationId"}

For more information about using the Ref function, see Ref.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

ApplicationArn

The Amazon Resource Name (ARN) of the Amazon Q Business application.

ApplicationId

The identifier for the Amazon Q Business application.

CreatedAt

The Unix timestamp when the Amazon Q Business application was created.

IdentityCenterApplicationArn

The Amazon Resource Name (ARN) of the AWS IAM Identity Center instance attached to your Amazon Q Business application.

Status

The status of the Amazon Q Business application. The application is ready to use when the status is ACTIVE.

UpdatedAt

The Unix timestamp when the Amazon Q Business application was last updated.