Interface CreateWebExperienceRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<CreateWebExperienceRequest.Builder,CreateWebExperienceRequest>, QBusinessRequest.Builder, SdkBuilder<CreateWebExperienceRequest.Builder,CreateWebExperienceRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CreateWebExperienceRequest
@Mutable @NotThreadSafe public static interface CreateWebExperienceRequest.Builder extends QBusinessRequest.Builder, SdkPojo, CopyableBuilder<CreateWebExperienceRequest.Builder,CreateWebExperienceRequest>

  • Method Details

    • applicationId

      CreateWebExperienceRequest.Builder applicationId(String applicationId)

      The identifier of the Amazon Q Business web experience.

      Parameters:
      applicationId - The identifier of the Amazon Q Business web experience.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • title

      CreateWebExperienceRequest.Builder title(String title)

      The title for your Amazon Q Business web experience.

      Parameters:
      title - The title for your Amazon Q Business web experience.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • subtitle

      CreateWebExperienceRequest.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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • welcomeMessage

      CreateWebExperienceRequest.Builder welcomeMessage(String welcomeMessage)

      The customized welcome message for end users of an Amazon Q Business web experience.

      Parameters:
      welcomeMessage - The customized welcome message for end users of an Amazon Q Business web experience.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • samplePromptsControlMode

      CreateWebExperienceRequest.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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • samplePromptsControlMode

      CreateWebExperienceRequest.Builder samplePromptsControlMode(WebExperienceSamplePromptsControlMode 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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • origins

      CreateWebExperienceRequest.Builder origins(Collection<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. 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:
      Returns a reference to this object so that method calls can be chained together.

    • origins

      CreateWebExperienceRequest.Builder origins(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. 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:
      Returns a reference to this object so that method calls can be chained together.

    • roleArn

      CreateWebExperienceRequest.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.

      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:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateWebExperienceRequest.Builder tags(Collection<Tag> 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. 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:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateWebExperienceRequest.Builder tags(Tag... 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. 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:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateWebExperienceRequest.Builder tags(Consumer<Tag.Builder>... 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: _ . : / = + - @.

      This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tags(List<Tag>).

      Parameters:
      tags - a consumer that will call methods on Tag.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • clientToken

      CreateWebExperienceRequest.Builder clientToken(String clientToken)

      A token you provide to identify a request to create an Amazon Q Business web experience.

      Parameters:
      clientToken - A token you provide to identify a request to create an Amazon Q Business web experience.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • identityProviderConfiguration

      CreateWebExperienceRequest.Builder identityProviderConfiguration(IdentityProviderConfiguration identityProviderConfiguration)

      Information about the identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.

      Parameters:
      identityProviderConfiguration - Information about the identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • identityProviderConfiguration

      default CreateWebExperienceRequest.Builder identityProviderConfiguration(Consumer<IdentityProviderConfiguration.Builder> identityProviderConfiguration)

      Information about the identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.

      This is a convenience method that creates an instance of the IdentityProviderConfiguration.Builder avoiding the need to create one manually via IdentityProviderConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to identityProviderConfiguration(IdentityProviderConfiguration).

      Parameters:
      identityProviderConfiguration - a consumer that will call methods on IdentityProviderConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • browserExtensionConfiguration

      CreateWebExperienceRequest.Builder browserExtensionConfiguration(BrowserExtensionConfiguration browserExtensionConfiguration)

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

      For Amazon Q Business application using external OIDC-compliant identity providers (IdPs). The IdP administrator must add the browser extension sign-in redirect URLs to the IdP application. For more information, see Configure external OIDC identity provider for your browser extensions..

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

      For Amazon Q Business application using external OIDC-compliant identity providers (IdPs). The IdP administrator must add the browser extension sign-in redirect URLs to the IdP application. For more information, see Configure external OIDC identity provider for your browser extensions..

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • browserExtensionConfiguration

      default CreateWebExperienceRequest.Builder browserExtensionConfiguration(Consumer<BrowserExtensionConfiguration.Builder> browserExtensionConfiguration)

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

      For Amazon Q Business application using external OIDC-compliant identity providers (IdPs). The IdP administrator must add the browser extension sign-in redirect URLs to the IdP application. For more information, see Configure external OIDC identity provider for your browser extensions..

      This is a convenience method that creates an instance of the BrowserExtensionConfiguration.Builder avoiding the need to create one manually via BrowserExtensionConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to browserExtensionConfiguration(BrowserExtensionConfiguration).

      Parameters:
      browserExtensionConfiguration - a consumer that will call methods on BrowserExtensionConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • customizationConfiguration

      CreateWebExperienceRequest.Builder customizationConfiguration(CustomizationConfiguration customizationConfiguration)

      Sets the custom logo, favicon, font, and color used in the Amazon Q web experience.

      Parameters:
      customizationConfiguration - Sets the custom logo, favicon, font, and color used in the Amazon Q web experience.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • customizationConfiguration

      default CreateWebExperienceRequest.Builder customizationConfiguration(Consumer<CustomizationConfiguration.Builder> customizationConfiguration)

      Sets the custom logo, favicon, font, and color used in the Amazon Q web experience.

      This is a convenience method that creates an instance of the CustomizationConfiguration.Builder avoiding the need to create one manually via CustomizationConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to customizationConfiguration(CustomizationConfiguration).

      Parameters:
      customizationConfiguration - a consumer that will call methods on CustomizationConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideConfiguration

      CreateWebExperienceRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      CreateWebExperienceRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.