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

Interface Portal.Builder

    • Method Detail

      • additionalEncryptionContext

        Portal.Builder additionalEncryptionContext​(Map<String,​String> additionalEncryptionContext)

        The additional encryption context of the portal.

        Parameters:
        additionalEncryptionContext - The additional encryption context of the portal.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • authenticationType

        Portal.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. 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. 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, AuthenticationType

      • authenticationType

        Portal.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. 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. 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, AuthenticationType

      • browserSettingsArn

        Portal.Builder browserSettingsArn​(String browserSettingsArn)

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

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

      • browserType

        Portal.Builder browserType​(String browserType)

        The browser that users see when using a streaming session.

        Parameters:
        browserType - The browser that users see when using a streaming session.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        BrowserType, BrowserType

      • browserType

        Portal.Builder browserType​(BrowserType browserType)

        The browser that users see when using a streaming session.

        Parameters:
        browserType - The browser that users see when using a streaming session.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        BrowserType, BrowserType

      • creationDate

        Portal.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.

      • customerManagedKey

        Portal.Builder customerManagedKey​(String customerManagedKey)

        The customer managed key used to encrypt sensitive information in the portal.

        Parameters:
        customerManagedKey - The customer managed key used to encrypt sensitive information in the portal.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • dataProtectionSettingsArn

        Portal.Builder dataProtectionSettingsArn​(String dataProtectionSettingsArn)

        The ARN of the data protection settings.

        Parameters:
        dataProtectionSettingsArn - The ARN of the data protection settings.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • displayName

        Portal.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

        Portal.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, InstanceType

      • instanceType

        Portal.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:
        InstanceType, InstanceType

      • ipAccessSettingsArn

        Portal.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

        Portal.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

        Portal.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

        Portal.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

        Portal.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

        Portal.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, PortalStatus

      • portalStatus

        Portal.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:
        PortalStatus, PortalStatus

      • rendererType

        Portal.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, RendererType

      • rendererType

        Portal.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:
        RendererType, RendererType

      • statusReason

        Portal.Builder statusReason​(String statusReason)

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

        Parameters:
        statusReason - A message that explains why the web portal is in its current status.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • trustStoreArn

        Portal.Builder trustStoreArn​(String trustStoreArn)

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

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

      • userAccessLoggingSettingsArn

        Portal.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

        Portal.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.