CfnApplicationProps

class aws_cdk.aws_qbusiness.CfnApplicationProps(*, display_name, attachments_configuration=None, description=None, encryption_configuration=None, identity_center_instance_arn=None, role_arn=None, tags=None)

Bases: object

Properties for defining a CfnApplication.

Parameters:

• display_name (str) – The name of the Amazon Q Business application.

• attachments_configuration (Union[IResolvable, AttachmentsConfigurationProperty, Dict[str, Any], None]) – Configuration information for the file upload during chat feature.

• description (Optional[str]) – A description for the Amazon Q Business application.

• encryption_configuration (Union[IResolvable, EncryptionConfigurationProperty, Dict[str, Any], None]) – 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.

• identity_center_instance_arn (Optional[str]) – 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

• role_arn (Optional[str]) – The Amazon Resource Name (ARN) of an IAM role with permissions to access your Amazon CloudWatch logs and metrics.

• tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – 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: _ . : / = + -

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-application.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_qbusiness as qbusiness

cfn_application_props = qbusiness.CfnApplicationProps(
    display_name="displayName",

    # the properties below are optional
    attachments_configuration=qbusiness.CfnApplication.AttachmentsConfigurationProperty(
        attachments_control_mode="attachmentsControlMode"
    ),
    description="description",
    encryption_configuration=qbusiness.CfnApplication.EncryptionConfigurationProperty(
        kms_key_id="kmsKeyId"
    ),
    identity_center_instance_arn="identityCenterInstanceArn",
    role_arn="roleArn",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

attachments_configuration

Configuration information for the file upload during chat feature.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-application.html#cfn-qbusiness-application-attachmentsconfiguration

description

A description for the Amazon Q Business application.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-application.html#cfn-qbusiness-application-description

display_name

The name of the Amazon Q Business application.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-application.html#cfn-qbusiness-application-displayname

encryption_configuration

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.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-application.html#cfn-qbusiness-application-encryptionconfiguration

identity_center_instance_arn

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

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-application.html#cfn-qbusiness-application-identitycenterinstancearn

role_arn

The Amazon Resource Name (ARN) of an IAM role with permissions to access your Amazon CloudWatch logs and metrics.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-application.html#cfn-qbusiness-application-rolearn

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

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-application.html#cfn-qbusiness-application-tags

:: .