software.amazon.awssdk.services.quicksight.model

Interface GetDashboardEmbedUrlRequest.Builder

All Superinterfaces:

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

Enclosing class:

GetDashboardEmbedUrlRequest

public static interface GetDashboardEmbedUrlRequest.Builder
extends QuickSightRequest.Builder, SdkPojo, CopyableBuilder<GetDashboardEmbedUrlRequest.Builder,GetDashboardEmbedUrlRequest>

Method Summary

Modifier and Type	Method and Description
GetDashboardEmbedUrlRequest.Builder	additionalDashboardIds(Collection<String> additionalDashboardIds) A list of one or more dashboard IDs that you want anonymous users to have tempporary access to.
GetDashboardEmbedUrlRequest.Builder	additionalDashboardIds(String... additionalDashboardIds) A list of one or more dashboard IDs that you want anonymous users to have tempporary access to.
GetDashboardEmbedUrlRequest.Builder	awsAccountId(String awsAccountId) The ID for the Amazon Web Services account that contains the dashboard that you're embedding.
GetDashboardEmbedUrlRequest.Builder	dashboardId(String dashboardId) The ID for the dashboard, also added to the Identity and Access Management (IAM) policy.
GetDashboardEmbedUrlRequest.Builder	identityType(EmbeddingIdentityType identityType) The authentication method that the user uses to sign in.
GetDashboardEmbedUrlRequest.Builder	identityType(String identityType) The authentication method that the user uses to sign in.
GetDashboardEmbedUrlRequest.Builder	namespace(String namespace) The Amazon QuickSight namespace that contains the dashboard IDs in this request.
GetDashboardEmbedUrlRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
GetDashboardEmbedUrlRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
GetDashboardEmbedUrlRequest.Builder	resetDisabled(Boolean resetDisabled) Remove the reset button on the embedded dashboard.
GetDashboardEmbedUrlRequest.Builder	sessionLifetimeInMinutes(Long sessionLifetimeInMinutes) How many minutes the session is valid.
GetDashboardEmbedUrlRequest.Builder	statePersistenceEnabled(Boolean statePersistenceEnabled) Adds persistence of state for the user session in an embedded dashboard.
GetDashboardEmbedUrlRequest.Builder	undoRedoDisabled(Boolean undoRedoDisabled) Remove the undo/redo button on the embedded dashboard.
GetDashboardEmbedUrlRequest.Builder	userArn(String userArn) The Amazon QuickSight user's Amazon Resource Name (ARN), for use with QUICKSIGHT identity type.

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

build

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

overrideConfiguration

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

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

awsAccountId

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

dashboardId

GetDashboardEmbedUrlRequest.Builder dashboardId(String dashboardId)

The ID for the dashboard, also added to the Identity and Access Management (IAM) policy.

Parameters:

dashboardId - The ID for the dashboard, also added to the Identity and Access Management (IAM) policy.

Returns:

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

identityType

GetDashboardEmbedUrlRequest.Builder identityType(String identityType)

The authentication method that the user uses to sign in.

Parameters:

identityType - The authentication method that the user uses to sign in.

Returns:

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

See Also:

EmbeddingIdentityType, EmbeddingIdentityType

identityType

GetDashboardEmbedUrlRequest.Builder identityType(EmbeddingIdentityType identityType)

The authentication method that the user uses to sign in.

Parameters:

identityType - The authentication method that the user uses to sign in.

Returns:

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

See Also:

EmbeddingIdentityType, EmbeddingIdentityType

sessionLifetimeInMinutes

GetDashboardEmbedUrlRequest.Builder sessionLifetimeInMinutes(Long sessionLifetimeInMinutes)

How many minutes the session is valid. The session lifetime must be 15-600 minutes.

Parameters:

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

Returns:

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

undoRedoDisabled

GetDashboardEmbedUrlRequest.Builder undoRedoDisabled(Boolean undoRedoDisabled)

Remove the undo/redo button on the embedded dashboard. The default is FALSE, which enables the undo/redo button.

Parameters:

undoRedoDisabled - Remove the undo/redo button on the embedded dashboard. The default is FALSE, which enables the undo/redo button.

Returns:

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

resetDisabled

GetDashboardEmbedUrlRequest.Builder resetDisabled(Boolean resetDisabled)

Remove the reset button on the embedded dashboard. The default is FALSE, which enables the reset button.

Parameters:

resetDisabled - Remove the reset button on the embedded dashboard. The default is FALSE, which enables the reset button.

Returns:

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

statePersistenceEnabled

GetDashboardEmbedUrlRequest.Builder statePersistenceEnabled(Boolean statePersistenceEnabled)

Adds persistence of state for the user session in an embedded dashboard. Persistence applies to the sheet and the parameter settings. These are control settings that the dashboard subscriber (Amazon QuickSight reader) chooses while viewing the dashboard. If this is set to TRUE, the settings are the same when the subscriber reopens the same dashboard URL. The state is stored in Amazon QuickSight, not in a browser cookie. If this is set to FALSE, the state of the user session is not persisted. The default is FALSE.

Parameters:

statePersistenceEnabled - Adds persistence of state for the user session in an embedded dashboard. Persistence applies to the sheet and the parameter settings. These are control settings that the dashboard subscriber (Amazon QuickSight reader) chooses while viewing the dashboard. If this is set to TRUE, the settings are the same when the subscriber reopens the same dashboard URL. The state is stored in Amazon QuickSight, not in a browser cookie. If this is set to FALSE, the state of the user session is not persisted. The default is FALSE.

Returns:

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

userArn

GetDashboardEmbedUrlRequest.Builder userArn(String userArn)

The Amazon QuickSight user's Amazon Resource Name (ARN), for use with QUICKSIGHT identity type. You can use this for any Amazon QuickSight users in your account (readers, authors, or admins) authenticated as one of the following:

• Active Directory (AD) users or group members

• Invited nonfederated users

• IAM users and IAM role-based sessions authenticated through Federated Single Sign-On using SAML, OpenID Connect, or IAM federation.

Omit this parameter for users in the third group – IAM users and IAM role-based sessions.

Parameters:

userArn - The Amazon QuickSight user's Amazon Resource Name (ARN), for use with QUICKSIGHT identity type. You can use this for any Amazon QuickSight users in your account (readers, authors, or admins) authenticated as one of the following:

• Active Directory (AD) users or group members

• Invited nonfederated users

• IAM users and IAM role-based sessions authenticated through Federated Single Sign-On using SAML, OpenID Connect, or IAM federation.

Omit this parameter for users in the third group – IAM users and IAM role-based sessions.

Returns:

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

namespace

GetDashboardEmbedUrlRequest.Builder namespace(String namespace)

The Amazon QuickSight namespace that contains the dashboard IDs in this request. If you're not using a custom namespace, set Namespace = default.

Parameters:

namespace - The Amazon QuickSight namespace that contains the dashboard IDs in this request. If you're not using a custom namespace, set Namespace = default.

Returns:

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

additionalDashboardIds

GetDashboardEmbedUrlRequest.Builder additionalDashboardIds(Collection<String> additionalDashboardIds)

A list of one or more dashboard IDs that you want anonymous users to have tempporary access to. Currently, the IdentityType parameter must be set to ANONYMOUS because other identity types authenticate as Amazon QuickSight or IAM users. For example, if you set " --dashboard-id dash_id1 --dashboard-id dash_id2 dash_id3 identity-type ANONYMOUS", the session can access all three dashboards.

Parameters:

additionalDashboardIds - A list of one or more dashboard IDs that you want anonymous users to have tempporary access to. Currently, the IdentityType parameter must be set to ANONYMOUS because other identity types authenticate as Amazon QuickSight or IAM users. For example, if you set " --dashboard-id dash_id1 --dashboard-id dash_id2 dash_id3 identity-type ANONYMOUS", the session can access all three dashboards.

Returns:

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

additionalDashboardIds

GetDashboardEmbedUrlRequest.Builder additionalDashboardIds(String... additionalDashboardIds)

A list of one or more dashboard IDs that you want anonymous users to have tempporary access to. Currently, the IdentityType parameter must be set to ANONYMOUS because other identity types authenticate as Amazon QuickSight or IAM users. For example, if you set " --dashboard-id dash_id1 --dashboard-id dash_id2 dash_id3 identity-type ANONYMOUS", the session can access all three dashboards.

Parameters:

additionalDashboardIds - A list of one or more dashboard IDs that you want anonymous users to have tempporary access to. Currently, the IdentityType parameter must be set to ANONYMOUS because other identity types authenticate as Amazon QuickSight or IAM users. For example, if you set " --dashboard-id dash_id1 --dashboard-id dash_id2 dash_id3 identity-type ANONYMOUS", the session can access all three dashboards.

Returns:

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

overrideConfiguration

GetDashboardEmbedUrlRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

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

Specified by:

overrideConfiguration in interface AwsRequest.Builder