interface CfnWebExperienceProps

Language	Type name
.NET	Amazon.CDK.aws_qbusiness.CfnWebExperienceProps
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsqbusiness#CfnWebExperienceProps
Java	software.amazon.awscdk.services.qbusiness.CfnWebExperienceProps
Python	aws_cdk.aws_qbusiness.CfnWebExperienceProps
TypeScript	aws-cdk-lib » aws_qbusiness » CfnWebExperienceProps

Properties for defining a CfnWebExperience.

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_qbusiness as qbusiness } from 'aws-cdk-lib';
const cfnWebExperienceProps: qbusiness.CfnWebExperienceProps = {
  applicationId: 'applicationId',

  // the properties below are optional
  roleArn: 'roleArn',
  samplePromptsControlMode: 'samplePromptsControlMode',
  subtitle: 'subtitle',
  tags: [{
    key: 'key',
    value: 'value',
  }],
  title: 'title',
  welcomeMessage: 'welcomeMessage',
};

Properties

Name	Type	Description
applicationId	string	The identifier of the Amazon Q Business web experience.
roleArn?	string	The Amazon Resource Name (ARN) of the service role attached to your web experience.
samplePromptsControlMode?	string	Determines whether sample prompts are enabled in the web experience for an end user.
subtitle?	string	A subtitle to personalize your Amazon Q Business web experience.
tags?	CfnTag[]	A list of key-value pairs that identify or categorize your Amazon Q Business web experience.
title?	string	The title for your Amazon Q Business web experience.
welcomeMessage?	string	A message in an Amazon Q Business web experience.

---

applicationId

Type: string

The identifier of the Amazon Q Business web experience.

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

---

roleArn?

Type: string (optional)

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

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

---

samplePromptsControlMode?

Type: string (optional)

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

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

---

subtitle?

Type: string (optional)

A subtitle to personalize your Amazon Q Business web experience.

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

---

tags?

Type: CfnTag[] (optional)

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 also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-webexperience.html#cfn-qbusiness-webexperience-tags

---

title?

Type: string (optional)

The title for your Amazon Q Business web experience.

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

---

welcomeMessage?

Type: string (optional)

A message in an Amazon Q Business web experience.

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