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
.
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 |
---|---|---|
application | string | The identifier of the Amazon Q Business web experience. |
role | string | The Amazon Resource Name (ARN) of the service role attached to your web experience. |
sample | 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? | Cfn [] | 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. |
welcome | string | A message in an Amazon Q Business web experience. |
applicationId
Type:
string
The identifier of the Amazon Q Business web experience.
roleArn?
Type:
string
(optional)
The Amazon Resource Name (ARN) of the service role attached to your web experience.
samplePromptsControlMode?
Type:
string
(optional)
Determines whether sample prompts are enabled in the web experience for an end user.
subtitle?
Type:
string
(optional)
A subtitle to personalize your Amazon Q Business web experience.
tags?
Type:
Cfn
[]
(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: _ . : / = + -
title?
Type:
string
(optional)
The title for your Amazon Q Business web experience.
welcomeMessage?
Type:
string
(optional)
A message in an Amazon Q Business web experience.