Interface CfnWebExperienceProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnWebExperienceProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.102.0 (build e354887)",
date="2024-08-23T05:56:20.477Z")
@Stability(Stable)
public interface CfnWebExperienceProps
extends software.amazon.jsii.JsiiSerializable
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 software.amazon.awscdk.services.qbusiness.*; CfnWebExperienceProps cfnWebExperienceProps = CfnWebExperienceProps.builder() .applicationId("applicationId") // the properties below are optional .roleArn("roleArn") .samplePromptsControlMode("samplePromptsControlMode") .subtitle("subtitle") .tags(List.of(CfnTag.builder() .key("key") .value("value") .build())) .title("title") .welcomeMessage("welcomeMessage") .build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final class
A builder forCfnWebExperienceProps
static final class
An implementation forCfnWebExperienceProps
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
The identifier of the Amazon Q Business web experience.default String
The Amazon Resource Name (ARN) of the service role attached to your web experience.default String
Determines whether sample prompts are enabled in the web experience for an end user.default String
A subtitle to personalize your Amazon Q Business web experience.getTags()
A list of key-value pairs that identify or categorize your Amazon Q Business web experience.default String
getTitle()
The title for your Amazon Q Business web experience.default String
A message in an Amazon Q Business web experience.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getApplicationId
The identifier of the Amazon Q Business web experience.- See Also:
-
getRoleArn
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 Also:
-
getSamplePromptsControlMode
Determines whether sample prompts are enabled in the web experience for an end user.- See Also:
-
getSubtitle
A subtitle to personalize your Amazon Q Business web experience.- See Also:
-
getTags
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:
-
getTitle
The title for your Amazon Q Business web experience.- See Also:
-
getWelcomeMessage
A message in an Amazon Q Business web experience.- See Also:
-
builder
- Returns:
- a
CfnWebExperienceProps.Builder
ofCfnWebExperienceProps
-