Package software.amazon.awscdk.services.qbusiness

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

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnWebExperienceProps.Builder	applicationId(String applicationId)	Sets the value of CfnWebExperienceProps.getApplicationId()
CfnWebExperienceProps	build()	Builds the configured instance.
CfnWebExperienceProps.Builder	identityProviderConfiguration(IResolvable identityProviderConfiguration)	Sets the value of CfnWebExperienceProps.getIdentityProviderConfiguration()
CfnWebExperienceProps.Builder	identityProviderConfiguration(CfnWebExperience.IdentityProviderConfigurationProperty identityProviderConfiguration)	Sets the value of CfnWebExperienceProps.getIdentityProviderConfiguration()
CfnWebExperienceProps.Builder	origins(List<String> origins)	Sets the value of CfnWebExperienceProps.getOrigins()
CfnWebExperienceProps.Builder	roleArn(String roleArn)	Sets the value of CfnWebExperienceProps.getRoleArn()
CfnWebExperienceProps.Builder	samplePromptsControlMode(String samplePromptsControlMode)	Sets the value of CfnWebExperienceProps.getSamplePromptsControlMode()
CfnWebExperienceProps.Builder	subtitle(String subtitle)	Sets the value of CfnWebExperienceProps.getSubtitle()
CfnWebExperienceProps.Builder	tags(List<? extends CfnTag> tags)	Sets the value of CfnWebExperienceProps.getTags()
CfnWebExperienceProps.Builder	title(String title)	Sets the value of CfnWebExperienceProps.getTitle()
CfnWebExperienceProps.Builder	welcomeMessage(String welcomeMessage)	Sets the value of CfnWebExperienceProps.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 CfnWebExperienceProps.Builder applicationId(String applicationId)

Sets the value of CfnWebExperienceProps.getApplicationId()

Parameters:

applicationId - The identifier of the Amazon Q Business web experience. This parameter is required.

Returns:

this

identityProviderConfiguration

@Stability(Stable)
public CfnWebExperienceProps.Builder identityProviderConfiguration(IResolvable identityProviderConfiguration)

Sets the value of CfnWebExperienceProps.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 of CfnWebExperienceProps.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 CfnWebExperienceProps.Builder origins(List<String> origins)

Sets the value of CfnWebExperienceProps.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 CfnWebExperienceProps.Builder roleArn(String roleArn)

Sets the value of CfnWebExperienceProps.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 of CfnWebExperienceProps.getSamplePromptsControlMode()

Parameters:

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

Returns:

this

subtitle

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

Sets the value of CfnWebExperienceProps.getSubtitle()

Parameters:

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

Returns:

this

tags

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

Sets the value of CfnWebExperienceProps.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 CfnWebExperienceProps.Builder title(String title)

Sets the value of CfnWebExperienceProps.getTitle()

Parameters:

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

Returns:

this

welcomeMessage

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

Sets the value of CfnWebExperienceProps.getWelcomeMessage()

Parameters:

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

Returns:

this

build

@Stability(Stable)
public CfnWebExperienceProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CfnWebExperienceProps

Throws:

NullPointerException - if any required attribute was not provided