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

The summary of the portal.

See Also:

AWS * API Reference

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

The type of authentication integration points used when signing into the web * portal. Defaults to Standard.

Standard web * portals are authenticated directly through your identity provider. You need to * call CreateIdentityProvider to integrate your identity provider * with your web portal. User and group access to your web portal is controlled * through your identity provider.

IAM_Identity_Center web * portals are authenticated through AWS IAM Identity Center (successor to AWS * Single Sign-On). They provide additional features, such as IdP-initiated * authentication. Identity sources (including external identity provider * integration), plus user and group access to your web portal, can be configured * in the IAM Identity Center.

*/ inline const AuthenticationType& GetAuthenticationType() const{ return m_authenticationType; } /** *

The type of authentication integration points used when signing into the web * portal. Defaults to Standard.

Standard web * portals are authenticated directly through your identity provider. You need to * call CreateIdentityProvider to integrate your identity provider * with your web portal. User and group access to your web portal is controlled * through your identity provider.

IAM_Identity_Center web * portals are authenticated through AWS IAM Identity Center (successor to AWS * Single Sign-On). They provide additional features, such as IdP-initiated * authentication. Identity sources (including external identity provider * integration), plus user and group access to your web portal, can be configured * in the IAM Identity Center.

*/ inline bool AuthenticationTypeHasBeenSet() const { return m_authenticationTypeHasBeenSet; } /** *

The type of authentication integration points used when signing into the web * portal. Defaults to Standard.

Standard web * portals are authenticated directly through your identity provider. You need to * call CreateIdentityProvider to integrate your identity provider * with your web portal. User and group access to your web portal is controlled * through your identity provider.

IAM_Identity_Center web * portals are authenticated through AWS IAM Identity Center (successor to AWS * Single Sign-On). They provide additional features, such as IdP-initiated * authentication. Identity sources (including external identity provider * integration), plus user and group access to your web portal, can be configured * in the IAM Identity Center.

*/ inline void SetAuthenticationType(const AuthenticationType& value) { m_authenticationTypeHasBeenSet = true; m_authenticationType = value; } /** *

The type of authentication integration points used when signing into the web * portal. Defaults to Standard.

Standard web * portals are authenticated directly through your identity provider. You need to * call CreateIdentityProvider to integrate your identity provider * with your web portal. User and group access to your web portal is controlled * through your identity provider.

IAM_Identity_Center web * portals are authenticated through AWS IAM Identity Center (successor to AWS * Single Sign-On). They provide additional features, such as IdP-initiated * authentication. Identity sources (including external identity provider * integration), plus user and group access to your web portal, can be configured * in the IAM Identity Center.

*/ inline void SetAuthenticationType(AuthenticationType&& value) { m_authenticationTypeHasBeenSet = true; m_authenticationType = std::move(value); } /** *

The type of authentication integration points used when signing into the web * portal. Defaults to Standard.

Standard web * portals are authenticated directly through your identity provider. You need to * call CreateIdentityProvider to integrate your identity provider * with your web portal. User and group access to your web portal is controlled * through your identity provider.

IAM_Identity_Center web * portals are authenticated through AWS IAM Identity Center (successor to AWS * Single Sign-On). They provide additional features, such as IdP-initiated * authentication. Identity sources (including external identity provider * integration), plus user and group access to your web portal, can be configured * in the IAM Identity Center.

*/ inline PortalSummary& WithAuthenticationType(const AuthenticationType& value) { SetAuthenticationType(value); return *this;} /** *

The type of authentication integration points used when signing into the web * portal. Defaults to Standard.

Standard web * portals are authenticated directly through your identity provider. You need to * call CreateIdentityProvider to integrate your identity provider * with your web portal. User and group access to your web portal is controlled * through your identity provider.

IAM_Identity_Center web * portals are authenticated through AWS IAM Identity Center (successor to AWS * Single Sign-On). They provide additional features, such as IdP-initiated * authentication. Identity sources (including external identity provider * integration), plus user and group access to your web portal, can be configured * in the IAM Identity Center.

*/ inline PortalSummary& WithAuthenticationType(AuthenticationType&& value) { SetAuthenticationType(std::move(value)); return *this;} /** *

The ARN of the browser settings that is associated with the web portal.

*/ inline const Aws::String& GetBrowserSettingsArn() const{ return m_browserSettingsArn; } /** *

The ARN of the browser settings that is associated with the web portal.

*/ inline bool BrowserSettingsArnHasBeenSet() const { return m_browserSettingsArnHasBeenSet; } /** *

The ARN of the browser settings that is associated with the web portal.

*/ inline void SetBrowserSettingsArn(const Aws::String& value) { m_browserSettingsArnHasBeenSet = true; m_browserSettingsArn = value; } /** *

The ARN of the browser settings that is associated with the web portal.

*/ inline void SetBrowserSettingsArn(Aws::String&& value) { m_browserSettingsArnHasBeenSet = true; m_browserSettingsArn = std::move(value); } /** *

The ARN of the browser settings that is associated with the web portal.

*/ inline void SetBrowserSettingsArn(const char* value) { m_browserSettingsArnHasBeenSet = true; m_browserSettingsArn.assign(value); } /** *

The ARN of the browser settings that is associated with the web portal.

*/ inline PortalSummary& WithBrowserSettingsArn(const Aws::String& value) { SetBrowserSettingsArn(value); return *this;} /** *

The ARN of the browser settings that is associated with the web portal.

*/ inline PortalSummary& WithBrowserSettingsArn(Aws::String&& value) { SetBrowserSettingsArn(std::move(value)); return *this;} /** *

The ARN of the browser settings that is associated with the web portal.

*/ inline PortalSummary& WithBrowserSettingsArn(const char* value) { SetBrowserSettingsArn(value); return *this;} /** *

The browser type of the web portal.

*/ inline const BrowserType& GetBrowserType() const{ return m_browserType; } /** *

The browser type of the web portal.

*/ inline bool BrowserTypeHasBeenSet() const { return m_browserTypeHasBeenSet; } /** *

The browser type of the web portal.

*/ inline void SetBrowserType(const BrowserType& value) { m_browserTypeHasBeenSet = true; m_browserType = value; } /** *

The browser type of the web portal.

*/ inline void SetBrowserType(BrowserType&& value) { m_browserTypeHasBeenSet = true; m_browserType = std::move(value); } /** *

The browser type of the web portal.

*/ inline PortalSummary& WithBrowserType(const BrowserType& value) { SetBrowserType(value); return *this;} /** *

The browser type of the web portal.

*/ inline PortalSummary& WithBrowserType(BrowserType&& value) { SetBrowserType(std::move(value)); return *this;} /** *

The creation date of the web portal.

*/ inline const Aws::Utils::DateTime& GetCreationDate() const{ return m_creationDate; } /** *

The creation date of the web portal.

*/ inline bool CreationDateHasBeenSet() const { return m_creationDateHasBeenSet; } /** *

The creation date of the web portal.

*/ inline void SetCreationDate(const Aws::Utils::DateTime& value) { m_creationDateHasBeenSet = true; m_creationDate = value; } /** *

The creation date of the web portal.

*/ inline void SetCreationDate(Aws::Utils::DateTime&& value) { m_creationDateHasBeenSet = true; m_creationDate = std::move(value); } /** *

The creation date of the web portal.

*/ inline PortalSummary& WithCreationDate(const Aws::Utils::DateTime& value) { SetCreationDate(value); return *this;} /** *

The creation date of the web portal.

*/ inline PortalSummary& WithCreationDate(Aws::Utils::DateTime&& value) { SetCreationDate(std::move(value)); return *this;} /** *

The name of the web portal.

*/ inline const Aws::String& GetDisplayName() const{ return m_displayName; } /** *

The name of the web portal.

*/ inline bool DisplayNameHasBeenSet() const { return m_displayNameHasBeenSet; } /** *

The name of the web portal.

*/ inline void SetDisplayName(const Aws::String& value) { m_displayNameHasBeenSet = true; m_displayName = value; } /** *

The name of the web portal.

*/ inline void SetDisplayName(Aws::String&& value) { m_displayNameHasBeenSet = true; m_displayName = std::move(value); } /** *

The name of the web portal.

*/ inline void SetDisplayName(const char* value) { m_displayNameHasBeenSet = true; m_displayName.assign(value); } /** *

The name of the web portal.

*/ inline PortalSummary& WithDisplayName(const Aws::String& value) { SetDisplayName(value); return *this;} /** *

The name of the web portal.

*/ inline PortalSummary& WithDisplayName(Aws::String&& value) { SetDisplayName(std::move(value)); return *this;} /** *

The name of the web portal.

*/ inline PortalSummary& WithDisplayName(const char* value) { SetDisplayName(value); return *this;} /** *

The ARN of the IP access settings.

*/ inline const Aws::String& GetIpAccessSettingsArn() const{ return m_ipAccessSettingsArn; } /** *

The ARN of the IP access settings.

*/ inline bool IpAccessSettingsArnHasBeenSet() const { return m_ipAccessSettingsArnHasBeenSet; } /** *

The ARN of the IP access settings.

*/ inline void SetIpAccessSettingsArn(const Aws::String& value) { m_ipAccessSettingsArnHasBeenSet = true; m_ipAccessSettingsArn = value; } /** *

The ARN of the IP access settings.

*/ inline void SetIpAccessSettingsArn(Aws::String&& value) { m_ipAccessSettingsArnHasBeenSet = true; m_ipAccessSettingsArn = std::move(value); } /** *

The ARN of the IP access settings.

*/ inline void SetIpAccessSettingsArn(const char* value) { m_ipAccessSettingsArnHasBeenSet = true; m_ipAccessSettingsArn.assign(value); } /** *

The ARN of the IP access settings.

*/ inline PortalSummary& WithIpAccessSettingsArn(const Aws::String& value) { SetIpAccessSettingsArn(value); return *this;} /** *

The ARN of the IP access settings.

*/ inline PortalSummary& WithIpAccessSettingsArn(Aws::String&& value) { SetIpAccessSettingsArn(std::move(value)); return *this;} /** *

The ARN of the IP access settings.

*/ inline PortalSummary& WithIpAccessSettingsArn(const char* value) { SetIpAccessSettingsArn(value); return *this;} /** *

The ARN of the network settings that is associated with the web portal.

*/ inline const Aws::String& GetNetworkSettingsArn() const{ return m_networkSettingsArn; } /** *

The ARN of the network settings that is associated with the web portal.

*/ inline bool NetworkSettingsArnHasBeenSet() const { return m_networkSettingsArnHasBeenSet; } /** *

The ARN of the network settings that is associated with the web portal.

*/ inline void SetNetworkSettingsArn(const Aws::String& value) { m_networkSettingsArnHasBeenSet = true; m_networkSettingsArn = value; } /** *

The ARN of the network settings that is associated with the web portal.

*/ inline void SetNetworkSettingsArn(Aws::String&& value) { m_networkSettingsArnHasBeenSet = true; m_networkSettingsArn = std::move(value); } /** *

The ARN of the network settings that is associated with the web portal.

*/ inline void SetNetworkSettingsArn(const char* value) { m_networkSettingsArnHasBeenSet = true; m_networkSettingsArn.assign(value); } /** *

The ARN of the network settings that is associated with the web portal.

*/ inline PortalSummary& WithNetworkSettingsArn(const Aws::String& value) { SetNetworkSettingsArn(value); return *this;} /** *

The ARN of the network settings that is associated with the web portal.

*/ inline PortalSummary& WithNetworkSettingsArn(Aws::String&& value) { SetNetworkSettingsArn(std::move(value)); return *this;} /** *

The ARN of the network settings that is associated with the web portal.

*/ inline PortalSummary& WithNetworkSettingsArn(const char* value) { SetNetworkSettingsArn(value); return *this;} /** *

The ARN of the web portal.

*/ inline const Aws::String& GetPortalArn() const{ return m_portalArn; } /** *

The ARN of the web portal.

*/ inline bool PortalArnHasBeenSet() const { return m_portalArnHasBeenSet; } /** *

The ARN of the web portal.

*/ inline void SetPortalArn(const Aws::String& value) { m_portalArnHasBeenSet = true; m_portalArn = value; } /** *

The ARN of the web portal.

*/ inline void SetPortalArn(Aws::String&& value) { m_portalArnHasBeenSet = true; m_portalArn = std::move(value); } /** *

The ARN of the web portal.

*/ inline void SetPortalArn(const char* value) { m_portalArnHasBeenSet = true; m_portalArn.assign(value); } /** *

The ARN of the web portal.

*/ inline PortalSummary& WithPortalArn(const Aws::String& value) { SetPortalArn(value); return *this;} /** *

The ARN of the web portal.

*/ inline PortalSummary& WithPortalArn(Aws::String&& value) { SetPortalArn(std::move(value)); return *this;} /** *

The ARN of the web portal.

*/ inline PortalSummary& WithPortalArn(const char* value) { SetPortalArn(value); return *this;} /** *

The endpoint URL of the web portal that users access in order to start * streaming sessions.

*/ inline const Aws::String& GetPortalEndpoint() const{ return m_portalEndpoint; } /** *

The endpoint URL of the web portal that users access in order to start * streaming sessions.

*/ inline bool PortalEndpointHasBeenSet() const { return m_portalEndpointHasBeenSet; } /** *

The endpoint URL of the web portal that users access in order to start * streaming sessions.

*/ inline void SetPortalEndpoint(const Aws::String& value) { m_portalEndpointHasBeenSet = true; m_portalEndpoint = value; } /** *

The endpoint URL of the web portal that users access in order to start * streaming sessions.

*/ inline void SetPortalEndpoint(Aws::String&& value) { m_portalEndpointHasBeenSet = true; m_portalEndpoint = std::move(value); } /** *

The endpoint URL of the web portal that users access in order to start * streaming sessions.

*/ inline void SetPortalEndpoint(const char* value) { m_portalEndpointHasBeenSet = true; m_portalEndpoint.assign(value); } /** *

The endpoint URL of the web portal that users access in order to start * streaming sessions.

*/ inline PortalSummary& WithPortalEndpoint(const Aws::String& value) { SetPortalEndpoint(value); return *this;} /** *

The endpoint URL of the web portal that users access in order to start * streaming sessions.

*/ inline PortalSummary& WithPortalEndpoint(Aws::String&& value) { SetPortalEndpoint(std::move(value)); return *this;} /** *

The endpoint URL of the web portal that users access in order to start * streaming sessions.

*/ inline PortalSummary& WithPortalEndpoint(const char* value) { SetPortalEndpoint(value); return *this;} /** *

The status of the web portal.

*/ inline const PortalStatus& GetPortalStatus() const{ return m_portalStatus; } /** *

The status of the web portal.

*/ inline bool PortalStatusHasBeenSet() const { return m_portalStatusHasBeenSet; } /** *

The status of the web portal.

*/ inline void SetPortalStatus(const PortalStatus& value) { m_portalStatusHasBeenSet = true; m_portalStatus = value; } /** *

The status of the web portal.

*/ inline void SetPortalStatus(PortalStatus&& value) { m_portalStatusHasBeenSet = true; m_portalStatus = std::move(value); } /** *

The status of the web portal.

*/ inline PortalSummary& WithPortalStatus(const PortalStatus& value) { SetPortalStatus(value); return *this;} /** *

The status of the web portal.

*/ inline PortalSummary& WithPortalStatus(PortalStatus&& value) { SetPortalStatus(std::move(value)); return *this;} /** *

The renderer that is used in streaming sessions.

*/ inline const RendererType& GetRendererType() const{ return m_rendererType; } /** *

The renderer that is used in streaming sessions.

*/ inline bool RendererTypeHasBeenSet() const { return m_rendererTypeHasBeenSet; } /** *

The renderer that is used in streaming sessions.

*/ inline void SetRendererType(const RendererType& value) { m_rendererTypeHasBeenSet = true; m_rendererType = value; } /** *

The renderer that is used in streaming sessions.

*/ inline void SetRendererType(RendererType&& value) { m_rendererTypeHasBeenSet = true; m_rendererType = std::move(value); } /** *

The renderer that is used in streaming sessions.

*/ inline PortalSummary& WithRendererType(const RendererType& value) { SetRendererType(value); return *this;} /** *

The renderer that is used in streaming sessions.

*/ inline PortalSummary& WithRendererType(RendererType&& value) { SetRendererType(std::move(value)); return *this;} /** *

The ARN of the trust that is associated with this web portal.

*/ inline const Aws::String& GetTrustStoreArn() const{ return m_trustStoreArn; } /** *

The ARN of the trust that is associated with this web portal.

*/ inline bool TrustStoreArnHasBeenSet() const { return m_trustStoreArnHasBeenSet; } /** *

The ARN of the trust that is associated with this web portal.

*/ inline void SetTrustStoreArn(const Aws::String& value) { m_trustStoreArnHasBeenSet = true; m_trustStoreArn = value; } /** *

The ARN of the trust that is associated with this web portal.

*/ inline void SetTrustStoreArn(Aws::String&& value) { m_trustStoreArnHasBeenSet = true; m_trustStoreArn = std::move(value); } /** *

The ARN of the trust that is associated with this web portal.

*/ inline void SetTrustStoreArn(const char* value) { m_trustStoreArnHasBeenSet = true; m_trustStoreArn.assign(value); } /** *

The ARN of the trust that is associated with this web portal.

*/ inline PortalSummary& WithTrustStoreArn(const Aws::String& value) { SetTrustStoreArn(value); return *this;} /** *

The ARN of the trust that is associated with this web portal.

*/ inline PortalSummary& WithTrustStoreArn(Aws::String&& value) { SetTrustStoreArn(std::move(value)); return *this;} /** *

The ARN of the trust that is associated with this web portal.

*/ inline PortalSummary& WithTrustStoreArn(const char* value) { SetTrustStoreArn(value); return *this;} /** *

The ARN of the user access logging settings that is associated with the web * portal.

*/ inline const Aws::String& GetUserAccessLoggingSettingsArn() const{ return m_userAccessLoggingSettingsArn; } /** *

The ARN of the user access logging settings that is associated with the web * portal.

*/ inline bool UserAccessLoggingSettingsArnHasBeenSet() const { return m_userAccessLoggingSettingsArnHasBeenSet; } /** *

The ARN of the user access logging settings that is associated with the web * portal.

*/ inline void SetUserAccessLoggingSettingsArn(const Aws::String& value) { m_userAccessLoggingSettingsArnHasBeenSet = true; m_userAccessLoggingSettingsArn = value; } /** *

The ARN of the user access logging settings that is associated with the web * portal.

*/ inline void SetUserAccessLoggingSettingsArn(Aws::String&& value) { m_userAccessLoggingSettingsArnHasBeenSet = true; m_userAccessLoggingSettingsArn = std::move(value); } /** *

The ARN of the user access logging settings that is associated with the web * portal.

*/ inline void SetUserAccessLoggingSettingsArn(const char* value) { m_userAccessLoggingSettingsArnHasBeenSet = true; m_userAccessLoggingSettingsArn.assign(value); } /** *

The ARN of the user access logging settings that is associated with the web * portal.

*/ inline PortalSummary& WithUserAccessLoggingSettingsArn(const Aws::String& value) { SetUserAccessLoggingSettingsArn(value); return *this;} /** *

The ARN of the user access logging settings that is associated with the web * portal.

*/ inline PortalSummary& WithUserAccessLoggingSettingsArn(Aws::String&& value) { SetUserAccessLoggingSettingsArn(std::move(value)); return *this;} /** *

The ARN of the user access logging settings that is associated with the web * portal.

*/ inline PortalSummary& WithUserAccessLoggingSettingsArn(const char* value) { SetUserAccessLoggingSettingsArn(value); return *this;} /** *

The ARN of the user settings that is associated with the web portal.

*/ inline const Aws::String& GetUserSettingsArn() const{ return m_userSettingsArn; } /** *

The ARN of the user settings that is associated with the web portal.

*/ inline bool UserSettingsArnHasBeenSet() const { return m_userSettingsArnHasBeenSet; } /** *

The ARN of the user settings that is associated with the web portal.

*/ inline void SetUserSettingsArn(const Aws::String& value) { m_userSettingsArnHasBeenSet = true; m_userSettingsArn = value; } /** *

The ARN of the user settings that is associated with the web portal.

*/ inline void SetUserSettingsArn(Aws::String&& value) { m_userSettingsArnHasBeenSet = true; m_userSettingsArn = std::move(value); } /** *

The ARN of the user settings that is associated with the web portal.

*/ inline void SetUserSettingsArn(const char* value) { m_userSettingsArnHasBeenSet = true; m_userSettingsArn.assign(value); } /** *

The ARN of the user settings that is associated with the web portal.

*/ inline PortalSummary& WithUserSettingsArn(const Aws::String& value) { SetUserSettingsArn(value); return *this;} /** *

The ARN of the user settings that is associated with the web portal.

*/ inline PortalSummary& WithUserSettingsArn(Aws::String&& value) { SetUserSettingsArn(std::move(value)); return *this;} /** *

The ARN of the user settings that is associated with the web portal.

*/ inline PortalSummary& WithUserSettingsArn(const char* value) { SetUserSettingsArn(value); return *this;} private: AuthenticationType m_authenticationType; bool m_authenticationTypeHasBeenSet = false; Aws::String m_browserSettingsArn; bool m_browserSettingsArnHasBeenSet = false; BrowserType m_browserType; bool m_browserTypeHasBeenSet = false; Aws::Utils::DateTime m_creationDate; bool m_creationDateHasBeenSet = false; Aws::String m_displayName; bool m_displayNameHasBeenSet = false; Aws::String m_ipAccessSettingsArn; bool m_ipAccessSettingsArnHasBeenSet = false; Aws::String m_networkSettingsArn; bool m_networkSettingsArnHasBeenSet = false; Aws::String m_portalArn; bool m_portalArnHasBeenSet = false; Aws::String m_portalEndpoint; bool m_portalEndpointHasBeenSet = false; PortalStatus m_portalStatus; bool m_portalStatusHasBeenSet = false; RendererType m_rendererType; bool m_rendererTypeHasBeenSet = false; Aws::String m_trustStoreArn; bool m_trustStoreArnHasBeenSet = false; Aws::String m_userAccessLoggingSettingsArn; bool m_userAccessLoggingSettingsArnHasBeenSet = false; Aws::String m_userSettingsArn; bool m_userSettingsArnHasBeenSet = false; }; } // namespace Model } // namespace WorkSpacesWeb } // namespace Aws