Interface RegisteredUserDashboardEmbeddingConfiguration.Builder

All Superinterfaces:

Buildable, CopyableBuilder<RegisteredUserDashboardEmbeddingConfiguration.Builder,RegisteredUserDashboardEmbeddingConfiguration>, SdkBuilder<RegisteredUserDashboardEmbeddingConfiguration.Builder,RegisteredUserDashboardEmbeddingConfiguration>, SdkPojo

Enclosing class:

RegisteredUserDashboardEmbeddingConfiguration

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

Method Summary

Modifier and Type	Method	Description
default RegisteredUserDashboardEmbeddingConfiguration.Builder	featureConfigurations(Consumer<RegisteredUserDashboardFeatureConfigurations.Builder> featureConfigurations)	The feature configurations of an embbedded Amazon Quick Sight dashboard.
RegisteredUserDashboardEmbeddingConfiguration.Builder	featureConfigurations(RegisteredUserDashboardFeatureConfigurations featureConfigurations)	The feature configurations of an embbedded Amazon Quick Sight dashboard.
RegisteredUserDashboardEmbeddingConfiguration.Builder	initialDashboardId(String initialDashboardId)	The dashboard ID for the dashboard that you want the user to see first.

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

copy

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 Details

initialDashboardId

RegisteredUserDashboardEmbeddingConfiguration.Builder initialDashboardId(String initialDashboardId)

The dashboard ID for the dashboard that you want the user to see first. This ID is included in the output URL. When the URL in response is accessed, Amazon Quick Sight renders this dashboard if the user has permissions to view it.

If the user does not have permission to view this dashboard, they see a permissions error message.

Parameters:

initialDashboardId - The dashboard ID for the dashboard that you want the user to see first. This ID is included in the output URL. When the URL in response is accessed, Amazon Quick Sight renders this dashboard if the user has permissions to view it.

If the user does not have permission to view this dashboard, they see a permissions error message.

Returns:

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

featureConfigurations

RegisteredUserDashboardEmbeddingConfiguration.Builder featureConfigurations(RegisteredUserDashboardFeatureConfigurations featureConfigurations)

The feature configurations of an embbedded Amazon Quick Sight dashboard.

Parameters:

featureConfigurations - The feature configurations of an embbedded Amazon Quick Sight dashboard.

Returns:

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

featureConfigurations

default RegisteredUserDashboardEmbeddingConfiguration.Builder featureConfigurations(Consumer<RegisteredUserDashboardFeatureConfigurations.Builder> featureConfigurations)

The feature configurations of an embbedded Amazon Quick Sight dashboard.

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

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

Parameters:

featureConfigurations - a consumer that will call methods on RegisteredUserDashboardFeatureConfigurations.Builder

Returns:

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

See Also:

• featureConfigurations(RegisteredUserDashboardFeatureConfigurations)