Skip to content

UpdatePortalRequest

Source code in docs_src/capo_workspaces_web/types/update_portal_request.py
class UpdatePortalRequest(TypedDict, closed=True):
    portal_arn: "capo_workspaces_web.types.arn.ARN"
    """<p>The ARN of the web portal.</p>"""
    display_name: NotRequired["capo_workspaces_web.types.display_name.DisplayName"]
    """<p>The name of the web portal. This is not visible to users who log into the web portal.</p>"""
    authentication_type: NotRequired[
        "capo_workspaces_web.types.authentication_type.AuthenticationType"
    ]
    """<p>The type of authentication integration points used when signing into the web portal. Defaults to <code>Standard</code>.</p> <p> <code>Standard</code> web portals are authenticated directly through your identity provider. You need to call <code>CreateIdentityProvider</code> to integrate your identity provider with your web portal. User and group access to your web portal is controlled through your identity provider.</p> <p> <code>IAM Identity Center</code> 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.</p>"""
    instance_type: NotRequired["capo_workspaces_web.types.instance_type.InstanceType"]
    """<p>The type and resources of the underlying instance.</p>"""
    max_concurrent_sessions: NotRequired[
        "capo_workspaces_web.types.max_concurrent_sessions.MaxConcurrentSessions"
    ]
    """<p>The maximum number of concurrent sessions for the portal.</p>"""
    portal_custom_domain: NotRequired[
        "capo_workspaces_web.types.portal_custom_domain.PortalCustomDomain"
    ]
    """<p>The custom domain of the web portal that users access in order to start streaming sessions. </p>"""

authentication_type instance-attribute

authentication_type: NotRequired[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 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.

display_name instance-attribute

display_name: NotRequired[DisplayName]

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

instance_type instance-attribute

instance_type: NotRequired[InstanceType]

The type and resources of the underlying instance.

max_concurrent_sessions instance-attribute

max_concurrent_sessions: NotRequired[MaxConcurrentSessions]

The maximum number of concurrent sessions for the portal.

portal_arn instance-attribute

portal_arn: ARN

The ARN of the web portal.

portal_custom_domain instance-attribute

portal_custom_domain: NotRequired[PortalCustomDomain]

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