Interface CreatePresignedDomainUrlRequest.Builder

    • Method Detail

      • userProfileName

        CreatePresignedDomainUrlRequest.Builder userProfileName​(String userProfileName)

        The name of the UserProfile to sign-in as.

        Parameters:
        userProfileName - The name of the UserProfile to sign-in as.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • sessionExpirationDurationInSeconds

        CreatePresignedDomainUrlRequest.Builder sessionExpirationDurationInSeconds​(Integer sessionExpirationDurationInSeconds)

        The session expiration duration in seconds. This value defaults to 43200.

        Parameters:
        sessionExpirationDurationInSeconds - The session expiration duration in seconds. This value defaults to 43200.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • expiresInSeconds

        CreatePresignedDomainUrlRequest.Builder expiresInSeconds​(Integer expiresInSeconds)

        The number of seconds until the pre-signed URL expires. This value defaults to 300.

        Parameters:
        expiresInSeconds - The number of seconds until the pre-signed URL expires. This value defaults to 300.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • spaceName

        CreatePresignedDomainUrlRequest.Builder spaceName​(String spaceName)

        The name of the space.

        Parameters:
        spaceName - The name of the space.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • landingUri

        CreatePresignedDomainUrlRequest.Builder landingUri​(String landingUri)

        The landing page that the user is directed to when accessing the presigned URL. Using this value, users can access Studio or Studio Classic, even if it is not the default experience for the domain. The supported values are:

        • studio::relative/path: Directs users to the relative path in Studio.

        • app:JupyterServer:relative/path: Directs users to the relative path in the Studio Classic application.

        • app:JupyterLab:relative/path: Directs users to the relative path in the JupyterLab application.

        • app:RStudioServerPro:relative/path: Directs users to the relative path in the RStudio application.

        • app:CodeEditor:relative/path: Directs users to the relative path in the Code Editor, based on Code-OSS, Visual Studio Code - Open Source application.

        • app:Canvas:relative/path: Directs users to the relative path in the Canvas application.

        Parameters:
        landingUri - The landing page that the user is directed to when accessing the presigned URL. Using this value, users can access Studio or Studio Classic, even if it is not the default experience for the domain. The supported values are:

        • studio::relative/path: Directs users to the relative path in Studio.

        • app:JupyterServer:relative/path: Directs users to the relative path in the Studio Classic application.

        • app:JupyterLab:relative/path: Directs users to the relative path in the JupyterLab application.

        • app:RStudioServerPro:relative/path: Directs users to the relative path in the RStudio application.

        • app:CodeEditor:relative/path: Directs users to the relative path in the Code Editor, based on Code-OSS, Visual Studio Code - Open Source application.

        • app:Canvas:relative/path: Directs users to the relative path in the Canvas application.

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