Package software.amazon.awscdk.services.qbusiness

Class CfnWebExperience

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.qbusiness.CfnWebExperience

All Implemented Interfaces:

IInspectable, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.101.0 (build b95fe5d)",
           date="2024-07-12T19:34:06.514Z")
@Stability(Stable)
public class CfnWebExperience
extends CfnResource
implements IInspectable, ITaggableV2

Creates an Amazon Q Business web experience.

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.*;
 CfnWebExperience cfnWebExperience = CfnWebExperience.Builder.create(this, "MyCfnWebExperience")
         .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	Class	Description
static final class	CfnWebExperience.Builder	A fluent builder for CfnWebExperience.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.ITaggableV2

ITaggableV2.Jsii$Default, ITaggableV2.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnWebExperience(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnWebExperience(software.amazon.jsii.JsiiObjectRef objRef)
	CfnWebExperience(software.constructs.Construct scope, String id, CfnWebExperienceProps props)

Method Summary

Modifier and Type	Method	Description
String	getApplicationId()	The identifier of the Amazon Q Business web experience.
String	getAttrCreatedAt()	The Unix timestamp when the Amazon Q Business application was last updated.
String	getAttrDefaultEndpoint()	The endpoint URLs for your Amazon Q Business web experience.
String	getAttrStatus()	The status of your Amazon Q Business web experience.
String	getAttrUpdatedAt()	The Unix timestamp when your Amazon Q Business web experience was updated.
String	getAttrWebExperienceArn()	The Amazon Resource Name (ARN) of an Amazon Q Business web experience.
String	getAttrWebExperienceId()	The identifier of your Amazon Q Business web experience.
TagManager	getCdkTagManager()	Tag Manager which manages the tags for this resource.
protected Map<String,Object>	getCfnProperties()
String	getRoleArn()	The Amazon Resource Name (ARN) of the service role attached to your web experience.
String	getSamplePromptsControlMode()	Determines whether sample prompts are enabled in the web experience for an end user.
String	getSubtitle()	A subtitle to personalize your Amazon Q Business web experience.
List<CfnTag>	getTags()	A list of key-value pairs that identify or categorize your Amazon Q Business web experience.
String	getTitle()	The title for your Amazon Q Business web experience.
String	getWelcomeMessage()	A message in an Amazon Q Business web experience.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setApplicationId(String value)	The identifier of the Amazon Q Business web experience.
void	setRoleArn(String value)	The Amazon Resource Name (ARN) of the service role attached to your web experience.
void	setSamplePromptsControlMode(String value)	Determines whether sample prompts are enabled in the web experience for an end user.
void	setSubtitle(String value)	A subtitle to personalize your Amazon Q Business web experience.
void	setTags(List<CfnTag> value)	A list of key-value pairs that identify or categorize your Amazon Q Business web experience.
void	setTitle(String value)	The title for your Amazon Q Business web experience.
void	setWelcomeMessage(String value)	A message in an Amazon Q Business web experience.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_RESOURCE_TYPE_NAME

@Stability(Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Details

CfnWebExperience

protected CfnWebExperience(software.amazon.jsii.JsiiObjectRef objRef)

CfnWebExperience

protected CfnWebExperience(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnWebExperience

@Stability(Stable)
public CfnWebExperience(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnWebExperienceProps props)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

props - Resource properties. This parameter is required.

Method Details

inspect

@Stability(Stable)
public void inspect(@NotNull
 TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> renderProperties(@NotNull
 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrCreatedAt

@Stability(Stable)
@NotNull
public String getAttrCreatedAt()

The Unix timestamp when the Amazon Q Business application was last updated.

getAttrDefaultEndpoint

@Stability(Stable)
@NotNull
public String getAttrDefaultEndpoint()

The endpoint URLs for your Amazon Q Business web experience.

The URLs are unique and fully hosted by AWS .

getAttrStatus

@Stability(Stable)
@NotNull
public String getAttrStatus()

The status of your Amazon Q Business web experience.

getAttrUpdatedAt

@Stability(Stable)
@NotNull
public String getAttrUpdatedAt()

The Unix timestamp when your Amazon Q Business web experience was updated.

getAttrWebExperienceArn

@Stability(Stable)
@NotNull
public String getAttrWebExperienceArn()

The Amazon Resource Name (ARN) of an Amazon Q Business web experience.

getAttrWebExperienceId

@Stability(Stable)
@NotNull
public String getAttrWebExperienceId()

The identifier of your Amazon Q Business web experience.

getCdkTagManager

@Stability(Stable)
@NotNull
public TagManager getCdkTagManager()

Tag Manager which manages the tags for this resource.

Specified by:

getCdkTagManager in interface ITaggableV2

getCfnProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getApplicationId

@Stability(Stable)
@NotNull
public String getApplicationId()

The identifier of the Amazon Q Business web experience.

setApplicationId

@Stability(Stable)
public void setApplicationId(@NotNull
 String value)

The identifier of the Amazon Q Business web experience.

getRoleArn

@Stability(Stable)
@Nullable
public String getRoleArn()

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

setRoleArn

@Stability(Stable)
public void setRoleArn(@Nullable
 String value)

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

getSamplePromptsControlMode

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

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

setSamplePromptsControlMode

@Stability(Stable)
public void setSamplePromptsControlMode(@Nullable
 String value)

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

getSubtitle

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

A subtitle to personalize your Amazon Q Business web experience.

setSubtitle

@Stability(Stable)
public void setSubtitle(@Nullable
 String value)

A subtitle to personalize your Amazon Q Business web experience.

getTags

@Stability(Stable)
@Nullable
public List<CfnTag> getTags()

A list of key-value pairs that identify or categorize your Amazon Q Business web experience.

setTags

@Stability(Stable)
public void setTags(@Nullable
 List<CfnTag> value)

A list of key-value pairs that identify or categorize your Amazon Q Business web experience.

getTitle

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

The title for your Amazon Q Business web experience.

setTitle

@Stability(Stable)
public void setTitle(@Nullable
 String value)

The title for your Amazon Q Business web experience.

getWelcomeMessage

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

A message in an Amazon Q Business web experience.

setWelcomeMessage

@Stability(Stable)
public void setWelcomeMessage(@Nullable
 String value)

A message in an Amazon Q Business web experience.