Interface RegisteredUserDashboardVisualEmbeddingConfiguration.Builder

All Superinterfaces:
Buildable, CopyableBuilder<RegisteredUserDashboardVisualEmbeddingConfiguration.Builder,RegisteredUserDashboardVisualEmbeddingConfiguration>, SdkBuilder<RegisteredUserDashboardVisualEmbeddingConfiguration.Builder,RegisteredUserDashboardVisualEmbeddingConfiguration>, SdkPojo
Enclosing class:
RegisteredUserDashboardVisualEmbeddingConfiguration
@Mutable @NotThreadSafe public static interface RegisteredUserDashboardVisualEmbeddingConfiguration.Builder extends SdkPojo, CopyableBuilder<RegisteredUserDashboardVisualEmbeddingConfiguration.Builder,RegisteredUserDashboardVisualEmbeddingConfiguration>

  • Method Details

    • initialDashboardVisualId

      RegisteredUserDashboardVisualEmbeddingConfiguration.Builder initialDashboardVisualId(DashboardVisualId initialDashboardVisualId)

      The visual ID for the visual that you want the user to embed. This ID is included in the output URL. When the URL in response is accessed, Amazon Quick Sight renders this visual.

      The Amazon Resource Name (ARN) of the dashboard that the visual belongs to must be included in the AuthorizedResourceArns parameter. Otherwise, the request will fail with InvalidParameterValueException.

      Parameters:
      initialDashboardVisualId - The visual ID for the visual that you want the user to embed. This ID is included in the output URL. When the URL in response is accessed, Amazon Quick Sight renders this visual.

      The Amazon Resource Name (ARN) of the dashboard that the visual belongs to must be included in the AuthorizedResourceArns parameter. Otherwise, the request will fail with InvalidParameterValueException.

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

    • initialDashboardVisualId

      default RegisteredUserDashboardVisualEmbeddingConfiguration.Builder initialDashboardVisualId(Consumer<DashboardVisualId.Builder> initialDashboardVisualId)

      The visual ID for the visual that you want the user to embed. This ID is included in the output URL. When the URL in response is accessed, Amazon Quick Sight renders this visual.

      The Amazon Resource Name (ARN) of the dashboard that the visual belongs to must be included in the AuthorizedResourceArns parameter. Otherwise, the request will fail with InvalidParameterValueException.

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

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

      Parameters:
      initialDashboardVisualId - a consumer that will call methods on DashboardVisualId.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: