CfnWebExperiencePropsMixin

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

Bases: Mixin

Creates an Amazon Q Business web experience.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-webexperience.html
CloudformationResource:: AWS::QBusiness::WebExperience
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_web_experience_props_mixin = qbusiness_mixins.CfnWebExperiencePropsMixin(qbusiness_mixins.CfnWebExperienceMixinProps(
    application_id="applicationId",
    browser_extension_configuration=qbusiness_mixins.CfnWebExperiencePropsMixin.BrowserExtensionConfigurationProperty(
        enabled_browser_extensions=["enabledBrowserExtensions"]
    ),
    customization_configuration=qbusiness_mixins.CfnWebExperiencePropsMixin.CustomizationConfigurationProperty(
        custom_css_url="customCssUrl",
        favicon_url="faviconUrl",
        font_url="fontUrl",
        logo_url="logoUrl"
    ),
    identity_provider_configuration=qbusiness_mixins.CfnWebExperiencePropsMixin.IdentityProviderConfigurationProperty(
        open_id_connect_configuration=qbusiness_mixins.CfnWebExperiencePropsMixin.OpenIDConnectProviderConfigurationProperty(
            secrets_arn="secretsArn",
            secrets_role="secretsRole"
        ),
        saml_configuration=qbusiness_mixins.CfnWebExperiencePropsMixin.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"
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

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

Parameters:

props (Union[CfnWebExperienceMixinProps, 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 = ['applicationId', 'browserExtensionConfiguration', 'customizationConfiguration', 'identityProviderConfiguration', 'origins', 'roleArn', 'samplePromptsControlMode', 'subtitle', 'tags', 'title', 'welcomeMessage']

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

BrowserExtensionConfigurationProperty

class CfnWebExperiencePropsMixin.BrowserExtensionConfigurationProperty(*, enabled_browser_extensions=None)

Bases: object

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

Parameters:: enabled_browser_extensions (Optional[Sequence[str]]) – Specify the browser extensions allowed for your Amazon Q web experience. - CHROME — Enables the extension for Chromium-based browsers (Google Chrome, Microsoft Edge, Opera, etc.). - FIREFOX — Enables the extension for Mozilla Firefox. - CHROME and FIREFOX — Enable the extension for Chromium-based browsers and Mozilla Firefox.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-webexperience-browserextensionconfiguration.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

browser_extension_configuration_property = qbusiness_mixins.CfnWebExperiencePropsMixin.BrowserExtensionConfigurationProperty(
    enabled_browser_extensions=["enabledBrowserExtensions"]
)

Attributes

enabled_browser_extensions

Specify the browser extensions allowed for your Amazon Q web experience.

CHROME — Enables the extension for Chromium-based browsers (Google Chrome, Microsoft Edge, Opera, etc.).
FIREFOX — Enables the extension for Mozilla Firefox.
CHROME and FIREFOX — Enable the extension for Chromium-based browsers and Mozilla Firefox.

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

CustomizationConfigurationProperty

class CfnWebExperiencePropsMixin.CustomizationConfigurationProperty(*, custom_css_url=None, favicon_url=None, font_url=None, logo_url=None)

Bases: object

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.

Parameters:

custom_css_url (Optional[str]) – Provides the URL where the custom CSS file is hosted for an Amazon Q web experience.
favicon_url (Optional[str]) – Provides the URL where the custom favicon file is hosted for an Amazon Q web experience.
font_url (Optional[str]) – Provides the URL where the custom font file is hosted for an Amazon Q web experience.
logo_url (Optional[str]) – Provides the URL where the custom logo file is hosted for an Amazon Q web experience.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-webexperience-customizationconfiguration.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

customization_configuration_property = qbusiness_mixins.CfnWebExperiencePropsMixin.CustomizationConfigurationProperty(
    custom_css_url="customCssUrl",
    favicon_url="faviconUrl",
    font_url="fontUrl",
    logo_url="logoUrl"
)

Attributes

custom_css_url

Provides the URL where the custom CSS file is hosted for an Amazon Q web experience.

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

favicon_url

Provides the URL where the custom favicon file is hosted for an Amazon Q web experience.

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

font_url

Provides the URL where the custom font file is hosted for an Amazon Q web experience.

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

logo_url

Provides the URL where the custom logo file is hosted for an Amazon Q web experience.

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

IdentityProviderConfigurationProperty

class CfnWebExperiencePropsMixin.IdentityProviderConfigurationProperty(*, open_id_connect_configuration=None, saml_configuration=None)

Bases: object

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

Parameters:

open_id_connect_configuration (Union[IResolvable, OpenIDConnectProviderConfigurationProperty, Dict[str, Any], None]) – The OIDC-compliant identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.
saml_configuration (Union[IResolvable, SamlProviderConfigurationProperty, Dict[str, Any], None]) – The SAML 2.0-compliant 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-properties-qbusiness-webexperience-identityproviderconfiguration.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

identity_provider_configuration_property = qbusiness_mixins.CfnWebExperiencePropsMixin.IdentityProviderConfigurationProperty(
    open_id_connect_configuration=qbusiness_mixins.CfnWebExperiencePropsMixin.OpenIDConnectProviderConfigurationProperty(
        secrets_arn="secretsArn",
        secrets_role="secretsRole"
    ),
    saml_configuration=qbusiness_mixins.CfnWebExperiencePropsMixin.SamlProviderConfigurationProperty(
        authentication_url="authenticationUrl"
    )
)

Attributes

open_id_connect_configuration

The OIDC-compliant 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-properties-qbusiness-webexperience-identityproviderconfiguration.html#cfn-qbusiness-webexperience-identityproviderconfiguration-openidconnectconfiguration

saml_configuration

The SAML 2.0-compliant 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-properties-qbusiness-webexperience-identityproviderconfiguration.html#cfn-qbusiness-webexperience-identityproviderconfiguration-samlconfiguration

OpenIDConnectProviderConfigurationProperty

class CfnWebExperiencePropsMixin.OpenIDConnectProviderConfigurationProperty(*, secrets_arn=None, secrets_role=None)

Bases: object

Information about the OIDC-compliant identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.

Parameters:

secrets_arn (Optional[str]) – The Amazon Resource Name (ARN) of a Secrets Manager secret containing the OIDC client secret.
secrets_role (Optional[str]) – An IAM role with permissions to access AWS to decrypt the Secrets Manager secret containing your OIDC client secret.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-webexperience-openidconnectproviderconfiguration.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

open_iDConnect_provider_configuration_property = qbusiness_mixins.CfnWebExperiencePropsMixin.OpenIDConnectProviderConfigurationProperty(
    secrets_arn="secretsArn",
    secrets_role="secretsRole"
)

Attributes

secrets_arn

The Amazon Resource Name (ARN) of a Secrets Manager secret containing the OIDC client secret.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-webexperience-openidconnectproviderconfiguration.html#cfn-qbusiness-webexperience-openidconnectproviderconfiguration-secretsarn

secrets_role

An IAM role with permissions to access AWS to decrypt the Secrets Manager secret containing your OIDC client secret.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-webexperience-openidconnectproviderconfiguration.html#cfn-qbusiness-webexperience-openidconnectproviderconfiguration-secretsrole

SamlProviderConfigurationProperty

class CfnWebExperiencePropsMixin.SamlProviderConfigurationProperty(*, authentication_url=None)

Bases: object

Information about the SAML 2.0-compliant identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.

Parameters:: authentication_url (Optional[str]) – The URL where Amazon Q Business end users will be redirected for authentication.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-webexperience-samlproviderconfiguration.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

saml_provider_configuration_property = qbusiness_mixins.CfnWebExperiencePropsMixin.SamlProviderConfigurationProperty(
    authentication_url="authenticationUrl"
)

Attributes

authentication_url

The URL where Amazon Q Business end users will be redirected for authentication.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-webexperience-samlproviderconfiguration.html#cfn-qbusiness-webexperience-samlproviderconfiguration-authenticationurl