Interface UpdateWebExperienceRequest.Builder

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

  • Method Details

    • applicationId

      UpdateWebExperienceRequest.Builder applicationId(String applicationId)

      The identifier of the Amazon Q Business application attached to the web experience.

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

    • webExperienceId

      UpdateWebExperienceRequest.Builder webExperienceId(String webExperienceId)

      The identifier of the Amazon Q Business web experience.

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

    • roleArn

      UpdateWebExperienceRequest.Builder roleArn(String roleArn)

      The Amazon Resource Name (ARN) of the role with permission to access the Amazon Q Business web experience and required resources.

      Parameters:
      roleArn - The Amazon Resource Name (ARN) of the role with permission to access the Amazon Q Business web experience and required resources.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • authenticationConfiguration

      @Deprecated UpdateWebExperienceRequest.Builder authenticationConfiguration(WebExperienceAuthConfiguration authenticationConfiguration)
      Deprecated.
      Property associated with legacy SAML IdP flow. Deprecated in favor of using AWS IAM Identity Center for user management.

      The authentication configuration of the Amazon Q Business web experience.

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

    • authenticationConfiguration

      @Deprecated default UpdateWebExperienceRequest.Builder authenticationConfiguration(Consumer<WebExperienceAuthConfiguration.Builder> authenticationConfiguration)
      Deprecated.
      Property associated with legacy SAML IdP flow. Deprecated in favor of using AWS IAM Identity Center for user management.

      The authentication configuration of the Amazon Q Business web experience.

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

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

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

    • title

      UpdateWebExperienceRequest.Builder title(String title)

      The title of the Amazon Q Business web experience.

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

    • subtitle

      UpdateWebExperienceRequest.Builder subtitle(String subtitle)

      The subtitle of the Amazon Q Business web experience.

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

    • welcomeMessage

      UpdateWebExperienceRequest.Builder welcomeMessage(String welcomeMessage)

      A customized welcome message for an end user in an Amazon Q Business web experience.

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

    • samplePromptsControlMode

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

      UpdateWebExperienceRequest.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:

    • identityProviderConfiguration

      UpdateWebExperienceRequest.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 UpdateWebExperienceRequest.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:

    • origins

      UpdateWebExperienceRequest.Builder origins(Collection<String> origins)

      Updates the website domain origins that are allowed to embed the Amazon Q Business web experience. 

        The <i>domain origin</i> refers to the <i>base URL</i> for accessing a website including the protocol (<code>http/https</code>), the domain name, and the port number (if specified).</p> <note> <ul> <li> <p>Any values except <code>null</code> submitted as part of this update will replace all previous values.</p> </li> <li> <p>You must only submit a <i>base URL</i> and not a full path. For example, <code>https://docs.aws.amazon.com</code>.</p> </li> </ul> </note>
      Parameters:
      origins - Updates the website domain origins that are allowed to embed the Amazon Q Business web experience. 
       
         The <i>domain origin</i> refers to the <i>base URL</i> for accessing a
        website including the protocol (<code>http/https</code>), the domain name, and the port
        number (if specified).</p> <note> <ul> <li> <p>Any values except
        <code>null</code> submitted as part of this update will replace all previous
        values.</p> </li> <li> <p>You must only submit a <i>base URL</i>
        and not a full path. For example, <code>https://docs.aws.amazon.com</code>.</p>
        </li> </ul> </note>  @return Returns a reference to this object so that
        method calls can be chained together.

    • origins

      UpdateWebExperienceRequest.Builder origins(String... origins)

      Updates the website domain origins that are allowed to embed the Amazon Q Business web experience. 

        The <i>domain origin</i> refers to the <i>base URL</i> for accessing a website including the protocol (<code>http/https</code>), the domain name, and the port number (if specified).</p> <note> <ul> <li> <p>Any values except <code>null</code> submitted as part of this update will replace all previous values.</p> </li> <li> <p>You must only submit a <i>base URL</i> and not a full path. For example, <code>https://docs.aws.amazon.com</code>.</p> </li> </ul> </note>
      Parameters:
      origins - Updates the website domain origins that are allowed to embed the Amazon Q Business web experience. 
       
         The <i>domain origin</i> refers to the <i>base URL</i> for accessing a
        website including the protocol (<code>http/https</code>), the domain name, and the port
        number (if specified).</p> <note> <ul> <li> <p>Any values except
        <code>null</code> submitted as part of this update will replace all previous
        values.</p> </li> <li> <p>You must only submit a <i>base URL</i>
        and not a full path. For example, <code>https://docs.aws.amazon.com</code>.</p>
        </li> </ul> </note>  @return Returns a reference to this object so that
        method calls can be chained together.

    • overrideConfiguration

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

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