Package software.amazon.awssdk.services.sagemaker.model

Interface UserSettings.Builder

    • Method Detail

      • executionRole

        UserSettings.Builder executionRole​(String executionRole)

        The execution role for the user.

        SageMaker applies this setting only to private spaces that the user creates in the domain. SageMaker doesn't apply this setting to shared spaces.

        Parameters:
        executionRole - The execution role for the user.

        SageMaker applies this setting only to private spaces that the user creates in the domain. SageMaker doesn't apply this setting to shared spaces.

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

      • securityGroups

        UserSettings.Builder securityGroups​(Collection<String> securityGroups)

        The security groups for the Amazon Virtual Private Cloud (VPC) that the domain uses for communication.

        Optional when the CreateDomain.AppNetworkAccessType parameter is set to PublicInternetOnly.

        Required when the CreateDomain.AppNetworkAccessType parameter is set to VpcOnly, unless specified as part of the DefaultUserSettings for the domain.

        Amazon SageMaker AI adds a security group to allow NFS traffic from Amazon SageMaker AI Studio. Therefore, the number of security groups that you can specify is one less than the maximum number shown.

        SageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn't apply these settings to shared spaces.

        Parameters:
        securityGroups - The security groups for the Amazon Virtual Private Cloud (VPC) that the domain uses for communication.

        Optional when the CreateDomain.AppNetworkAccessType parameter is set to PublicInternetOnly.

        Required when the CreateDomain.AppNetworkAccessType parameter is set to VpcOnly, unless specified as part of the DefaultUserSettings for the domain.

        Amazon SageMaker AI adds a security group to allow NFS traffic from Amazon SageMaker AI Studio. Therefore, the number of security groups that you can specify is one less than the maximum number shown.

        SageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn't apply these settings to shared spaces.

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

      • securityGroups

        UserSettings.Builder securityGroups​(String... securityGroups)

        The security groups for the Amazon Virtual Private Cloud (VPC) that the domain uses for communication.

        Optional when the CreateDomain.AppNetworkAccessType parameter is set to PublicInternetOnly.

        Required when the CreateDomain.AppNetworkAccessType parameter is set to VpcOnly, unless specified as part of the DefaultUserSettings for the domain.

        Amazon SageMaker AI adds a security group to allow NFS traffic from Amazon SageMaker AI Studio. Therefore, the number of security groups that you can specify is one less than the maximum number shown.

        SageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn't apply these settings to shared spaces.

        Parameters:
        securityGroups - The security groups for the Amazon Virtual Private Cloud (VPC) that the domain uses for communication.

        Optional when the CreateDomain.AppNetworkAccessType parameter is set to PublicInternetOnly.

        Required when the CreateDomain.AppNetworkAccessType parameter is set to VpcOnly, unless specified as part of the DefaultUserSettings for the domain.

        Amazon SageMaker AI adds a security group to allow NFS traffic from Amazon SageMaker AI Studio. Therefore, the number of security groups that you can specify is one less than the maximum number shown.

        SageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn't apply these settings to shared spaces.

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

      • sharingSettings

        UserSettings.Builder sharingSettings​(SharingSettings sharingSettings)

        Specifies options for sharing Amazon SageMaker AI Studio notebooks.

        Parameters:
        sharingSettings - Specifies options for sharing Amazon SageMaker AI Studio notebooks.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • jupyterServerAppSettings

        UserSettings.Builder jupyterServerAppSettings​(JupyterServerAppSettings jupyterServerAppSettings)

        The Jupyter server's app settings.

        Parameters:
        jupyterServerAppSettings - The Jupyter server's app settings.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • kernelGatewayAppSettings

        UserSettings.Builder kernelGatewayAppSettings​(KernelGatewayAppSettings kernelGatewayAppSettings)

        The kernel gateway app settings.

        Parameters:
        kernelGatewayAppSettings - The kernel gateway app settings.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tensorBoardAppSettings

        UserSettings.Builder tensorBoardAppSettings​(TensorBoardAppSettings tensorBoardAppSettings)

        The TensorBoard app settings.

        Parameters:
        tensorBoardAppSettings - The TensorBoard app settings.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • rStudioServerProAppSettings

        UserSettings.Builder rStudioServerProAppSettings​(RStudioServerProAppSettings rStudioServerProAppSettings)

        A collection of settings that configure user interaction with the RStudioServerPro app.

        Parameters:
        rStudioServerProAppSettings - A collection of settings that configure user interaction with the RStudioServerPro app.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • rSessionAppSettings

        UserSettings.Builder rSessionAppSettings​(RSessionAppSettings rSessionAppSettings)

        A collection of settings that configure the RSessionGateway app.

        Parameters:
        rSessionAppSettings - A collection of settings that configure the RSessionGateway app.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • canvasAppSettings

        UserSettings.Builder canvasAppSettings​(CanvasAppSettings canvasAppSettings)

        The Canvas app settings.

        SageMaker applies these settings only to private spaces that SageMaker creates for the Canvas app.

        Parameters:
        canvasAppSettings - The Canvas app settings.

        SageMaker applies these settings only to private spaces that SageMaker creates for the Canvas app.

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

      • codeEditorAppSettings

        UserSettings.Builder codeEditorAppSettings​(CodeEditorAppSettings codeEditorAppSettings)

        The Code Editor application settings.

        SageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn't apply these settings to shared spaces.

        Parameters:
        codeEditorAppSettings - The Code Editor application settings.

        SageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn't apply these settings to shared spaces.

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

      • jupyterLabAppSettings

        UserSettings.Builder jupyterLabAppSettings​(JupyterLabAppSettings jupyterLabAppSettings)

        The settings for the JupyterLab application.

        SageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn't apply these settings to shared spaces.

        Parameters:
        jupyterLabAppSettings - The settings for the JupyterLab application.

        SageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn't apply these settings to shared spaces.

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

      • spaceStorageSettings

        UserSettings.Builder spaceStorageSettings​(DefaultSpaceStorageSettings spaceStorageSettings)

        The storage settings for a space.

        SageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn't apply these settings to shared spaces.

        Parameters:
        spaceStorageSettings - The storage settings for a space.

        SageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn't apply these settings to shared spaces.

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

      • defaultLandingUri

        UserSettings.Builder defaultLandingUri​(String defaultLandingUri)

        The default experience that the user is directed to when accessing the domain. The supported values are:

        • studio::: Indicates that Studio is the default experience. This value can only be passed if StudioWebPortal is set to ENABLED.

        • app:JupyterServer:: Indicates that Studio Classic is the default experience.

        Parameters:
        defaultLandingUri - The default experience that the user is directed to when accessing the domain. The supported values are:

        • studio::: Indicates that Studio is the default experience. This value can only be passed if StudioWebPortal is set to ENABLED.

        • app:JupyterServer:: Indicates that Studio Classic is the default experience.

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

      • studioWebPortal

        UserSettings.Builder studioWebPortal​(String studioWebPortal)

        Whether the user can access Studio. If this value is set to DISABLED, the user cannot access Studio, even if that is the default experience for the domain.

        Parameters:
        studioWebPortal - Whether the user can access Studio. If this value is set to DISABLED, the user cannot access Studio, even if that is the default experience for the domain.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        StudioWebPortal, StudioWebPortal

      • studioWebPortal

        UserSettings.Builder studioWebPortal​(StudioWebPortal studioWebPortal)

        Whether the user can access Studio. If this value is set to DISABLED, the user cannot access Studio, even if that is the default experience for the domain.

        Parameters:
        studioWebPortal - Whether the user can access Studio. If this value is set to DISABLED, the user cannot access Studio, even if that is the default experience for the domain.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        StudioWebPortal, StudioWebPortal

      • customPosixUserConfig

        UserSettings.Builder customPosixUserConfig​(CustomPosixUserConfig customPosixUserConfig)

        Details about the POSIX identity that is used for file system operations.

        SageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn't apply these settings to shared spaces.

        Parameters:
        customPosixUserConfig - Details about the POSIX identity that is used for file system operations.

        SageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn't apply these settings to shared spaces.

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

      • customFileSystemConfigs

        UserSettings.Builder customFileSystemConfigs​(Collection<CustomFileSystemConfig> customFileSystemConfigs)

        The settings for assigning a custom file system to a user profile. Permitted users can access this file system in Amazon SageMaker AI Studio.

        SageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn't apply these settings to shared spaces.

        Parameters:
        customFileSystemConfigs - The settings for assigning a custom file system to a user profile. Permitted users can access this file system in Amazon SageMaker AI Studio.

        SageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn't apply these settings to shared spaces.

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

      • customFileSystemConfigs

        UserSettings.Builder customFileSystemConfigs​(CustomFileSystemConfig... customFileSystemConfigs)

        The settings for assigning a custom file system to a user profile. Permitted users can access this file system in Amazon SageMaker AI Studio.

        SageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn't apply these settings to shared spaces.

        Parameters:
        customFileSystemConfigs - The settings for assigning a custom file system to a user profile. Permitted users can access this file system in Amazon SageMaker AI Studio.

        SageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn't apply these settings to shared spaces.

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

      • customFileSystemConfigs

        UserSettings.Builder customFileSystemConfigs​(Consumer<CustomFileSystemConfig.Builder>... customFileSystemConfigs)

        The settings for assigning a custom file system to a user profile. Permitted users can access this file system in Amazon SageMaker AI Studio.

        SageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn't apply these settings to shared spaces.

        This is a convenience method that creates an instance of the CustomFileSystemConfig.Builder avoiding the need to create one manually via CustomFileSystemConfig.builder().

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #customFileSystemConfigs(List).

        Parameters:
        customFileSystemConfigs - a consumer that will call methods on CustomFileSystemConfig.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #customFileSystemConfigs(java.util.Collection)

      • studioWebPortalSettings

        UserSettings.Builder studioWebPortalSettings​(StudioWebPortalSettings studioWebPortalSettings)

        Studio settings. If these settings are applied on a user level, they take priority over the settings applied on a domain level.

        Parameters:
        studioWebPortalSettings - Studio settings. If these settings are applied on a user level, they take priority over the settings applied on a domain level.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • autoMountHomeEFS

        UserSettings.Builder autoMountHomeEFS​(String autoMountHomeEFS)

        Indicates whether auto-mounting of an EFS volume is supported for the user profile. The DefaultAsDomain value is only supported for user profiles. Do not use the DefaultAsDomain value when setting this parameter for a domain.

        SageMaker applies this setting only to private spaces that the user creates in the domain. SageMaker doesn't apply this setting to shared spaces.

        Parameters:
        autoMountHomeEFS - Indicates whether auto-mounting of an EFS volume is supported for the user profile. The DefaultAsDomain value is only supported for user profiles. Do not use the DefaultAsDomain value when setting this parameter for a domain.

        SageMaker applies this setting only to private spaces that the user creates in the domain. SageMaker doesn't apply this setting to shared spaces.

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

      • autoMountHomeEFS

        UserSettings.Builder autoMountHomeEFS​(AutoMountHomeEFS autoMountHomeEFS)

        Indicates whether auto-mounting of an EFS volume is supported for the user profile. The DefaultAsDomain value is only supported for user profiles. Do not use the DefaultAsDomain value when setting this parameter for a domain.

        SageMaker applies this setting only to private spaces that the user creates in the domain. SageMaker doesn't apply this setting to shared spaces.

        Parameters:
        autoMountHomeEFS - Indicates whether auto-mounting of an EFS volume is supported for the user profile. The DefaultAsDomain value is only supported for user profiles. Do not use the DefaultAsDomain value when setting this parameter for a domain.

        SageMaker applies this setting only to private spaces that the user creates in the domain. SageMaker doesn't apply this setting to shared spaces.

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