Package software.amazon.awssdk.services.workspacesweb.model

Interface PortalSummary.Builder

All Superinterfaces:
Buildable, CopyableBuilder<PortalSummary.Builder,PortalSummary>, SdkBuilder<PortalSummary.Builder,PortalSummary>, SdkPojo
Enclosing class:
PortalSummary
public static interface PortalSummary.Builder extends SdkPojo, CopyableBuilder<PortalSummary.Builder,PortalSummary>

  • Method Details

    • authenticationType

      PortalSummary.Builder authenticationType(String 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 (successor to Single Sign-On). Identity sources (including external identity provider integration), plus user and group access to your web portal, can be configured in the IAM Identity Center.

      Parameters:
      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 (successor to Single Sign-On). Identity sources (including external identity provider integration), plus user and group access to your web portal, can be configured in the IAM Identity Center.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • authenticationType

      PortalSummary.Builder authenticationType(AuthenticationType 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 (successor to Single Sign-On). Identity sources (including external identity provider integration), plus user and group access to your web portal, can be configured in the IAM Identity Center.

      Parameters:
      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 (successor to Single Sign-On). Identity sources (including external identity provider integration), plus user and group access to your web portal, can be configured in the IAM Identity Center.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • browserSettingsArn

      PortalSummary.Builder browserSettingsArn(String browserSettingsArn)

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

      Parameters:
      browserSettingsArn - The ARN of the browser settings that is associated with the web portal.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • browserType

      PortalSummary.Builder browserType(String browserType)

      The browser type of the web portal.

      Parameters:
      browserType - The browser type of the web portal.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • browserType

      PortalSummary.Builder browserType(BrowserType browserType)

      The browser type of the web portal.

      Parameters:
      browserType - The browser type of the web portal.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • creationDate

      PortalSummary.Builder creationDate(Instant creationDate)

      The creation date of the web portal.

      Parameters:
      creationDate - The creation date of the web portal.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • displayName

      PortalSummary.Builder displayName(String displayName)

      The name of the web portal.

      Parameters:
      displayName - The name of the web portal.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • instanceType

      PortalSummary.Builder instanceType(String instanceType)

      The type and resources of the underlying instance.

      Parameters:
      instanceType - The type and resources of the underlying instance.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • instanceType

      PortalSummary.Builder instanceType(InstanceType instanceType)

      The type and resources of the underlying instance.

      Parameters:
      instanceType - The type and resources of the underlying instance.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • ipAccessSettingsArn

      PortalSummary.Builder ipAccessSettingsArn(String ipAccessSettingsArn)

      The ARN of the IP access settings.

      Parameters:
      ipAccessSettingsArn - The ARN of the IP access settings.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • maxConcurrentSessions

      PortalSummary.Builder maxConcurrentSessions(Integer maxConcurrentSessions)

      The maximum number of concurrent sessions for the portal.

      Parameters:
      maxConcurrentSessions - The maximum number of concurrent sessions for the portal.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • networkSettingsArn

      PortalSummary.Builder networkSettingsArn(String networkSettingsArn)

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

      Parameters:
      networkSettingsArn - The ARN of the network settings that is associated with the web portal.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • portalArn

      PortalSummary.Builder portalArn(String portalArn)

      The ARN of the web portal.

      Parameters:
      portalArn - The ARN of the web portal.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • portalEndpoint

      PortalSummary.Builder portalEndpoint(String portalEndpoint)

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

      Parameters:
      portalEndpoint - The endpoint URL of the web portal that users access in order to start streaming sessions.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • portalStatus

      PortalSummary.Builder portalStatus(String portalStatus)

      The status of the web portal.

      Parameters:
      portalStatus - The status of the web portal.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • portalStatus

      PortalSummary.Builder portalStatus(PortalStatus portalStatus)

      The status of the web portal.

      Parameters:
      portalStatus - The status of the web portal.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • rendererType

      PortalSummary.Builder rendererType(String rendererType)

      The renderer that is used in streaming sessions.

      Parameters:
      rendererType - The renderer that is used in streaming sessions.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • rendererType

      PortalSummary.Builder rendererType(RendererType rendererType)

      The renderer that is used in streaming sessions.

      Parameters:
      rendererType - The renderer that is used in streaming sessions.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • trustStoreArn

      PortalSummary.Builder trustStoreArn(String trustStoreArn)

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

      Parameters:
      trustStoreArn - The ARN of the trust that is associated with this web portal.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • userAccessLoggingSettingsArn

      PortalSummary.Builder userAccessLoggingSettingsArn(String userAccessLoggingSettingsArn)

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

      Parameters:
      userAccessLoggingSettingsArn - The ARN of the user access logging settings that is associated with the web portal.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • userSettingsArn

      PortalSummary.Builder userSettingsArn(String userSettingsArn)

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

      Parameters:
      userSettingsArn - The ARN of the user settings that is associated with the web portal.
      Returns:
      Returns a reference to this object so that method calls can be chained together.