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

Class CfnWebExperiencePropsMixin.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnWebExperiencePropsMixin>

Enclosing class:

CfnWebExperiencePropsMixin

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

A fluent builder for CfnWebExperiencePropsMixin.

Method Summary

Modifier and Type	Method	Description
CfnWebExperiencePropsMixin.Builder	applicationId(String applicationId)	The identifier of the Amazon Q Business web experience.
CfnWebExperiencePropsMixin.Builder	browserExtensionConfiguration(CfnWebExperiencePropsMixin.BrowserExtensionConfigurationProperty browserExtensionConfiguration)	The container for browser extension configuration for an Amazon Q Business web experience.
CfnWebExperiencePropsMixin.Builder	browserExtensionConfiguration(IResolvable browserExtensionConfiguration)	The container for browser extension configuration for an Amazon Q Business web experience.
CfnWebExperiencePropsMixin	build()
static CfnWebExperiencePropsMixin.Builder	create()
static CfnWebExperiencePropsMixin.Builder	create(CfnPropertyMixinOptions options)
CfnWebExperiencePropsMixin.Builder	customizationConfiguration(CfnWebExperiencePropsMixin.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.
CfnWebExperiencePropsMixin.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.
CfnWebExperiencePropsMixin.Builder	identityProviderConfiguration(CfnWebExperiencePropsMixin.IdentityProviderConfigurationProperty identityProviderConfiguration)	Provides information about the identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.
CfnWebExperiencePropsMixin.Builder	identityProviderConfiguration(IResolvable identityProviderConfiguration)	Provides information about the identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.
CfnWebExperiencePropsMixin.Builder	origins(List<String> origins)	Sets the website domain origins that are allowed to embed the Amazon Q Business web experience.
CfnWebExperiencePropsMixin.Builder	roleArn(String roleArn)	The Amazon Resource Name (ARN) of the service role attached to your web experience.
CfnWebExperiencePropsMixin.Builder	samplePromptsControlMode(String samplePromptsControlMode)	Determines whether sample prompts are enabled in the web experience for an end user.
CfnWebExperiencePropsMixin.Builder	subtitle(String subtitle)	A subtitle to personalize your Amazon Q Business web experience.
CfnWebExperiencePropsMixin.Builder	tags(List<? extends CfnTag> tags)	A list of key-value pairs that identify or categorize your Amazon Q Business web experience.
CfnWebExperiencePropsMixin.Builder	title(String title)	The title for your Amazon Q Business web experience.
CfnWebExperiencePropsMixin.Builder	welcomeMessage(String welcomeMessage)	A message in an Amazon Q Business web experience.

Methods inherited from class java.lang.Object

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

Method Details

create

@Stability(Stable)
public static CfnWebExperiencePropsMixin.Builder create(CfnPropertyMixinOptions options)

Parameters:

options - Mixin options.

Returns:

a new instance of CfnWebExperiencePropsMixin.Builder.

create

@Stability(Stable)
public static CfnWebExperiencePropsMixin.Builder create()

Returns:

a new instance of CfnWebExperiencePropsMixin.Builder.

applicationId

@Stability(Stable)
public CfnWebExperiencePropsMixin.Builder applicationId(String 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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-webexperience.html#cfn-qbusiness-webexperience-applicationid

browserExtensionConfiguration

@Stability(Stable)
public CfnWebExperiencePropsMixin.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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-webexperience.html#cfn-qbusiness-webexperience-browserextensionconfiguration

browserExtensionConfiguration

@Stability(Stable)
public CfnWebExperiencePropsMixin.Builder browserExtensionConfiguration(CfnWebExperiencePropsMixin.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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-webexperience.html#cfn-qbusiness-webexperience-browserextensionconfiguration

customizationConfiguration

@Stability(Stable)
public CfnWebExperiencePropsMixin.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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-webexperience.html#cfn-qbusiness-webexperience-customizationconfiguration

customizationConfiguration

@Stability(Stable)
public CfnWebExperiencePropsMixin.Builder customizationConfiguration(CfnWebExperiencePropsMixin.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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-webexperience.html#cfn-qbusiness-webexperience-customizationconfiguration

identityProviderConfiguration

@Stability(Stable)
public CfnWebExperiencePropsMixin.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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-webexperience.html#cfn-qbusiness-webexperience-identityproviderconfiguration

identityProviderConfiguration

@Stability(Stable)
public CfnWebExperiencePropsMixin.Builder identityProviderConfiguration(CfnWebExperiencePropsMixin.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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-webexperience.html#cfn-qbusiness-webexperience-identityproviderconfiguration

origins

@Stability(Stable)
public CfnWebExperiencePropsMixin.Builder origins(List<String> 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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-webexperience.html#cfn-qbusiness-webexperience-origins

roleArn

@Stability(Stable)
public CfnWebExperiencePropsMixin.Builder roleArn(String 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.

Parameters:

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

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-webexperience.html#cfn-qbusiness-webexperience-rolearn

samplePromptsControlMode

@Stability(Stable)
public CfnWebExperiencePropsMixin.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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-webexperience.html#cfn-qbusiness-webexperience-samplepromptscontrolmode

subtitle

@Stability(Stable)
public CfnWebExperiencePropsMixin.Builder subtitle(String 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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-webexperience.html#cfn-qbusiness-webexperience-subtitle

tags

@Stability(Stable)
public CfnWebExperiencePropsMixin.Builder tags(List<? extends CfnTag> 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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-webexperience.html#cfn-qbusiness-webexperience-tags

title

@Stability(Stable)
public CfnWebExperiencePropsMixin.Builder title(String 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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-webexperience.html#cfn-qbusiness-webexperience-title

welcomeMessage

@Stability(Stable)
public CfnWebExperiencePropsMixin.Builder welcomeMessage(String 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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-webexperience.html#cfn-qbusiness-webexperience-welcomemessage

build

@Stability(Stable)
public CfnWebExperiencePropsMixin build()

Specified by:

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

Returns:

a newly built instance of CfnWebExperiencePropsMixin.