GetPortalResult

data class GetPortalResult(val authenticationType: PortalAuthenticationType? = null, val browserSettingsArn: String? = null, val browserType: PortalBrowserType? = null, val creationDate: String? = null, val displayName: String? = null, val instanceType: PortalInstanceType? = null, val ipAccessSettingsArn: String? = null, val maxConcurrentSessions: Double? = null, val networkSettingsArn: String? = null, val portalArn: String? = null, val portalEndpoint: String? = null, val portalStatus: PortalStatus? = null, val rendererType: PortalRendererType? = null, val serviceProviderSamlMetadata: String? = null, val statusReason: String? = null, val tags: List<Tag>? = null, val trustStoreArn: String? = null, val userAccessLoggingSettingsArn: String? = null, val userSettingsArn: String? = null)

Constructors

Link copied to clipboard
constructor(authenticationType: PortalAuthenticationType? = null, browserSettingsArn: String? = null, browserType: PortalBrowserType? = null, creationDate: String? = null, displayName: String? = null, instanceType: PortalInstanceType? = null, ipAccessSettingsArn: String? = null, maxConcurrentSessions: Double? = null, networkSettingsArn: String? = null, portalArn: String? = null, portalEndpoint: String? = null, portalStatus: PortalStatus? = null, rendererType: PortalRendererType? = null, serviceProviderSamlMetadata: String? = null, statusReason: String? = null, tags: List<Tag>? = null, trustStoreArn: String? = null, userAccessLoggingSettingsArn: String? = null, userSettingsArn: String? = null)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard

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 (IdP). User and group access to your web portal is controlled through your IdP. You need to include an IdP resource in your template to integrate your IdP with your web portal. Completing the configuration for your IdP requires exchanging WorkSpaces Secure Browser’s SP metadata with your IdP’s IdP metadata. If your IdP requires the SP metadata first before returning the IdP metadata, you should follow these steps:

Link copied to clipboard

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

Link copied to clipboard

The browser that users see when using a streaming session.

Link copied to clipboard
val creationDate: String? = null

The creation date of the web portal.

Link copied to clipboard
val displayName: String? = null

The name of the web portal.

Link copied to clipboard

The type and resources of the underlying instance.

Link copied to clipboard

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

Link copied to clipboard

The maximum number of concurrent sessions for the portal.

Link copied to clipboard

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

Link copied to clipboard
val portalArn: String? = null

The ARN of the web portal.

Link copied to clipboard
val portalEndpoint: String? = null

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

Link copied to clipboard

The status of the web portal.

Link copied to clipboard

The renderer that is used in streaming sessions.

Link copied to clipboard

The SAML metadata of the service provider.

Link copied to clipboard
val statusReason: String? = null

A message that explains why the web portal is in its current status.

Link copied to clipboard
val tags: List<Tag>? = null

The tags to add to the web portal. A tag is a key-value pair.

Link copied to clipboard
val trustStoreArn: String? = null

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

Link copied to clipboard

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

Link copied to clipboard
val userSettingsArn: String? = null

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