CfnApplicationPropsMixin

class aws_cdk.mixins_preview.aws_qbusiness.mixins.CfnApplicationPropsMixin(props, *, strategy=None)

Bases: Mixin

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 . 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 .

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 .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-application.html
CloudformationResource:: AWS::QBusiness::Application
Mixin:: true
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.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_qbusiness import mixins as qbusiness_mixins

cfn_application_props_mixin = qbusiness_mixins.CfnApplicationPropsMixin(qbusiness_mixins.CfnApplicationMixinProps(
    attachments_configuration=qbusiness_mixins.CfnApplicationPropsMixin.AttachmentsConfigurationProperty(
        attachments_control_mode="attachmentsControlMode"
    ),
    auto_subscription_configuration=qbusiness_mixins.CfnApplicationPropsMixin.AutoSubscriptionConfigurationProperty(
        auto_subscribe="autoSubscribe",
        default_subscription_type="defaultSubscriptionType"
    ),
    client_ids_for_oidc=["clientIdsForOidc"],
    description="description",
    display_name="displayName",
    encryption_configuration=qbusiness_mixins.CfnApplicationPropsMixin.EncryptionConfigurationProperty(
        kms_key_id="kmsKeyId"
    ),
    iam_identity_provider_arn="iamIdentityProviderArn",
    identity_center_instance_arn="identityCenterInstanceArn",
    identity_type="identityType",
    personalization_configuration=qbusiness_mixins.CfnApplicationPropsMixin.PersonalizationConfigurationProperty(
        personalization_control_mode="personalizationControlMode"
    ),
    q_apps_configuration=qbusiness_mixins.CfnApplicationPropsMixin.QAppsConfigurationProperty(
        q_apps_control_mode="qAppsControlMode"
    ),
    quick_sight_configuration=qbusiness_mixins.CfnApplicationPropsMixin.QuickSightConfigurationProperty(
        client_namespace="clientNamespace"
    ),
    role_arn="roleArn",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::QBusiness::Application.

Parameters:

props (Union[CfnApplicationMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['attachmentsConfiguration', 'autoSubscriptionConfiguration', 'clientIdsForOidc', 'description', 'displayName', 'encryptionConfiguration', 'iamIdentityProviderArn', 'identityCenterInstanceArn', 'identityType', 'personalizationConfiguration', 'qAppsConfiguration', 'quickSightConfiguration', 'roleArn', 'tags']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

AttachmentsConfigurationProperty

class CfnApplicationPropsMixin.AttachmentsConfigurationProperty(*, attachments_control_mode=None)

Bases: object

Configuration information for the file upload during chat feature.

Parameters:: attachments_control_mode (Optional[str]) – Status information about whether file upload functionality is activated or deactivated for your end user.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-application-attachmentsconfiguration.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.mixins_preview.aws_qbusiness import mixins as qbusiness_mixins

attachments_configuration_property = qbusiness_mixins.CfnApplicationPropsMixin.AttachmentsConfigurationProperty(
    attachments_control_mode="attachmentsControlMode"
)

Attributes

attachments_control_mode

Status information about whether file upload functionality is activated or deactivated for your end user.

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

AutoSubscriptionConfigurationProperty

class CfnApplicationPropsMixin.AutoSubscriptionConfigurationProperty(*, auto_subscribe=None, default_subscription_type=None)

Bases: object

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

Parameters:

auto_subscribe (Optional[str]) – Describes whether automatic subscriptions are enabled for an Amazon Q Business application using IAM identity federation for user management.
default_subscription_type (Optional[str]) – Describes the default subscription type assigned to an Amazon Q Business application using IAM identity federation for user management. If the value for autoSubscribe is set to ENABLED you must select a value for this field.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-application-autosubscriptionconfiguration.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.mixins_preview.aws_qbusiness import mixins as qbusiness_mixins

auto_subscription_configuration_property = qbusiness_mixins.CfnApplicationPropsMixin.AutoSubscriptionConfigurationProperty(
    auto_subscribe="autoSubscribe",
    default_subscription_type="defaultSubscriptionType"
)

Attributes

auto_subscribe

Describes whether automatic subscriptions are enabled for an Amazon Q Business application using IAM identity federation for user management.

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

default_subscription_type

Describes the default subscription type assigned to an Amazon Q Business application using IAM identity federation for user management.

If the value for autoSubscribe is set to ENABLED you must select a value for this field.

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

EncryptionConfigurationProperty

class CfnApplicationPropsMixin.EncryptionConfigurationProperty(*, kms_key_id=None)

Bases: object

Provides the identifier of the AWS key used to encrypt data indexed by Amazon Q Business.

Amazon Q Business doesn’t support asymmetric keys.

Parameters:: kms_key_id (Optional[str]) – The identifier of the AWS key. Amazon Q Business doesn’t support asymmetric keys.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-application-encryptionconfiguration.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.mixins_preview.aws_qbusiness import mixins as qbusiness_mixins

encryption_configuration_property = qbusiness_mixins.CfnApplicationPropsMixin.EncryptionConfigurationProperty(
    kms_key_id="kmsKeyId"
)

Attributes

kms_key_id

The identifier of the AWS key.

Amazon Q Business doesn’t support asymmetric keys.

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

PersonalizationConfigurationProperty

class CfnApplicationPropsMixin.PersonalizationConfigurationProperty(*, personalization_control_mode=None)

Bases: object

Configuration information about chat response personalization.

For more information, see Personalizing chat responses .

Parameters:: personalization_control_mode (Optional[str]) – An option to allow Amazon Q Business to customize chat responses using user specific metadata—specifically, location and job information—in your IAM Identity Center instance.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-application-personalizationconfiguration.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.mixins_preview.aws_qbusiness import mixins as qbusiness_mixins

personalization_configuration_property = qbusiness_mixins.CfnApplicationPropsMixin.PersonalizationConfigurationProperty(
    personalization_control_mode="personalizationControlMode"
)

Attributes

personalization_control_mode

An option to allow Amazon Q Business to customize chat responses using user specific metadata—specifically, location and job information—in your IAM Identity Center instance.

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

QAppsConfigurationProperty

class CfnApplicationPropsMixin.QAppsConfigurationProperty(*, q_apps_control_mode=None)

Bases: object

Configuration information about Amazon Q Apps.

Parameters:: q_apps_control_mode (Optional[str]) – Status information about whether end users can create and use Amazon Q Apps in the web experience.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-application-qappsconfiguration.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.mixins_preview.aws_qbusiness import mixins as qbusiness_mixins

q_apps_configuration_property = qbusiness_mixins.CfnApplicationPropsMixin.QAppsConfigurationProperty(
    q_apps_control_mode="qAppsControlMode"
)

Attributes

q_apps_control_mode

Status information about whether end users can create and use Amazon Q Apps in the web experience.

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

QuickSightConfigurationProperty

class CfnApplicationPropsMixin.QuickSightConfigurationProperty(*, client_namespace=None)

Bases: object

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

For more information, see Creating an Amazon Quick Suite integrated application .

Parameters:: client_namespace (Optional[str]) – The Amazon Quick Suite namespace that is used as the identity provider. For more information about Quick Suite namespaces, see Namespace operations .
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-application-quicksightconfiguration.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.mixins_preview.aws_qbusiness import mixins as qbusiness_mixins

quick_sight_configuration_property = qbusiness_mixins.CfnApplicationPropsMixin.QuickSightConfigurationProperty(
    client_namespace="clientNamespace"
)

Attributes

client_namespace

The Amazon Quick Suite namespace that is used as the identity provider.

For more information about Quick Suite namespaces, see Namespace operations .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-application-quicksightconfiguration.html#cfn-qbusiness-application-quicksightconfiguration-clientnamespace