Package software.amazon.awssdk.services.quicksight.model

Interface GenerateEmbedUrlForRegisteredUserRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<GenerateEmbedUrlForRegisteredUserRequest.Builder,GenerateEmbedUrlForRegisteredUserRequest>, QuickSightRequest.Builder, SdkBuilder<GenerateEmbedUrlForRegisteredUserRequest.Builder,GenerateEmbedUrlForRegisteredUserRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

GenerateEmbedUrlForRegisteredUserRequest

@Mutable
@NotThreadSafe
public static interface GenerateEmbedUrlForRegisteredUserRequest.Builder
extends QuickSightRequest.Builder, SdkPojo, CopyableBuilder<GenerateEmbedUrlForRegisteredUserRequest.Builder,GenerateEmbedUrlForRegisteredUserRequest>

Method Summary

Modifier and Type	Method	Description
GenerateEmbedUrlForRegisteredUserRequest.Builder	allowedDomains(String... allowedDomains)	The domains that you want to add to the allow list for access to the generated URL that is then embedded.
GenerateEmbedUrlForRegisteredUserRequest.Builder	allowedDomains(Collection<String> allowedDomains)	The domains that you want to add to the allow list for access to the generated URL that is then embedded.
GenerateEmbedUrlForRegisteredUserRequest.Builder	awsAccountId(String awsAccountId)	The ID for the Amazon Web Services account that contains the dashboard that you're embedding.
default GenerateEmbedUrlForRegisteredUserRequest.Builder	experienceConfiguration(Consumer<RegisteredUserEmbeddingExperienceConfiguration.Builder> experienceConfiguration)	The experience that you want to embed.
GenerateEmbedUrlForRegisteredUserRequest.Builder	experienceConfiguration(RegisteredUserEmbeddingExperienceConfiguration experienceConfiguration)	The experience that you want to embed.
GenerateEmbedUrlForRegisteredUserRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
GenerateEmbedUrlForRegisteredUserRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
GenerateEmbedUrlForRegisteredUserRequest.Builder	sessionLifetimeInMinutes(Long sessionLifetimeInMinutes)	How many minutes the session is valid.
GenerateEmbedUrlForRegisteredUserRequest.Builder	userArn(String userArn)	The Amazon Resource Name for the registered user.

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.services.quicksight.model.QuickSightRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Detail

awsAccountId

GenerateEmbedUrlForRegisteredUserRequest.Builder awsAccountId(String awsAccountId)

The ID for the Amazon Web Services account that contains the dashboard that you're embedding.

Parameters:

awsAccountId - The ID for the Amazon Web Services account that contains the dashboard that you're embedding.

Returns:

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

sessionLifetimeInMinutes

GenerateEmbedUrlForRegisteredUserRequest.Builder sessionLifetimeInMinutes(Long sessionLifetimeInMinutes)

How many minutes the session is valid. The session lifetime must be in [15-600] minutes range.

Parameters:

sessionLifetimeInMinutes - How many minutes the session is valid. The session lifetime must be in [15-600] minutes range.

Returns:

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

userArn

GenerateEmbedUrlForRegisteredUserRequest.Builder userArn(String userArn)

The Amazon Resource Name for the registered user.

Parameters:

userArn - The Amazon Resource Name for the registered user.

Returns:

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

experienceConfiguration

GenerateEmbedUrlForRegisteredUserRequest.Builder experienceConfiguration(RegisteredUserEmbeddingExperienceConfiguration experienceConfiguration)

The experience that you want to embed. For registered users, you can embed QuickSight dashboards, QuickSight visuals, the QuickSight Q search bar, the QuickSight Generative Q&A experience, or the entire QuickSight console.

Parameters:

experienceConfiguration - The experience that you want to embed. For registered users, you can embed QuickSight dashboards, QuickSight visuals, the QuickSight Q search bar, the QuickSight Generative Q&A experience, or the entire QuickSight console.

Returns:

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

experienceConfiguration

default GenerateEmbedUrlForRegisteredUserRequest.Builder experienceConfiguration(Consumer<RegisteredUserEmbeddingExperienceConfiguration.Builder> experienceConfiguration)

The experience that you want to embed. For registered users, you can embed QuickSight dashboards, QuickSight visuals, the QuickSight Q search bar, the QuickSight Generative Q&A experience, or the entire QuickSight console.

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

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

Parameters:

experienceConfiguration - a consumer that will call methods on RegisteredUserEmbeddingExperienceConfiguration.Builder

Returns:

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

See Also:

experienceConfiguration(RegisteredUserEmbeddingExperienceConfiguration)

allowedDomains

GenerateEmbedUrlForRegisteredUserRequest.Builder allowedDomains(Collection<String> allowedDomains)

The domains that you want to add to the allow list for access to the generated URL that is then embedded. This optional parameter overrides the static domains that are configured in the Manage QuickSight menu in the QuickSight console. Instead, it allows only the domains that you include in this parameter. You can list up to three domains or subdomains in each API call.

To include all subdomains under a specific domain to the allow list, use *. For example, https://*.sapp.amazon.com includes all subdomains under https://sapp.amazon.com.

Parameters:

allowedDomains - The domains that you want to add to the allow list for access to the generated URL that is then embedded. This optional parameter overrides the static domains that are configured in the Manage QuickSight menu in the QuickSight console. Instead, it allows only the domains that you include in this parameter. You can list up to three domains or subdomains in each API call.

To include all subdomains under a specific domain to the allow list, use *. For example, https://*.sapp.amazon.com includes all subdomains under https://sapp.amazon.com.

Returns:

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

allowedDomains

GenerateEmbedUrlForRegisteredUserRequest.Builder allowedDomains(String... allowedDomains)

The domains that you want to add to the allow list for access to the generated URL that is then embedded. This optional parameter overrides the static domains that are configured in the Manage QuickSight menu in the QuickSight console. Instead, it allows only the domains that you include in this parameter. You can list up to three domains or subdomains in each API call.

To include all subdomains under a specific domain to the allow list, use *. For example, https://*.sapp.amazon.com includes all subdomains under https://sapp.amazon.com.

Parameters:

allowedDomains - The domains that you want to add to the allow list for access to the generated URL that is then embedded. This optional parameter overrides the static domains that are configured in the Manage QuickSight menu in the QuickSight console. Instead, it allows only the domains that you include in this parameter. You can list up to three domains or subdomains in each API call.

To include all subdomains under a specific domain to the allow list, use *. For example, https://*.sapp.amazon.com includes all subdomains under https://sapp.amazon.com.

Returns:

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

overrideConfiguration

GenerateEmbedUrlForRegisteredUserRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

GenerateEmbedUrlForRegisteredUserRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder