Interface GenerateEmbedUrlForRegisteredUserRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<GenerateEmbedUrlForRegisteredUserRequest.Builder,
,GenerateEmbedUrlForRegisteredUserRequest> QuickSightRequest.Builder
,SdkBuilder<GenerateEmbedUrlForRegisteredUserRequest.Builder,
,GenerateEmbedUrlForRegisteredUserRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
GenerateEmbedUrlForRegisteredUserRequest
-
Method Summary
Modifier and TypeMethodDescriptionallowedDomains
(String... allowedDomains) The domains that you want to add to the allow list for access to the generated URL that is then embedded.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.awsAccountId
(String awsAccountId) The ID for the Amazon Web Services account that contains the dashboard that you're embedding.experienceConfiguration
(Consumer<RegisteredUserEmbeddingExperienceConfiguration.Builder> experienceConfiguration) The experience you are embedding.experienceConfiguration
(RegisteredUserEmbeddingExperienceConfiguration experienceConfiguration) The experience you are embedding.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.sessionLifetimeInMinutes
(Long sessionLifetimeInMinutes) How many minutes the session is valid.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, sdkFields
-
Method Details
-
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
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 you are embedding. For registered users, you can embed Amazon QuickSight dashboards, Amazon QuickSight visuals, the Amazon QuickSight Q search bar, or the entire Amazon QuickSight console.
- Parameters:
experienceConfiguration
- The experience you are embedding. For registered users, you can embed Amazon QuickSight dashboards, Amazon QuickSight visuals, the Amazon QuickSight Q search bar, or the entire Amazon 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 you are embedding. For registered users, you can embed Amazon QuickSight dashboards, Amazon QuickSight visuals, the Amazon QuickSight Q search bar, or the entire Amazon QuickSight console.
This is a convenience method that creates an instance of theRegisteredUserEmbeddingExperienceConfiguration.Builder
avoiding the need to create one manually viaRegisteredUserEmbeddingExperienceConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toexperienceConfiguration(RegisteredUserEmbeddingExperienceConfiguration)
.- Parameters:
experienceConfiguration
- a consumer that will call methods onRegisteredUserEmbeddingExperienceConfiguration.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 Amazon 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 underhttps://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 Amazon 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 underhttps://sapp.amazon.com
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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 Amazon 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 underhttps://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 Amazon 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 underhttps://sapp.amazon.com
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
GenerateEmbedUrlForRegisteredUserRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
GenerateEmbedUrlForRegisteredUserRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-