Package software.amazon.awscdk.services.qbusiness

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 Type	Method	Description
CfnWebExperience.Builder	applicationId(String applicationId)	The identifier of the Amazon Q Business web experience.
CfnWebExperience	build()
static CfnWebExperience.Builder	create(software.constructs.Construct scope, String id)
CfnWebExperience.Builder	identityProviderConfiguration(IResolvable identityProviderConfiguration)	Provides information about the identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.
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.
CfnWebExperience.Builder	roleArn(String roleArn)	The Amazon Resource Name (ARN) of the service role attached to your web experience.
CfnWebExperience.Builder	samplePromptsControlMode(String samplePromptsControlMode)	Determines whether sample prompts are enabled in the web experience for an end user.
CfnWebExperience.Builder	subtitle(String subtitle)	A subtitle to personalize your Amazon Q Business web experience.
CfnWebExperience.Builder	tags(List<? extends CfnTag> tags)	A list of key-value pairs that identify or categorize your Amazon Q Business web experience.
CfnWebExperience.Builder	title(String title)	The title for your Amazon Q Business web experience.
CfnWebExperience.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 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

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

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:

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

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:

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

roleArn

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

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

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:

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

subtitle

@Stability(Stable)
public CfnWebExperience.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 CfnWebExperience.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 CfnWebExperience.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 CfnWebExperience.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 CfnWebExperience build()

Specified by:

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

Returns:

a newly built instance of CfnWebExperience.