Class UserSettings

java.lang.Object
software.amazon.awssdk.services.sagemaker.model.UserSettings
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<UserSettings.Builder,UserSettings>
@Generated("software.amazon.awssdk:codegen") public final class UserSettings extends Object implements SdkPojo, Serializable, ToCopyableBuilder<UserSettings.Builder,UserSettings>

A collection of settings that apply to users in a domain. These settings are specified when the CreateUserProfile API is called, and as DefaultUserSettings when the CreateDomain API is called.

SecurityGroups is aggregated when specified in both calls. For all other settings in UserSettings, the values specified in CreateUserProfile take precedence over those specified in CreateDomain.

See Also:

  • Method Details

    • executionRole

      public final 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.

      Returns:
      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.

    • hasSecurityGroups

      public final boolean hasSecurityGroups()
      For responses, this returns true if the service returned a value for the SecurityGroups property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • securityGroups

      public final List<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.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSecurityGroups() method.

      Returns:
      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.

    • sharingSettings

      public final SharingSettings sharingSettings()

      Specifies options for sharing Amazon SageMaker AI Studio notebooks.

      Returns:
      Specifies options for sharing Amazon SageMaker AI Studio notebooks.

    • jupyterServerAppSettings

      public final JupyterServerAppSettings jupyterServerAppSettings()

      The Jupyter server's app settings.

      Returns:
      The Jupyter server's app settings.

    • kernelGatewayAppSettings

      public final KernelGatewayAppSettings kernelGatewayAppSettings()

      The kernel gateway app settings.

      Returns:
      The kernel gateway app settings.

    • tensorBoardAppSettings

      public final TensorBoardAppSettings tensorBoardAppSettings()

      The TensorBoard app settings.

      Returns:
      The TensorBoard app settings.

    • rStudioServerProAppSettings

      public final RStudioServerProAppSettings rStudioServerProAppSettings()

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

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

    • rSessionAppSettings

      public final RSessionAppSettings rSessionAppSettings()

      A collection of settings that configure the RSessionGateway app.

      Returns:
      A collection of settings that configure the RSessionGateway app.

    • canvasAppSettings

      public final CanvasAppSettings canvasAppSettings()

      The Canvas app settings.

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

      Returns:
      The Canvas app settings.

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

    • codeEditorAppSettings

      public final 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.

      Returns:
      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.

    • jupyterLabAppSettings

      public final 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.

      Returns:
      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.

    • spaceStorageSettings

      public final 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.

      Returns:
      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.

    • defaultLandingUri

      public final 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.

      Returns:
      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.

    • studioWebPortal

      public final 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.

      If the service returns an enum value that is not available in the current SDK version, studioWebPortal will return StudioWebPortal.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from studioWebPortalAsString().

      Returns:
      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.
      See Also:

    • studioWebPortalAsString

      public final String studioWebPortalAsString()

      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.

      If the service returns an enum value that is not available in the current SDK version, studioWebPortal will return StudioWebPortal.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from studioWebPortalAsString().

      Returns:
      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.
      See Also:

    • customPosixUserConfig

      public final 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.

      Returns:
      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.

    • hasCustomFileSystemConfigs

      public final boolean hasCustomFileSystemConfigs()
      For responses, this returns true if the service returned a value for the CustomFileSystemConfigs property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • customFileSystemConfigs

      public final List<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.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasCustomFileSystemConfigs() method.

      Returns:
      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.

    • studioWebPortalSettings

      public final StudioWebPortalSettings studioWebPortalSettings()

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

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

    • autoMountHomeEFS

      public final 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.

      If the service returns an enum value that is not available in the current SDK version, autoMountHomeEFS will return AutoMountHomeEFS.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from autoMountHomeEFSAsString().

      Returns:
      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.

      See Also:

    • autoMountHomeEFSAsString

      public final String autoMountHomeEFSAsString()

      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.

      If the service returns an enum value that is not available in the current SDK version, autoMountHomeEFS will return AutoMountHomeEFS.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from autoMountHomeEFSAsString().

      Returns:
      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.

      See Also:

    • toBuilder

      public UserSettings.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<UserSettings.Builder,UserSettings>
      Returns:
      a builder for type T

    • builder

      public static UserSettings.Builder builder()

    • serializableBuilderClass

      public static Class<? extends UserSettings.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.