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:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface UserSettings.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`AutoMountHomeEFS`	`autoMountHomeEFS()`	Indicates whether auto-mounting of an EFS volume is supported for the user profile.
`String`	`autoMountHomeEFSAsString()`	Indicates whether auto-mounting of an EFS volume is supported for the user profile.
`static UserSettings.Builder`	`builder()`
`CanvasAppSettings`	`canvasAppSettings()`	The Canvas app settings.
`CodeEditorAppSettings`	`codeEditorAppSettings()`	The Code Editor application settings.
`List<CustomFileSystemConfig>`	`customFileSystemConfigs()`	The settings for assigning a custom file system to a user profile.
`CustomPosixUserConfig`	`customPosixUserConfig()`	Details about the POSIX identity that is used for file system operations.
`String`	`defaultLandingUri()`	The default experience that the user is directed to when accessing the domain.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`String`	`executionRole()`	The execution role for the user.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasCustomFileSystemConfigs()`	For responses, this returns true if the service returned a value for the CustomFileSystemConfigs property.
`int`	`hashCode()`
`boolean`	`hasSecurityGroups()`	For responses, this returns true if the service returned a value for the SecurityGroups property.
`JupyterLabAppSettings`	`jupyterLabAppSettings()`	The settings for the JupyterLab application.
`JupyterServerAppSettings`	`jupyterServerAppSettings()`	The Jupyter server's app settings.
`KernelGatewayAppSettings`	`kernelGatewayAppSettings()`	The kernel gateway app settings.
`RSessionAppSettings`	`rSessionAppSettings()`	A collection of settings that configure the `RSessionGateway` app.
`RStudioServerProAppSettings`	`rStudioServerProAppSettings()`	A collection of settings that configure user interaction with the `RStudioServerPro` app.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`List<String>`	`securityGroups()`	The security groups for the Amazon Virtual Private Cloud (VPC) that the domain uses for communication.
`static Class<? extends UserSettings.Builder>`	`serializableBuilderClass()`
`SharingSettings`	`sharingSettings()`	Specifies options for sharing Amazon SageMaker AI Studio notebooks.
`DefaultSpaceStorageSettings`	`spaceStorageSettings()`	The storage settings for a space.
`StudioWebPortal`	`studioWebPortal()`	Whether the user can access Studio.
`String`	`studioWebPortalAsString()`	Whether the user can access Studio.
`StudioWebPortalSettings`	`studioWebPortalSettings()`	Studio settings.
`TensorBoardAppSettings`	`tensorBoardAppSettings()`	The TensorBoard app settings.
`UserSettings.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - 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:
    
    StudioWebPortal
  - 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:
    
    StudioWebPortal
  - 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:
    
    AutoMountHomeEFS
  - 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:
    
    AutoMountHomeEFS
  - toBuilder
```
public UserSettings.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<UserSettings.Builder,UserSettings>
  - 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)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class UserSettings

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

executionRole

hasSecurityGroups

securityGroups

sharingSettings

jupyterServerAppSettings

kernelGatewayAppSettings

tensorBoardAppSettings

rStudioServerProAppSettings

rSessionAppSettings

canvasAppSettings

codeEditorAppSettings

jupyterLabAppSettings

spaceStorageSettings

defaultLandingUri

studioWebPortal

studioWebPortalAsString

customPosixUserConfig

hasCustomFileSystemConfigs

customFileSystemConfigs

studioWebPortalSettings

autoMountHomeEFS

autoMountHomeEFSAsString

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField