Package software.amazon.awscdk.services.qbusiness

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:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnWebExperienceProps.Builder	A builder for CfnWebExperienceProps
static final class	CfnWebExperienceProps.Jsii$Proxy	An implementation for CfnWebExperienceProps

Method Summary

Modifier and Type	Method	Description
static CfnWebExperienceProps.Builder	builder()
String	getApplicationId()	The identifier of the Amazon Q Business web experience.
default String	getRoleArn()	The Amazon Resource Name (ARN) of the service role attached to your web experience.
default String	getSamplePromptsControlMode()	Determines whether sample prompts are enabled in the web experience for an end user.
default String	getSubtitle()	A subtitle to personalize your Amazon Q Business web experience.
default List<CfnTag>	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	getWelcomeMessage()	A message in an Amazon Q Business web experience.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getApplicationId

@Stability(Stable)
@NotNull
String getApplicationId()

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

getRoleArn

@Stability(Stable)
@Nullable
default String 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:

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

getSamplePromptsControlMode

@Stability(Stable)
@Nullable
default String getSamplePromptsControlMode()

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

getSubtitle

@Stability(Stable)
@Nullable
default String getSubtitle()

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

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> 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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-webexperience.html#cfn-qbusiness-webexperience-tags

getTitle

@Stability(Stable)
@Nullable
default String getTitle()

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

getWelcomeMessage

@Stability(Stable)
@Nullable
default String getWelcomeMessage()

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

builder

@Stability(Stable)
static CfnWebExperienceProps.Builder builder()

Returns:

a CfnWebExperienceProps.Builder of CfnWebExperienceProps