Skip to content

Update Portal

workspacesweb_update_portal R Documentation

Updates a web portal

Description

Updates a web portal.

Usage

workspacesweb_update_portal(portalArn, displayName, authenticationType,
  instanceType, maxConcurrentSessions, portalCustomDomain)

Arguments

portalArn

[required] The ARN of the web portal.
displayName

The name of the web portal. This is not visible to users who log into the web portal.
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 create_identity_provider 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 IAM Identity Center. Identity sources (including external identity provider integration), plus user and group access to your web portal, can be configured in the IAM Identity Center.
instanceType

The type and resources of the underlying instance.
maxConcurrentSessions

The maximum number of concurrent sessions for the portal.
portalCustomDomain

The custom domain of the web portal that users access in order to start streaming sessions.

Value

A list with the following syntax:

list(
  portal = list(
    portalArn = "string",
    rendererType = "AppStream",
    browserType = "Chrome",
    portalStatus = "Incomplete"|"Pending"|"Active",
    portalEndpoint = "string",
    displayName = "string",
    creationDate = as.POSIXct(
      "2015-01-01"
    ),
    browserSettingsArn = "string",
    dataProtectionSettingsArn = "string",
    userSettingsArn = "string",
    networkSettingsArn = "string",
    sessionLoggerArn = "string",
    trustStoreArn = "string",
    statusReason = "string",
    userAccessLoggingSettingsArn = "string",
    authenticationType = "Standard"|"IAM_Identity_Center",
    ipAccessSettingsArn = "string",
    customerManagedKey = "string",
    additionalEncryptionContext = list(
      "string"
    ),
    instanceType = "standard.regular"|"standard.large"|"standard.xlarge",
    maxConcurrentSessions = 123,
    portalCustomDomain = "string"
  )
)

Request syntax

svc$update_portal(
  portalArn = "string",
  displayName = "string",
  authenticationType = "Standard"|"IAM_Identity_Center",
  instanceType = "standard.regular"|"standard.large"|"standard.xlarge",
  maxConcurrentSessions = 123,
  portalCustomDomain = "string"
)