interface CfnApplicationProps

Language	Type name
.NET	`Amazon.CDK.aws_qbusiness.CfnApplicationProps`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsqbusiness#CfnApplicationProps`
Java	`software.amazon.awscdk.services.qbusiness.CfnApplicationProps`
Python	`aws_cdk.aws_qbusiness.CfnApplicationProps`
TypeScript	`aws-cdk-lib` » `aws_qbusiness` » `CfnApplicationProps`

Properties for defining a CfnApplication.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_qbusiness as qbusiness } from 'aws-cdk-lib';
const cfnApplicationProps: qbusiness.CfnApplicationProps = {
  displayName: 'displayName',

  // the properties below are optional
  attachmentsConfiguration: {
    attachmentsControlMode: 'attachmentsControlMode',
  },
  autoSubscriptionConfiguration: {
    autoSubscribe: 'autoSubscribe',

    // the properties below are optional
    defaultSubscriptionType: 'defaultSubscriptionType',
  },
  clientIdsForOidc: ['clientIdsForOidc'],
  description: 'description',
  encryptionConfiguration: {
    kmsKeyId: 'kmsKeyId',
  },
  iamIdentityProviderArn: 'iamIdentityProviderArn',
  identityCenterInstanceArn: 'identityCenterInstanceArn',
  identityType: 'identityType',
  personalizationConfiguration: {
    personalizationControlMode: 'personalizationControlMode',
  },
  qAppsConfiguration: {
    qAppsControlMode: 'qAppsControlMode',
  },
  quickSightConfiguration: {
    clientNamespace: 'clientNamespace',
  },
  roleArn: 'roleArn',
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

Name	Type	Description
displayName	`string`	The name of the Amazon Q Business application.
attachmentsConfiguration?	`IResolvable` `\|` `AttachmentsConfigurationProperty`	Configuration information for the file upload during chat feature.
autoSubscriptionConfiguration?	`IResolvable` `\|` `AutoSubscriptionConfigurationProperty`	Subscription configuration information for an Amazon Q Business application using IAM identity federation for user management.
clientIdsForOidc?	`string[]`	The OIDC client ID for a Amazon Q Business application.
description?	`string`	A description for the Amazon Q Business application.
encryptionConfiguration?	`IResolvable` `\|` `EncryptionConfigurationProperty`	Provides the identifier of the AWS KMS key used to encrypt data indexed by Amazon Q Business.
iamIdentityProviderArn?	`string`	The Amazon Resource Name (ARN) of an identity provider being used by an Amazon Q Business application.
identityCenterInstanceArn?	`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.
identityType?	`string`	The authentication type being used by a Amazon Q Business application.
personalizationConfiguration?	`IResolvable` `\|` `PersonalizationConfigurationProperty`	Configuration information about chat response personalization.
qAppsConfiguration?	`IResolvable` `\|` `QAppsConfigurationProperty`	Configuration information about Amazon Q Apps.
quickSightConfiguration?	`IResolvable` `\|` `QuickSightConfigurationProperty`	The Amazon QuickSight configuration for an Amazon Q Business application that uses QuickSight as the identity provider.
roleArn?	`string`	The Amazon Resource Name (ARN) of an IAM role with permissions to access your Amazon CloudWatch logs and metrics.
tags?	`CfnTag[]`	A list of key-value pairs that identify or categorize your Amazon Q Business application.

displayName

Type: string

The name of the Amazon Q Business application.

attachmentsConfiguration?

Type: IResolvable | AttachmentsConfigurationProperty (optional)

Configuration information for the file upload during chat feature.

autoSubscriptionConfiguration?

Type: IResolvable | AutoSubscriptionConfigurationProperty (optional)

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

clientIdsForOidc?

Type: string[] (optional)

The OIDC client ID for a Amazon Q Business application.

description?

Type: string (optional)

A description for the Amazon Q Business application.

encryptionConfiguration?

Type: IResolvable | EncryptionConfigurationProperty (optional)

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.

iamIdentityProviderArn?

Type: string (optional)

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

identityCenterInstanceArn?

Type: string (optional)

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

identityType?

Type: string (optional)

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

personalizationConfiguration?

Type: IResolvable | PersonalizationConfigurationProperty (optional)

Configuration information about chat response personalization.

For more information, see Personalizing chat responses .

qAppsConfiguration?

Type: IResolvable | QAppsConfigurationProperty (optional)

Configuration information about Amazon Q Apps.

quickSightConfiguration?

Type: IResolvable | QuickSightConfigurationProperty (optional)

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

roleArn?

Type: string (optional)

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.

tags?

Type: CfnTag[] (optional)

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