Package software.amazon.awscdk.cfnpropertymixins.services.qbusiness

Class CfnWebExperienceMixinProps.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.qbusiness.CfnWebExperienceMixinProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnWebExperienceMixinProps>

Enclosing interface:

CfnWebExperienceMixinProps

@Stability(Stable)
public static final class CfnWebExperienceMixinProps.Builder
extends Object
implements software.amazon.jsii.Builder<CfnWebExperienceMixinProps>

A builder for CfnWebExperienceMixinProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnWebExperienceMixinProps.Builder	applicationId(String applicationId)	Sets the value of CfnWebExperienceMixinProps.getApplicationId()
CfnWebExperienceMixinProps.Builder	browserExtensionConfiguration(CfnWebExperiencePropsMixin.BrowserExtensionConfigurationProperty browserExtensionConfiguration)	Sets the value of CfnWebExperienceMixinProps.getBrowserExtensionConfiguration()
CfnWebExperienceMixinProps.Builder	browserExtensionConfiguration(IResolvable browserExtensionConfiguration)	Sets the value of CfnWebExperienceMixinProps.getBrowserExtensionConfiguration()
CfnWebExperienceMixinProps	build()	Builds the configured instance.
CfnWebExperienceMixinProps.Builder	customizationConfiguration(CfnWebExperiencePropsMixin.CustomizationConfigurationProperty customizationConfiguration)	Sets the value of CfnWebExperienceMixinProps.getCustomizationConfiguration()
CfnWebExperienceMixinProps.Builder	customizationConfiguration(IResolvable customizationConfiguration)	Sets the value of CfnWebExperienceMixinProps.getCustomizationConfiguration()
CfnWebExperienceMixinProps.Builder	identityProviderConfiguration(CfnWebExperiencePropsMixin.IdentityProviderConfigurationProperty identityProviderConfiguration)	Sets the value of CfnWebExperienceMixinProps.getIdentityProviderConfiguration()
CfnWebExperienceMixinProps.Builder	identityProviderConfiguration(IResolvable identityProviderConfiguration)	Sets the value of CfnWebExperienceMixinProps.getIdentityProviderConfiguration()
CfnWebExperienceMixinProps.Builder	origins(List<String> origins)	Sets the value of CfnWebExperienceMixinProps.getOrigins()
CfnWebExperienceMixinProps.Builder	roleArn(String roleArn)	Sets the value of CfnWebExperienceMixinProps.getRoleArn()
CfnWebExperienceMixinProps.Builder	samplePromptsControlMode(String samplePromptsControlMode)	Sets the value of CfnWebExperienceMixinProps.getSamplePromptsControlMode()
CfnWebExperienceMixinProps.Builder	subtitle(String subtitle)	Sets the value of CfnWebExperienceMixinProps.getSubtitle()
CfnWebExperienceMixinProps.Builder	tags(List<? extends CfnTag> tags)	Sets the value of CfnWebExperienceMixinProps.getTags()
CfnWebExperienceMixinProps.Builder	title(String title)	Sets the value of CfnWebExperienceMixinProps.getTitle()
CfnWebExperienceMixinProps.Builder	welcomeMessage(String welcomeMessage)	Sets the value of CfnWebExperienceMixinProps.getWelcomeMessage()

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

applicationId

@Stability(Stable)
public CfnWebExperienceMixinProps.Builder applicationId(String applicationId)

Sets the value of CfnWebExperienceMixinProps.getApplicationId()

Parameters:

applicationId - The identifier of the Amazon Q Business web experience.

Returns:

this

browserExtensionConfiguration

@Stability(Stable)
public CfnWebExperienceMixinProps.Builder browserExtensionConfiguration(IResolvable browserExtensionConfiguration)

Sets the value of CfnWebExperienceMixinProps.getBrowserExtensionConfiguration()

Parameters:

browserExtensionConfiguration - The container for browser extension configuration for an Amazon Q Business web experience.

Returns:

this

browserExtensionConfiguration

@Stability(Stable)
public CfnWebExperienceMixinProps.Builder browserExtensionConfiguration(CfnWebExperiencePropsMixin.BrowserExtensionConfigurationProperty browserExtensionConfiguration)

Sets the value of CfnWebExperienceMixinProps.getBrowserExtensionConfiguration()

Parameters:

browserExtensionConfiguration - The container for browser extension configuration for an Amazon Q Business web experience.

Returns:

this

customizationConfiguration

@Stability(Stable)
public CfnWebExperienceMixinProps.Builder customizationConfiguration(IResolvable customizationConfiguration)

Sets the value of CfnWebExperienceMixinProps.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 CfnWebExperienceMixinProps.Builder customizationConfiguration(CfnWebExperiencePropsMixin.CustomizationConfigurationProperty customizationConfiguration)

Sets the value of CfnWebExperienceMixinProps.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 CfnWebExperienceMixinProps.Builder identityProviderConfiguration(IResolvable identityProviderConfiguration)

Sets the value of CfnWebExperienceMixinProps.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 CfnWebExperienceMixinProps.Builder identityProviderConfiguration(CfnWebExperiencePropsMixin.IdentityProviderConfigurationProperty identityProviderConfiguration)

Sets the value of CfnWebExperienceMixinProps.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

@Stability(Stable)
public CfnWebExperienceMixinProps.Builder origins(List<String> origins)

Sets the value of CfnWebExperienceMixinProps.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

@Stability(Stable)
public CfnWebExperienceMixinProps.Builder roleArn(String roleArn)

Sets the value of CfnWebExperienceMixinProps.getRoleArn()

Parameters:

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

The roleArn parameter is required when your Amazon Q Business application is created with IAM Identity Center. It is not required for SAML-based applications.

Returns:

this

samplePromptsControlMode

@Stability(Stable)
public CfnWebExperienceMixinProps.Builder samplePromptsControlMode(String samplePromptsControlMode)

Sets the value of CfnWebExperienceMixinProps.getSamplePromptsControlMode()

Parameters:

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

Returns:

this

subtitle

@Stability(Stable)
public CfnWebExperienceMixinProps.Builder subtitle(String subtitle)

Sets the value of CfnWebExperienceMixinProps.getSubtitle()

Parameters:

subtitle - A subtitle to personalize your Amazon Q Business web experience.

Returns:

this

tags

@Stability(Stable)
public CfnWebExperienceMixinProps.Builder tags(List<? extends CfnTag> tags)

Sets the value of CfnWebExperienceMixinProps.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

@Stability(Stable)
public CfnWebExperienceMixinProps.Builder title(String title)

Sets the value of CfnWebExperienceMixinProps.getTitle()

Parameters:

title - The title for your Amazon Q Business web experience.

Returns:

this

welcomeMessage

@Stability(Stable)
public CfnWebExperienceMixinProps.Builder welcomeMessage(String welcomeMessage)

Sets the value of CfnWebExperienceMixinProps.getWelcomeMessage()

Parameters:

welcomeMessage - A message in an Amazon Q Business web experience.

Returns:

this

build

@Stability(Stable)
public CfnWebExperienceMixinProps build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnWebExperienceMixinProps>

Returns:

a new instance of CfnWebExperienceMixinProps

Throws:

NullPointerException - if any required attribute was not provided