Interface UserSettings.Builder

All Superinterfaces:
Buildable, CopyableBuilder<UserSettings.Builder,UserSettings>, SdkBuilder<UserSettings.Builder,UserSettings>, SdkPojo
Enclosing class:
UserSettings
@Mutable @NotThreadSafe public static interface UserSettings.Builder extends SdkPojo, CopyableBuilder<UserSettings.Builder,UserSettings>

  • Method Details

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

    • sharingSettings

      default UserSettings.Builder sharingSettings(Consumer<SharingSettings.Builder> sharingSettings)

      Specifies options for sharing Amazon SageMaker AI Studio notebooks.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to sharingSettings(SharingSettings).

      Parameters:
      sharingSettings - a consumer that will call methods on SharingSettings.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

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

    • jupyterServerAppSettings

      default UserSettings.Builder jupyterServerAppSettings(Consumer<JupyterServerAppSettings.Builder> jupyterServerAppSettings)

      The Jupyter server's app settings.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to jupyterServerAppSettings(JupyterServerAppSettings).

      Parameters:
      jupyterServerAppSettings - a consumer that will call methods on JupyterServerAppSettings.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

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

    • kernelGatewayAppSettings

      default UserSettings.Builder kernelGatewayAppSettings(Consumer<KernelGatewayAppSettings.Builder> kernelGatewayAppSettings)

      The kernel gateway app settings.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to kernelGatewayAppSettings(KernelGatewayAppSettings).

      Parameters:
      kernelGatewayAppSettings - a consumer that will call methods on KernelGatewayAppSettings.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

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

    • tensorBoardAppSettings

      default UserSettings.Builder tensorBoardAppSettings(Consumer<TensorBoardAppSettings.Builder> tensorBoardAppSettings)

      The TensorBoard app settings.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tensorBoardAppSettings(TensorBoardAppSettings).

      Parameters:
      tensorBoardAppSettings - a consumer that will call methods on TensorBoardAppSettings.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

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

    • rStudioServerProAppSettings

      default UserSettings.Builder rStudioServerProAppSettings(Consumer<RStudioServerProAppSettings.Builder> rStudioServerProAppSettings)

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

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to rStudioServerProAppSettings(RStudioServerProAppSettings).

      Parameters:
      rStudioServerProAppSettings - a consumer that will call methods on RStudioServerProAppSettings.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

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

    • rSessionAppSettings

      default UserSettings.Builder rSessionAppSettings(Consumer<RSessionAppSettings.Builder> rSessionAppSettings)

      A collection of settings that configure the RSessionGateway app.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to rSessionAppSettings(RSessionAppSettings).

      Parameters:
      rSessionAppSettings - a consumer that will call methods on RSessionAppSettings.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

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

    • canvasAppSettings

      default UserSettings.Builder canvasAppSettings(Consumer<CanvasAppSettings.Builder> canvasAppSettings)

      The Canvas app settings.

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

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to canvasAppSettings(CanvasAppSettings).

      Parameters:
      canvasAppSettings - a consumer that will call methods on CanvasAppSettings.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

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

    • codeEditorAppSettings

      default UserSettings.Builder codeEditorAppSettings(Consumer<CodeEditorAppSettings.Builder> 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.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to codeEditorAppSettings(CodeEditorAppSettings).

      Parameters:
      codeEditorAppSettings - a consumer that will call methods on CodeEditorAppSettings.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

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

    • jupyterLabAppSettings

      default UserSettings.Builder jupyterLabAppSettings(Consumer<JupyterLabAppSettings.Builder> 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.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to jupyterLabAppSettings(JupyterLabAppSettings).

      Parameters:
      jupyterLabAppSettings - a consumer that will call methods on JupyterLabAppSettings.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

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

    • spaceStorageSettings

      default UserSettings.Builder spaceStorageSettings(Consumer<DefaultSpaceStorageSettings.Builder> 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.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to spaceStorageSettings(DefaultSpaceStorageSettings).

      Parameters:
      spaceStorageSettings - a consumer that will call methods on DefaultSpaceStorageSettings.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • 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

      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:

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

    • customPosixUserConfig

      default UserSettings.Builder customPosixUserConfig(Consumer<CustomPosixUserConfig.Builder> 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.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to customPosixUserConfig(CustomPosixUserConfig).

      Parameters:
      customPosixUserConfig - a consumer that will call methods on CustomPosixUserConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • 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<CustomFileSystemConfig>).

      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:

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

    • studioWebPortalSettings

      default UserSettings.Builder studioWebPortalSettings(Consumer<StudioWebPortalSettings.Builder> studioWebPortalSettings)

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

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to studioWebPortalSettings(StudioWebPortalSettings).

      Parameters:
      studioWebPortalSettings - a consumer that will call methods on StudioWebPortalSettings.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • 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

      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: