CfnWebExperienceProps

class aws_cdk.aws_qbusiness.CfnWebExperienceProps(*, application_id, browser_extension_configuration=None, customization_configuration=None, identity_provider_configuration=None, origins=None, role_arn=None, sample_prompts_control_mode=None, subtitle=None, tags=None, title=None, welcome_message=None)

Bases: object

Properties for defining a CfnWebExperience.

Parameters:

application_id (str) – The identifier of the Amazon Q Business web experience.
browser_extension_configuration (Union[IResolvable, BrowserExtensionConfigurationProperty, Dict[str, Any], None]) – The container for browser extension configuration for an Amazon Q Business web experience.
customization_configuration (Union[IResolvable, CustomizationConfigurationProperty, Dict[str, Any], None]) – Contains the configuration information to customize the logo, font, and color of an Amazon Q Business web experience with individual files for each property or a CSS file for them all.
identity_provider_configuration (Union[IResolvable, IdentityProviderConfigurationProperty, Dict[str, Any], None]) – Provides information about the identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.
origins (Optional[Sequence[str]]) – Sets the website domain origins that are allowed to embed the Amazon Q Business web experience. The domain origin refers to the base URL for accessing a website including the protocol ( http/https ), the domain name, and the port number (if specified). .. epigraph:: You must only submit a base URL and not a full path. For example, https://docs.aws.amazon.com .
role_arn (Optional[str]) – The Amazon Resource Name (ARN) of the service role attached to your web experience. .. epigraph:: You must provide this value if you’re using IAM Identity Center to manage end user access to your application. If you’re using legacy identity management to manage user access, you don’t need to provide this value.
sample_prompts_control_mode (Optional[str]) – Determines whether sample prompts are enabled in the web experience for an end user.
subtitle (Optional[str]) – A subtitle to personalize your Amazon Q Business web experience.
tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – A list of key-value pairs that identify or categorize your Amazon Q Business web experience. You can also use tags to help control access to the web experience. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + -
title (Optional[str]) – The title for your Amazon Q Business web experience.
welcome_message (Optional[str]) – A message in an Amazon Q Business web experience.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-webexperience.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_web_experience_props = qbusiness.CfnWebExperienceProps(
    application_id="applicationId",

    # the properties below are optional
    browser_extension_configuration=qbusiness.CfnWebExperience.BrowserExtensionConfigurationProperty(
        enabled_browser_extensions=["enabledBrowserExtensions"]
    ),
    customization_configuration=qbusiness.CfnWebExperience.CustomizationConfigurationProperty(
        custom_css_url="customCssUrl",
        favicon_url="faviconUrl",
        font_url="fontUrl",
        logo_url="logoUrl"
    ),
    identity_provider_configuration=qbusiness.CfnWebExperience.IdentityProviderConfigurationProperty(
        open_id_connect_configuration=qbusiness.CfnWebExperience.OpenIDConnectProviderConfigurationProperty(
            secrets_arn="secretsArn",
            secrets_role="secretsRole"
        ),
        saml_configuration=qbusiness.CfnWebExperience.SamlProviderConfigurationProperty(
            authentication_url="authenticationUrl"
        )
    ),
    origins=["origins"],
    role_arn="roleArn",
    sample_prompts_control_mode="samplePromptsControlMode",
    subtitle="subtitle",
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    title="title",
    welcome_message="welcomeMessage"
)

Attributes

application_id

The identifier of the Amazon Q Business web experience.

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

browser_extension_configuration

The container for browser extension configuration for an Amazon Q Business web experience.

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

customization_configuration

Contains the configuration information to customize the logo, font, and color of an Amazon Q Business web experience with individual files for each property or a CSS file for them all.

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

identity_provider_configuration

Provides information about the identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.

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

origins

Sets the website domain origins that are allowed to embed the Amazon Q Business web experience.

The domain origin refers to the base URL for accessing a website including the protocol ( http/https ), the domain name, and the port number (if specified). .. epigraph:

You must only submit a *base URL* and not a full path. For example, ``https://docs.aws.amazon.com`` .

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

role_arn

The Amazon Resource Name (ARN) of the service role attached to your web experience.

You must provide this value if you’re using IAM Identity Center to manage end user access to your application. If you’re using legacy identity management to manage user access, you don’t need to provide this value.

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

sample_prompts_control_mode

Determines whether sample prompts are enabled in the web experience for an end user.

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

subtitle

A subtitle to personalize your Amazon Q Business web experience.

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

tags

A list of key-value pairs that identify or categorize your Amazon Q Business web experience.

You can also use tags to help control access to the web experience. 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-webexperience.html#cfn-qbusiness-webexperience-tags

:: .

title

The title for your Amazon Q Business web experience.

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

welcome_message

A message in an Amazon Q Business web experience.

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