Skip to content

Create Portal

workspacesweb_create_portal R Documentation

Creates a web portal

Description

Creates a web portal.

Usage

workspacesweb_create_portal(displayName, tags, customerManagedKey,
  additionalEncryptionContext, clientToken, authenticationType,
  instanceType, maxConcurrentSessions, portalCustomDomain)

Arguments

displayName

The name of the web portal. This is not visible to users who log into the web portal.
tags

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

The customer managed key of the web portal.
additionalEncryptionContext

The additional encryption context of the portal.
clientToken

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token returns the result from the original successful request.

If you do not specify a client token, one is automatically generated by the Amazon Web Services SDK.
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(
  portalArn = "string",
  portalEndpoint = "string"
)

Request syntax

svc$create_portal(
  displayName = "string",
  tags = list(
    list(
      Key = "string",
      Value = "string"
    )
  ),
  customerManagedKey = "string",
  additionalEncryptionContext = list(
    "string"
  ),
  clientToken = "string",
  authenticationType = "Standard"|"IAM_Identity_Center",
  instanceType = "standard.regular"|"standard.large"|"standard.xlarge",
  maxConcurrentSessions = 123,
  portalCustomDomain = "string"
)