CfnApplicationProps

class aws_cdk.aws_qbusiness.CfnApplicationProps(*, display_name, attachments_configuration=None, auto_subscription_configuration=None, client_ids_for_oidc=None, description=None, encryption_configuration=None, iam_identity_provider_arn=None, identity_center_instance_arn=None, identity_type=None, personalization_configuration=None, q_apps_configuration=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.
auto_subscription_configuration (Union[IResolvable, AutoSubscriptionConfigurationProperty, Dict[str, Any], None]) – Subscription configuration information for an Amazon Q Business application using IAM identity federation for user management.
client_ids_for_oidc (Optional[Sequence[str]]) –
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.
iam_identity_provider_arn (Optional[str]) – The Amazon Resource Name (ARN) of an identity provider being used by an Amazon Q Business application.
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
identity_type (Optional[str]) – The authentication type being used by a Amazon Q Business application.
personalization_configuration (Union[IResolvable, PersonalizationConfigurationProperty, Dict[str, Any], None]) – Configuration information about chat response personalization. For more information, see Personalizing chat responses .
q_apps_configuration (Union[IResolvable, QAppsConfigurationProperty, Dict[str, Any], None]) – Configuration information about Amazon Q Apps.
role_arn (Optional[str]) – 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 (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"
    ),
    auto_subscription_configuration=qbusiness.CfnApplication.AutoSubscriptionConfigurationProperty(
        auto_subscribe="autoSubscribe",

        # the properties below are optional
        default_subscription_type="defaultSubscriptionType"
    ),
    client_ids_for_oidc=["clientIdsForOidc"],
    description="description",
    encryption_configuration=qbusiness.CfnApplication.EncryptionConfigurationProperty(
        kms_key_id="kmsKeyId"
    ),
    iam_identity_provider_arn="iamIdentityProviderArn",
    identity_center_instance_arn="identityCenterInstanceArn",
    identity_type="identityType",
    personalization_configuration=qbusiness.CfnApplication.PersonalizationConfigurationProperty(
        personalization_control_mode="personalizationControlMode"
    ),
    q_apps_configuration=qbusiness.CfnApplication.QAppsConfigurationProperty(
        q_apps_control_mode="qAppsControlMode"
    ),
    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

auto_subscription_configuration

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

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

client_ids_for_oidc

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

Type:: see

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

iam_identity_provider_arn

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

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

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

identity_type

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

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

personalization_configuration

Configuration information about chat response personalization.

For more information, see Personalizing chat responses .

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

q_apps_configuration

Configuration information about Amazon Q Apps.

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

role_arn

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.

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

:: .