Interface RegisteredUserQuickSightConsoleEmbeddingConfiguration.Builder

All Superinterfaces:

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

Enclosing class:

RegisteredUserQuickSightConsoleEmbeddingConfiguration

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

Method Summary

Modifier and Type	Method	Description
default RegisteredUserQuickSightConsoleEmbeddingConfiguration.Builder	featureConfigurations(Consumer<RegisteredUserConsoleFeatureConfigurations.Builder> featureConfigurations)	The embedding configuration of an embedded Amazon Quick Sight console.
RegisteredUserQuickSightConsoleEmbeddingConfiguration.Builder	featureConfigurations(RegisteredUserConsoleFeatureConfigurations featureConfigurations)	The embedding configuration of an embedded Amazon Quick Sight console.
RegisteredUserQuickSightConsoleEmbeddingConfiguration.Builder	initialPath(String initialPath)	The initial URL path for the Amazon Quick Sight console.

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

initialPath

RegisteredUserQuickSightConsoleEmbeddingConfiguration.Builder initialPath(String initialPath)

The initial URL path for the Amazon Quick Sight console. InitialPath is required.

The entry point URL is constrained to the following paths:

• /start

• /start/analyses

• /start/dashboards

• /start/favorites

• /dashboards/DashboardId. DashboardId is the actual ID key from the Amazon Quick Sight console URL of the dashboard.

• /analyses/AnalysisId. AnalysisId is the actual ID key from the Amazon Quick Sight console URL of the analysis.

Parameters:

initialPath - The initial URL path for the Amazon Quick Sight console. InitialPath is required.

The entry point URL is constrained to the following paths:

• /start

• /start/analyses

• /start/dashboards

• /start/favorites

• /dashboards/DashboardId. DashboardId is the actual ID key from the Amazon Quick Sight console URL of the dashboard.

• /analyses/AnalysisId. AnalysisId is the actual ID key from the Amazon Quick Sight console URL of the analysis.

Returns:

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

featureConfigurations

RegisteredUserQuickSightConsoleEmbeddingConfiguration.Builder featureConfigurations(RegisteredUserConsoleFeatureConfigurations featureConfigurations)

The embedding configuration of an embedded Amazon Quick Sight console.

Parameters:

featureConfigurations - The embedding configuration of an embedded Amazon Quick Sight console.

Returns:

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

featureConfigurations

default RegisteredUserQuickSightConsoleEmbeddingConfiguration.Builder featureConfigurations(Consumer<RegisteredUserConsoleFeatureConfigurations.Builder> featureConfigurations)

The embedding configuration of an embedded Amazon Quick Sight console.

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

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

Parameters:

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

Returns:

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

See Also:

• featureConfigurations(RegisteredUserConsoleFeatureConfigurations)