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

Information about the Amazon QuickSight console that you want to * embed.

See Also:

AWS * API Reference

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

The initial URL path for the Amazon QuickSight 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 QuickSight console URL of the dashboard.

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

  • *
*/ inline const Aws::String& GetInitialPath() const{ return m_initialPath; } /** *

The initial URL path for the Amazon QuickSight 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 QuickSight console URL of the dashboard.

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

  • *
*/ inline bool InitialPathHasBeenSet() const { return m_initialPathHasBeenSet; } /** *

The initial URL path for the Amazon QuickSight 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 QuickSight console URL of the dashboard.

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

  • *
*/ inline void SetInitialPath(const Aws::String& value) { m_initialPathHasBeenSet = true; m_initialPath = value; } /** *

The initial URL path for the Amazon QuickSight 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 QuickSight console URL of the dashboard.

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

  • *
*/ inline void SetInitialPath(Aws::String&& value) { m_initialPathHasBeenSet = true; m_initialPath = std::move(value); } /** *

The initial URL path for the Amazon QuickSight 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 QuickSight console URL of the dashboard.

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

  • *
*/ inline void SetInitialPath(const char* value) { m_initialPathHasBeenSet = true; m_initialPath.assign(value); } /** *

The initial URL path for the Amazon QuickSight 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 QuickSight console URL of the dashboard.

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

  • *
*/ inline RegisteredUserQuickSightConsoleEmbeddingConfiguration& WithInitialPath(const Aws::String& value) { SetInitialPath(value); return *this;} /** *

The initial URL path for the Amazon QuickSight 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 QuickSight console URL of the dashboard.

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

  • *
*/ inline RegisteredUserQuickSightConsoleEmbeddingConfiguration& WithInitialPath(Aws::String&& value) { SetInitialPath(std::move(value)); return *this;} /** *

The initial URL path for the Amazon QuickSight 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 QuickSight console URL of the dashboard.

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

  • *
*/ inline RegisteredUserQuickSightConsoleEmbeddingConfiguration& WithInitialPath(const char* value) { SetInitialPath(value); return *this;} /** *

The embedding configuration of an embedded Amazon QuickSight console.

*/ inline const RegisteredUserConsoleFeatureConfigurations& GetFeatureConfigurations() const{ return m_featureConfigurations; } /** *

The embedding configuration of an embedded Amazon QuickSight console.

*/ inline bool FeatureConfigurationsHasBeenSet() const { return m_featureConfigurationsHasBeenSet; } /** *

The embedding configuration of an embedded Amazon QuickSight console.

*/ inline void SetFeatureConfigurations(const RegisteredUserConsoleFeatureConfigurations& value) { m_featureConfigurationsHasBeenSet = true; m_featureConfigurations = value; } /** *

The embedding configuration of an embedded Amazon QuickSight console.

*/ inline void SetFeatureConfigurations(RegisteredUserConsoleFeatureConfigurations&& value) { m_featureConfigurationsHasBeenSet = true; m_featureConfigurations = std::move(value); } /** *

The embedding configuration of an embedded Amazon QuickSight console.

*/ inline RegisteredUserQuickSightConsoleEmbeddingConfiguration& WithFeatureConfigurations(const RegisteredUserConsoleFeatureConfigurations& value) { SetFeatureConfigurations(value); return *this;} /** *

The embedding configuration of an embedded Amazon QuickSight console.

*/ inline RegisteredUserQuickSightConsoleEmbeddingConfiguration& WithFeatureConfigurations(RegisteredUserConsoleFeatureConfigurations&& value) { SetFeatureConfigurations(std::move(value)); return *this;} private: Aws::String m_initialPath; bool m_initialPathHasBeenSet = false; RegisteredUserConsoleFeatureConfigurations m_featureConfigurations; bool m_featureConfigurationsHasBeenSet = false; }; } // namespace Model } // namespace QuickSight } // namespace Aws