Class CfnWebExperienceProps.Builder
java.lang.Object
software.amazon.awscdk.services.qbusiness.CfnWebExperienceProps.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnWebExperienceProps>
- Enclosing interface:
CfnWebExperienceProps
@Stability(Stable)
public static final class CfnWebExperienceProps.Builder
extends Object
implements software.amazon.jsii.Builder<CfnWebExperienceProps>
A builder for
CfnWebExperienceProps
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionapplicationId
(String applicationId) Sets the value ofCfnWebExperienceProps.getApplicationId()
browserExtensionConfiguration
(IResolvable browserExtensionConfiguration) Sets the value ofCfnWebExperienceProps.getBrowserExtensionConfiguration()
browserExtensionConfiguration
(CfnWebExperience.BrowserExtensionConfigurationProperty browserExtensionConfiguration) Sets the value ofCfnWebExperienceProps.getBrowserExtensionConfiguration()
build()
Builds the configured instance.customizationConfiguration
(IResolvable customizationConfiguration) Sets the value ofCfnWebExperienceProps.getCustomizationConfiguration()
customizationConfiguration
(CfnWebExperience.CustomizationConfigurationProperty customizationConfiguration) Sets the value ofCfnWebExperienceProps.getCustomizationConfiguration()
identityProviderConfiguration
(IResolvable identityProviderConfiguration) Sets the value ofCfnWebExperienceProps.getIdentityProviderConfiguration()
identityProviderConfiguration
(CfnWebExperience.IdentityProviderConfigurationProperty identityProviderConfiguration) Sets the value ofCfnWebExperienceProps.getIdentityProviderConfiguration()
Sets the value ofCfnWebExperienceProps.getOrigins()
Sets the value ofCfnWebExperienceProps.getRoleArn()
samplePromptsControlMode
(String samplePromptsControlMode) Sets the value ofCfnWebExperienceProps.getSamplePromptsControlMode()
Sets the value ofCfnWebExperienceProps.getSubtitle()
Sets the value ofCfnWebExperienceProps.getTags()
Sets the value ofCfnWebExperienceProps.getTitle()
welcomeMessage
(String welcomeMessage) Sets the value ofCfnWebExperienceProps.getWelcomeMessage()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
applicationId
Sets the value ofCfnWebExperienceProps.getApplicationId()
- Parameters:
applicationId
- The identifier of the Amazon Q Business web experience. This parameter is required.- Returns:
this
-
browserExtensionConfiguration
@Stability(Stable) public CfnWebExperienceProps.Builder browserExtensionConfiguration(IResolvable browserExtensionConfiguration) Sets the value ofCfnWebExperienceProps.getBrowserExtensionConfiguration()
- Parameters:
browserExtensionConfiguration
- The container for browser extension configuration for an Amazon Q Business web experience.- Returns:
this
-
browserExtensionConfiguration
@Stability(Stable) public CfnWebExperienceProps.Builder browserExtensionConfiguration(CfnWebExperience.BrowserExtensionConfigurationProperty browserExtensionConfiguration) Sets the value ofCfnWebExperienceProps.getBrowserExtensionConfiguration()
- Parameters:
browserExtensionConfiguration
- The container for browser extension configuration for an Amazon Q Business web experience.- Returns:
this
-
customizationConfiguration
@Stability(Stable) public CfnWebExperienceProps.Builder customizationConfiguration(IResolvable customizationConfiguration) Sets the value ofCfnWebExperienceProps.getCustomizationConfiguration()
- Parameters:
customizationConfiguration
- 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:
this
-
customizationConfiguration
@Stability(Stable) public CfnWebExperienceProps.Builder customizationConfiguration(CfnWebExperience.CustomizationConfigurationProperty customizationConfiguration) Sets the value ofCfnWebExperienceProps.getCustomizationConfiguration()
- Parameters:
customizationConfiguration
- 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:
this
-
identityProviderConfiguration
@Stability(Stable) public CfnWebExperienceProps.Builder identityProviderConfiguration(IResolvable identityProviderConfiguration) Sets the value ofCfnWebExperienceProps.getIdentityProviderConfiguration()
- Parameters:
identityProviderConfiguration
- Provides information about the identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.- Returns:
this
-
identityProviderConfiguration
@Stability(Stable) public CfnWebExperienceProps.Builder identityProviderConfiguration(CfnWebExperience.IdentityProviderConfigurationProperty identityProviderConfiguration) Sets the value ofCfnWebExperienceProps.getIdentityProviderConfiguration()
- Parameters:
identityProviderConfiguration
- Provides information about the identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.- Returns:
this
-
origins
Sets the value ofCfnWebExperienceProps.getOrigins()
- Parameters:
origins
- Sets the website domain origins that are allowed to embed the Amazon Q Business web experience. The domain origin refers to the base URL for accessing a website including the protocol (http/https
), the domain name, and the port number (if specified).You must only submit a base URL and not a full path. For example,
https://docs.aws.amazon.com
.- Returns:
this
-
roleArn
Sets the value ofCfnWebExperienceProps.getRoleArn()
- Parameters:
roleArn
- 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.
- Returns:
this
-
samplePromptsControlMode
@Stability(Stable) public CfnWebExperienceProps.Builder samplePromptsControlMode(String samplePromptsControlMode) Sets the value ofCfnWebExperienceProps.getSamplePromptsControlMode()
- Parameters:
samplePromptsControlMode
- Determines whether sample prompts are enabled in the web experience for an end user.- Returns:
this
-
subtitle
Sets the value ofCfnWebExperienceProps.getSubtitle()
- Parameters:
subtitle
- A subtitle to personalize your Amazon Q Business web experience.- Returns:
this
-
tags
Sets the value ofCfnWebExperienceProps.getTags()
- Parameters:
tags
- 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: _ . : / = + -- Returns:
this
-
title
Sets the value ofCfnWebExperienceProps.getTitle()
- Parameters:
title
- The title for your Amazon Q Business web experience.- Returns:
this
-
welcomeMessage
Sets the value ofCfnWebExperienceProps.getWelcomeMessage()
- Parameters:
welcomeMessage
- A message in an Amazon Q Business web experience.- Returns:
this
-
build
Builds the configured instance.- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<CfnWebExperienceProps>
- Returns:
- a new instance of
CfnWebExperienceProps
- Throws:
NullPointerException
- if any required attribute was not provided
-