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	awsAccountId(String awsAccountId) AWS account ID that contains the dashboard you are embedding.
GetDashboardEmbedUrlRequest.Builder	dashboardId(String dashboardId) The ID for the dashboard, also added to IAM policy
GetDashboardEmbedUrlRequest.Builder	identityType(IdentityType identityType) The authentication method the user uses to sign in (IAM only).
GetDashboardEmbedUrlRequest.Builder	identityType(String identityType) The authentication method the user uses to sign in (IAM only).
GetDashboardEmbedUrlRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
GetDashboardEmbedUrlRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
GetDashboardEmbedUrlRequest.Builder	resetDisabled(Boolean resetDisabled) Remove the reset button on embedded dashboard.
GetDashboardEmbedUrlRequest.Builder	sessionLifetimeInMinutes(Long sessionLifetimeInMinutes) How many minutes the session is valid.
GetDashboardEmbedUrlRequest.Builder	undoRedoDisabled(Boolean undoRedoDisabled) Remove the undo/redo button on embedded dashboard.
GetDashboardEmbedUrlRequest.Builder	userArn(String userArn) The Amazon QuickSight user's 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)

AWS account ID that contains the dashboard you are embedding.

Parameters:

awsAccountId - AWS account ID that contains the dashboard you are 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 IAM policy

Parameters:

dashboardId - The ID for the dashboard, also added to 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 the user uses to sign in (IAM only).

Parameters:

identityType - The authentication method the user uses to sign in (IAM only).

Returns:

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

See Also:

IdentityType, IdentityType

identityType

GetDashboardEmbedUrlRequest.Builder identityType(IdentityType identityType)

The authentication method the user uses to sign in (IAM only).

Parameters:

identityType - The authentication method the user uses to sign in (IAM only).

Returns:

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

See Also:

IdentityType, IdentityType

sessionLifetimeInMinutes

GetDashboardEmbedUrlRequest.Builder sessionLifetimeInMinutes(Long sessionLifetimeInMinutes)

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

Parameters:

sessionLifetimeInMinutes - How many minutes the session is valid. The session lifetime must be between 15 and 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 embedded dashboard. The default is FALSE, which enables the undo/redo button.

Parameters:

undoRedoDisabled - Remove the undo/redo button on 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 embedded dashboard. The default is FALSE, which allows the reset button.

Parameters:

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

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 ARN, for use with QUICKSIGHT identity type. You can use this for any of the following:

• Amazon QuickSight users in your account (readers, authors, or admins)

• AD users

• Invited non-federated users

• Federated IAM users

• Federated IAM role-based sessions

Parameters:

userArn - The Amazon QuickSight user's ARN, for use with QUICKSIGHT identity type. You can use this for any of the following:

• Amazon QuickSight users in your account (readers, authors, or admins)

• AD users

• Invited non-federated users

• Federated IAM users

• Federated IAM role-based sessions

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