/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include #include namespace Aws { namespace Utils { namespace Json { class JsonValue; class JsonView; } // namespace Json } // namespace Utils namespace QuickSight { namespace Model { /** *

The type of experience you want to embed. For registered users, you can embed * Amazon QuickSight dashboards or the Amazon QuickSight console.

*

Exactly one of the experience configurations is required. You can choose * Dashboard or QuickSightConsole. You cannot choose more * than one experience configuration.

See Also:

AWS * API Reference

*/ class RegisteredUserEmbeddingExperienceConfiguration { public: AWS_QUICKSIGHT_API RegisteredUserEmbeddingExperienceConfiguration(); AWS_QUICKSIGHT_API RegisteredUserEmbeddingExperienceConfiguration(Aws::Utils::Json::JsonView jsonValue); AWS_QUICKSIGHT_API RegisteredUserEmbeddingExperienceConfiguration& operator=(Aws::Utils::Json::JsonView jsonValue); AWS_QUICKSIGHT_API Aws::Utils::Json::JsonValue Jsonize() const; /** *

The configuration details for providing a dashboard embedding experience.

*/ inline const RegisteredUserDashboardEmbeddingConfiguration& GetDashboard() const{ return m_dashboard; } /** *

The configuration details for providing a dashboard embedding experience.

*/ inline bool DashboardHasBeenSet() const { return m_dashboardHasBeenSet; } /** *

The configuration details for providing a dashboard embedding experience.

*/ inline void SetDashboard(const RegisteredUserDashboardEmbeddingConfiguration& value) { m_dashboardHasBeenSet = true; m_dashboard = value; } /** *

The configuration details for providing a dashboard embedding experience.

*/ inline void SetDashboard(RegisteredUserDashboardEmbeddingConfiguration&& value) { m_dashboardHasBeenSet = true; m_dashboard = std::move(value); } /** *

The configuration details for providing a dashboard embedding experience.

*/ inline RegisteredUserEmbeddingExperienceConfiguration& WithDashboard(const RegisteredUserDashboardEmbeddingConfiguration& value) { SetDashboard(value); return *this;} /** *

The configuration details for providing a dashboard embedding experience.

*/ inline RegisteredUserEmbeddingExperienceConfiguration& WithDashboard(RegisteredUserDashboardEmbeddingConfiguration&& value) { SetDashboard(std::move(value)); return *this;} /** *

The configuration details for providing each Amazon QuickSight console * embedding experience. This can be used along with custom permissions to restrict * access to certain features. For more information, see Customizing * Access to the Amazon QuickSight Console in the Amazon QuickSight User * Guide.

Use GenerateEmbedUrlForRegisteredUser * where you want to provide an authoring portal that allows users to * create data sources, datasets, analyses, and dashboards. The users who accesses * an embedded Amazon QuickSight console needs to belong to the author or admin * security cohort. If you want to restrict permissions to some of these features, * add a custom permissions profile to the user with the UpdateUser * API operation. Use the RegisterUser * API operation to add a new user with a custom permission profile * attached. For more information, see the following sections in the Amazon * QuickSight User Guide:

For more * information about the high-level steps for embedding and for an interactive demo * of the ways you can customize embedding, visit the Amazon * QuickSight Developer Portal.

*/ inline const RegisteredUserQuickSightConsoleEmbeddingConfiguration& GetQuickSightConsole() const{ return m_quickSightConsole; } /** *

The configuration details for providing each Amazon QuickSight console * embedding experience. This can be used along with custom permissions to restrict * access to certain features. For more information, see Customizing * Access to the Amazon QuickSight Console in the Amazon QuickSight User * Guide.

Use GenerateEmbedUrlForRegisteredUser * where you want to provide an authoring portal that allows users to * create data sources, datasets, analyses, and dashboards. The users who accesses * an embedded Amazon QuickSight console needs to belong to the author or admin * security cohort. If you want to restrict permissions to some of these features, * add a custom permissions profile to the user with the UpdateUser * API operation. Use the RegisterUser * API operation to add a new user with a custom permission profile * attached. For more information, see the following sections in the Amazon * QuickSight User Guide:

For more * information about the high-level steps for embedding and for an interactive demo * of the ways you can customize embedding, visit the Amazon * QuickSight Developer Portal.

*/ inline bool QuickSightConsoleHasBeenSet() const { return m_quickSightConsoleHasBeenSet; } /** *

The configuration details for providing each Amazon QuickSight console * embedding experience. This can be used along with custom permissions to restrict * access to certain features. For more information, see Customizing * Access to the Amazon QuickSight Console in the Amazon QuickSight User * Guide.

Use GenerateEmbedUrlForRegisteredUser * where you want to provide an authoring portal that allows users to * create data sources, datasets, analyses, and dashboards. The users who accesses * an embedded Amazon QuickSight console needs to belong to the author or admin * security cohort. If you want to restrict permissions to some of these features, * add a custom permissions profile to the user with the UpdateUser * API operation. Use the RegisterUser * API operation to add a new user with a custom permission profile * attached. For more information, see the following sections in the Amazon * QuickSight User Guide:

For more * information about the high-level steps for embedding and for an interactive demo * of the ways you can customize embedding, visit the Amazon * QuickSight Developer Portal.

*/ inline void SetQuickSightConsole(const RegisteredUserQuickSightConsoleEmbeddingConfiguration& value) { m_quickSightConsoleHasBeenSet = true; m_quickSightConsole = value; } /** *

The configuration details for providing each Amazon QuickSight console * embedding experience. This can be used along with custom permissions to restrict * access to certain features. For more information, see Customizing * Access to the Amazon QuickSight Console in the Amazon QuickSight User * Guide.

Use GenerateEmbedUrlForRegisteredUser * where you want to provide an authoring portal that allows users to * create data sources, datasets, analyses, and dashboards. The users who accesses * an embedded Amazon QuickSight console needs to belong to the author or admin * security cohort. If you want to restrict permissions to some of these features, * add a custom permissions profile to the user with the UpdateUser * API operation. Use the RegisterUser * API operation to add a new user with a custom permission profile * attached. For more information, see the following sections in the Amazon * QuickSight User Guide:

For more * information about the high-level steps for embedding and for an interactive demo * of the ways you can customize embedding, visit the Amazon * QuickSight Developer Portal.

*/ inline void SetQuickSightConsole(RegisteredUserQuickSightConsoleEmbeddingConfiguration&& value) { m_quickSightConsoleHasBeenSet = true; m_quickSightConsole = std::move(value); } /** *

The configuration details for providing each Amazon QuickSight console * embedding experience. This can be used along with custom permissions to restrict * access to certain features. For more information, see Customizing * Access to the Amazon QuickSight Console in the Amazon QuickSight User * Guide.

Use GenerateEmbedUrlForRegisteredUser * where you want to provide an authoring portal that allows users to * create data sources, datasets, analyses, and dashboards. The users who accesses * an embedded Amazon QuickSight console needs to belong to the author or admin * security cohort. If you want to restrict permissions to some of these features, * add a custom permissions profile to the user with the UpdateUser * API operation. Use the RegisterUser * API operation to add a new user with a custom permission profile * attached. For more information, see the following sections in the Amazon * QuickSight User Guide:

For more * information about the high-level steps for embedding and for an interactive demo * of the ways you can customize embedding, visit the Amazon * QuickSight Developer Portal.

*/ inline RegisteredUserEmbeddingExperienceConfiguration& WithQuickSightConsole(const RegisteredUserQuickSightConsoleEmbeddingConfiguration& value) { SetQuickSightConsole(value); return *this;} /** *

The configuration details for providing each Amazon QuickSight console * embedding experience. This can be used along with custom permissions to restrict * access to certain features. For more information, see Customizing * Access to the Amazon QuickSight Console in the Amazon QuickSight User * Guide.

Use GenerateEmbedUrlForRegisteredUser * where you want to provide an authoring portal that allows users to * create data sources, datasets, analyses, and dashboards. The users who accesses * an embedded Amazon QuickSight console needs to belong to the author or admin * security cohort. If you want to restrict permissions to some of these features, * add a custom permissions profile to the user with the UpdateUser * API operation. Use the RegisterUser * API operation to add a new user with a custom permission profile * attached. For more information, see the following sections in the Amazon * QuickSight User Guide:

For more * information about the high-level steps for embedding and for an interactive demo * of the ways you can customize embedding, visit the Amazon * QuickSight Developer Portal.

*/ inline RegisteredUserEmbeddingExperienceConfiguration& WithQuickSightConsole(RegisteredUserQuickSightConsoleEmbeddingConfiguration&& value) { SetQuickSightConsole(std::move(value)); return *this;} /** *

The configuration details for embedding the Q search bar.

For more * information about embedding the Q search bar, see Embedding * Overview in the Amazon QuickSight User Guide.

*/ inline const RegisteredUserQSearchBarEmbeddingConfiguration& GetQSearchBar() const{ return m_qSearchBar; } /** *

The configuration details for embedding the Q search bar.

For more * information about embedding the Q search bar, see Embedding * Overview in the Amazon QuickSight User Guide.

*/ inline bool QSearchBarHasBeenSet() const { return m_qSearchBarHasBeenSet; } /** *

The configuration details for embedding the Q search bar.

For more * information about embedding the Q search bar, see Embedding * Overview in the Amazon QuickSight User Guide.

*/ inline void SetQSearchBar(const RegisteredUserQSearchBarEmbeddingConfiguration& value) { m_qSearchBarHasBeenSet = true; m_qSearchBar = value; } /** *

The configuration details for embedding the Q search bar.

For more * information about embedding the Q search bar, see Embedding * Overview in the Amazon QuickSight User Guide.

*/ inline void SetQSearchBar(RegisteredUserQSearchBarEmbeddingConfiguration&& value) { m_qSearchBarHasBeenSet = true; m_qSearchBar = std::move(value); } /** *

The configuration details for embedding the Q search bar.

For more * information about embedding the Q search bar, see Embedding * Overview in the Amazon QuickSight User Guide.

*/ inline RegisteredUserEmbeddingExperienceConfiguration& WithQSearchBar(const RegisteredUserQSearchBarEmbeddingConfiguration& value) { SetQSearchBar(value); return *this;} /** *

The configuration details for embedding the Q search bar.

For more * information about embedding the Q search bar, see Embedding * Overview in the Amazon QuickSight User Guide.

*/ inline RegisteredUserEmbeddingExperienceConfiguration& WithQSearchBar(RegisteredUserQSearchBarEmbeddingConfiguration&& value) { SetQSearchBar(std::move(value)); return *this;} /** *

The type of embedding experience. In this case, Amazon QuickSight * visuals.

*/ inline const RegisteredUserDashboardVisualEmbeddingConfiguration& GetDashboardVisual() const{ return m_dashboardVisual; } /** *

The type of embedding experience. In this case, Amazon QuickSight * visuals.

*/ inline bool DashboardVisualHasBeenSet() const { return m_dashboardVisualHasBeenSet; } /** *

The type of embedding experience. In this case, Amazon QuickSight * visuals.

*/ inline void SetDashboardVisual(const RegisteredUserDashboardVisualEmbeddingConfiguration& value) { m_dashboardVisualHasBeenSet = true; m_dashboardVisual = value; } /** *

The type of embedding experience. In this case, Amazon QuickSight * visuals.

*/ inline void SetDashboardVisual(RegisteredUserDashboardVisualEmbeddingConfiguration&& value) { m_dashboardVisualHasBeenSet = true; m_dashboardVisual = std::move(value); } /** *

The type of embedding experience. In this case, Amazon QuickSight * visuals.

*/ inline RegisteredUserEmbeddingExperienceConfiguration& WithDashboardVisual(const RegisteredUserDashboardVisualEmbeddingConfiguration& value) { SetDashboardVisual(value); return *this;} /** *

The type of embedding experience. In this case, Amazon QuickSight * visuals.

*/ inline RegisteredUserEmbeddingExperienceConfiguration& WithDashboardVisual(RegisteredUserDashboardVisualEmbeddingConfiguration&& value) { SetDashboardVisual(std::move(value)); return *this;} private: RegisteredUserDashboardEmbeddingConfiguration m_dashboard; bool m_dashboardHasBeenSet = false; RegisteredUserQuickSightConsoleEmbeddingConfiguration m_quickSightConsole; bool m_quickSightConsoleHasBeenSet = false; RegisteredUserQSearchBarEmbeddingConfiguration m_qSearchBar; bool m_qSearchBarHasBeenSet = false; RegisteredUserDashboardVisualEmbeddingConfiguration m_dashboardVisual; bool m_dashboardVisualHasBeenSet = false; }; } // namespace Model } // namespace QuickSight } // namespace Aws