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, IEnvironmentAware, IWebExperienceRef, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)", date="2025-11-13T16:10:10.482Z") @Stability(Stable) public class CfnWebExperience extends CfnResource implements IInspectable, IWebExperienceRef, 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
         .browserExtensionConfiguration(BrowserExtensionConfigurationProperty.builder()
                 .enabledBrowserExtensions(List.of("enabledBrowserExtensions"))
                 .build())
         .customizationConfiguration(CustomizationConfigurationProperty.builder()
                 .customCssUrl("customCssUrl")
                 .faviconUrl("faviconUrl")
                 .fontUrl("fontUrl")
                 .logoUrl("logoUrl")
                 .build())
         .identityProviderConfiguration(IdentityProviderConfigurationProperty.builder()
                 .openIdConnectConfiguration(OpenIDConnectProviderConfigurationProperty.builder()
                         .secretsArn("secretsArn")
                         .secretsRole("secretsRole")
                         .build())
                 .samlConfiguration(SamlProviderConfigurationProperty.builder()
                         .authenticationUrl("authenticationUrl")
                         .build())
                 .build())
         .origins(List.of("origins"))
         .roleArn("roleArn")
         .samplePromptsControlMode("samplePromptsControlMode")
         .subtitle("subtitle")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .title("title")
         .welcomeMessage("welcomeMessage")
         .build();

See Also:

  • 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)
      Create a new AWS::QBusiness::WebExperience.

      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

    • getWebExperienceRef

      @Stability(Stable) @NotNull public WebExperienceReference getWebExperienceRef()
      A reference to a WebExperience resource.
      Specified by:
      getWebExperienceRef in interface IWebExperienceRef

    • 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.

    • getBrowserExtensionConfiguration

      @Stability(Stable) @Nullable public Object getBrowserExtensionConfiguration()
      The container for browser extension configuration for an Amazon Q Business web experience.

      Returns union: either IResolvable or CfnWebExperience.BrowserExtensionConfigurationProperty

    • setBrowserExtensionConfiguration

      @Stability(Stable) public void setBrowserExtensionConfiguration(@Nullable IResolvable value)
      The container for browser extension configuration for an Amazon Q Business web experience.

    • setBrowserExtensionConfiguration

      @Stability(Stable) public void setBrowserExtensionConfiguration(@Nullable CfnWebExperience.BrowserExtensionConfigurationProperty value)
      The container for browser extension configuration for an Amazon Q Business web experience.

    • getCustomizationConfiguration

      @Stability(Stable) @Nullable public Object getCustomizationConfiguration()
      Contains the configuration information to customize the logo, font, and color of an Amazon Q Business web experience with individual files for each property or a CSS file for them all.

      Returns union: either IResolvable or CfnWebExperience.CustomizationConfigurationProperty

    • setCustomizationConfiguration

      @Stability(Stable) public void setCustomizationConfiguration(@Nullable IResolvable value)
      Contains the configuration information to customize the logo, font, and color of an Amazon Q Business web experience with individual files for each property or a CSS file for them all.

    • setCustomizationConfiguration

      @Stability(Stable) public void setCustomizationConfiguration(@Nullable CfnWebExperience.CustomizationConfigurationProperty value)
      Contains the configuration information to customize the logo, font, and color of an Amazon Q Business web experience with individual files for each property or a CSS file for them all.

    • getIdentityProviderConfiguration

      @Stability(Stable) @Nullable public Object getIdentityProviderConfiguration()
      Provides information about the identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.

      Returns union: either IResolvable or CfnWebExperience.IdentityProviderConfigurationProperty

    • setIdentityProviderConfiguration

      @Stability(Stable) public void setIdentityProviderConfiguration(@Nullable IResolvable value)
      Provides information about the identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.

    • setIdentityProviderConfiguration

      @Stability(Stable) public void setIdentityProviderConfiguration(@Nullable CfnWebExperience.IdentityProviderConfigurationProperty value)
      Provides information about the identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.

    • getOrigins

      @Stability(Stable) @Nullable public List<String> getOrigins()
      Sets the website domain origins that are allowed to embed the Amazon Q Business web experience.

    • setOrigins

      @Stability(Stable) public void setOrigins(@Nullable List<String> value)
      Sets the website domain origins that are allowed to embed 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.