AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::QBusiness::WebExperience

CfnWebExperience

Creates an Amazon Q Business web experience.

Import

import { CfnWebExperience } from 'aws-cdk-lib/aws-qbusiness';

Or use the module namespace:

import * as qbusiness from 'aws-cdk-lib/aws-qbusiness';
// qbusiness.CfnWebExperience

Properties

Configuration passed to the constructor as CfnWebExperienceProps.

applicationIdRequired
string

The identifier of the Amazon Q Business web experience.

browserExtensionConfigurationOptional
IResolvable | BrowserExtensionConfigurationProperty

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

customizationConfigurationOptional
IResolvable | CustomizationConfigurationProperty

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.

identityProviderConfigurationOptional
IResolvable | IdentityProviderConfigurationProperty

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

originsOptional
string[]

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). > You must only submit a *base URL* and not a full path. For example, `https://docs.aws.amazon.com` .

roleArnOptional
string

The Amazon Resource Name (ARN) of the service role attached to your web experience. > The `roleArn` parameter is required when your Amazon Q Business application is created with IAM Identity Center. It is not required for SAML-based applications.

samplePromptsControlModeOptional
string

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

subtitleOptional
string

A subtitle to personalize your Amazon Q Business web experience.

tagsOptional
CfnTag[]

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

titleOptional
string

The title for your Amazon Q Business web experience.

welcomeMessageOptional
string

A message in an Amazon Q Business web experience.

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

AWS::QBusiness::WebExperienceView in CloudFormation Explorer

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

LevelL1 (CloudFormation)
Moduleaws-qbusiness
CFN TypeAWS::QBusiness::WebExperience
Properties11

Related Constructs

Explore This Service

External Links