Class CfnWebExperience.Builder
java.lang.Object
software.amazon.awscdk.services.qbusiness.CfnWebExperience.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnWebExperience>
- Enclosing class:
CfnWebExperience
@Stability(Stable)
public static final class CfnWebExperience.Builder
extends Object
implements software.amazon.jsii.Builder<CfnWebExperience>
A fluent builder for
CfnWebExperience
.-
Method Summary
Modifier and TypeMethodDescriptionapplicationId
(String applicationId) The identifier of the Amazon Q Business web experience.browserExtensionConfiguration
(IResolvable browserExtensionConfiguration) The container for browser extension configuration for an Amazon Q Business web experience.browserExtensionConfiguration
(CfnWebExperience.BrowserExtensionConfigurationProperty browserExtensionConfiguration) The container for browser extension configuration for an Amazon Q Business web experience.build()
static CfnWebExperience.Builder
customizationConfiguration
(IResolvable 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.customizationConfiguration
(CfnWebExperience.CustomizationConfigurationProperty 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.identityProviderConfiguration
(IResolvable identityProviderConfiguration) Provides information about the identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.identityProviderConfiguration
(CfnWebExperience.IdentityProviderConfigurationProperty identityProviderConfiguration) Provides information about the identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.Sets the website domain origins that are allowed to embed the Amazon Q Business web experience.The Amazon Resource Name (ARN) of the service role attached to your web experience.samplePromptsControlMode
(String samplePromptsControlMode) Determines whether sample prompts are enabled in the web experience for an end user.A subtitle to personalize your Amazon Q Business web experience.A list of key-value pairs that identify or categorize your Amazon Q Business web experience.The title for your Amazon Q Business web experience.welcomeMessage
(String welcomeMessage) A message in an Amazon Q Business web experience.
-
Method Details
-
create
@Stability(Stable) public static CfnWebExperience.Builder create(software.constructs.Construct scope, String id) - 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.- Returns:
- a new instance of
CfnWebExperience.Builder
.
-
applicationId
The identifier of the Amazon Q Business web experience.- Parameters:
applicationId
- The identifier of the Amazon Q Business web experience. This parameter is required.- Returns:
this
- See Also:
-
browserExtensionConfiguration
@Stability(Stable) public CfnWebExperience.Builder browserExtensionConfiguration(IResolvable browserExtensionConfiguration) The container for browser extension configuration for an Amazon Q Business web experience.- Parameters:
browserExtensionConfiguration
- The container for browser extension configuration for an Amazon Q Business web experience. This parameter is required.- Returns:
this
- See Also:
-
browserExtensionConfiguration
@Stability(Stable) public CfnWebExperience.Builder browserExtensionConfiguration(CfnWebExperience.BrowserExtensionConfigurationProperty browserExtensionConfiguration) The container for browser extension configuration for an Amazon Q Business web experience.- Parameters:
browserExtensionConfiguration
- The container for browser extension configuration for an Amazon Q Business web experience. This parameter is required.- Returns:
this
- See Also:
-
customizationConfiguration
@Stability(Stable) public CfnWebExperience.Builder customizationConfiguration(IResolvable 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.- 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. This parameter is required.- Returns:
this
- See Also:
-
customizationConfiguration
@Stability(Stable) public CfnWebExperience.Builder customizationConfiguration(CfnWebExperience.CustomizationConfigurationProperty 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.- 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. This parameter is required.- Returns:
this
- See Also:
-
identityProviderConfiguration
@Stability(Stable) public CfnWebExperience.Builder identityProviderConfiguration(IResolvable identityProviderConfiguration) Provides information about the identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.- Parameters:
identityProviderConfiguration
- Provides information about the identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience. This parameter is required.- Returns:
this
- See Also:
-
identityProviderConfiguration
@Stability(Stable) public CfnWebExperience.Builder identityProviderConfiguration(CfnWebExperience.IdentityProviderConfigurationProperty identityProviderConfiguration) Provides information about the identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.- Parameters:
identityProviderConfiguration
- Provides information about the identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience. This parameter is required.- Returns:
this
- See Also:
-
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
.- Parameters:
origins
- Sets the website domain origins that are allowed to embed the Amazon Q Business web experience. This parameter is required.- Returns:
this
- See Also:
-
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.
- Parameters:
roleArn
- The Amazon Resource Name (ARN) of the service role attached to your web experience. This parameter is required.- Returns:
this
- See Also:
-
samplePromptsControlMode
@Stability(Stable) public CfnWebExperience.Builder samplePromptsControlMode(String samplePromptsControlMode) Determines whether sample prompts are enabled in the web experience for an end user.- Parameters:
samplePromptsControlMode
- Determines whether sample prompts are enabled in the web experience for an end user. This parameter is required.- Returns:
this
- See Also:
-
subtitle
A subtitle to personalize your Amazon Q Business web experience.- Parameters:
subtitle
- A subtitle to personalize your Amazon Q Business web experience. This parameter is required.- Returns:
this
- See Also:
-
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: _ . : / = + -
- Parameters:
tags
- A list of key-value pairs that identify or categorize your Amazon Q Business web experience. This parameter is required.- Returns:
this
- See Also:
-
title
The title for your Amazon Q Business web experience.- Parameters:
title
- The title for your Amazon Q Business web experience. This parameter is required.- Returns:
this
- See Also:
-
welcomeMessage
A message in an Amazon Q Business web experience.- Parameters:
welcomeMessage
- A message in an Amazon Q Business web experience. This parameter is required.- Returns:
this
- See Also:
-
build
- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<CfnWebExperience>
- Returns:
- a newly built instance of
CfnWebExperience
.
-