UserSettings (AWS SDK for Java

JavaScript is disabled on your browser.

AWS SDK for Java 1.x API Reference - 1.12.795

We announced the upcoming end-of-support for AWS SDK for Java (v1). We recommend that you migrate to AWS SDK for Java v2. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

com.amazonaws.services.sagemaker.model

Class UserSettings

java.lang.Object
- com.amazonaws.services.sagemaker.model.UserSettings

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class UserSettings
extends Object
implements Serializable, Cloneable, StructuredPojo 
```
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:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

UserSettings ()

Constructors
Constructor and Description
`UserSettings ()`

Method Summary

All Methods
Modifier and Type	Method and Description
`UserSettings`	`clone ()`
`boolean`	`equals (Object obj)`
`CanvasAppSettings`	`getCanvasAppSettings ()` The Canvas app settings.
`CodeEditorAppSettings`	`getCodeEditorAppSettings ()` The Code Editor application settings.
`List<CustomFileSystemConfig>`	`getCustomFileSystemConfigs ()` The settings for assigning a custom file system to a user profile.
`CustomPosixUserConfig`	`getCustomPosixUserConfig ()` Details about the POSIX identity that is used for file system operations.
`String`	`getDefaultLandingUri ()` The default experience that the user is directed to when accessing the domain.
`String`	`getExecutionRole ()` The execution role for the user.
`JupyterLabAppSettings`	`getJupyterLabAppSettings ()` The settings for the JupyterLab application.
`JupyterServerAppSettings`	`getJupyterServerAppSettings ()` The Jupyter server's app settings.
`KernelGatewayAppSettings`	`getKernelGatewayAppSettings ()` The kernel gateway app settings.
`RSessionAppSettings`	`getRSessionAppSettings ()` A collection of settings that configure the `RSessionGateway` app.
`RStudioServerProAppSettings`	`getRStudioServerProAppSettings ()` A collection of settings that configure user interaction with the `RStudioServerPro` app.
`List<String>`	`getSecurityGroups ()` The security groups for the Amazon Virtual Private Cloud (VPC) that the domain uses for communication.
`SharingSettings`	`getSharingSettings ()` Specifies options for sharing Amazon SageMaker Studio notebooks.
`DefaultSpaceStorageSettings`	`getSpaceStorageSettings ()` The storage settings for a space.
`String`	`getStudioWebPortal ()` Whether the user can access Studio.
`StudioWebPortalSettings`	`getStudioWebPortalSettings ()` Studio settings.
`TensorBoardAppSettings`	`getTensorBoardAppSettings ()` The TensorBoard app settings.
`int`	`hashCode ()`
`void`	`marshall (ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setCanvasAppSettings (CanvasAppSettings canvasAppSettings)` The Canvas app settings.
`void`	`setCodeEditorAppSettings (CodeEditorAppSettings codeEditorAppSettings)` The Code Editor application settings.
`void`	`setCustomFileSystemConfigs (Collection<CustomFileSystemConfig> customFileSystemConfigs)` The settings for assigning a custom file system to a user profile.
`void`	`setCustomPosixUserConfig (CustomPosixUserConfig customPosixUserConfig)` Details about the POSIX identity that is used for file system operations.
`void`	`setDefaultLandingUri (String defaultLandingUri)` The default experience that the user is directed to when accessing the domain.
`void`	`setExecutionRole (String executionRole)` The execution role for the user.
`void`	`setJupyterLabAppSettings (JupyterLabAppSettings jupyterLabAppSettings)` The settings for the JupyterLab application.
`void`	`setJupyterServerAppSettings (JupyterServerAppSettings jupyterServerAppSettings)` The Jupyter server's app settings.
`void`	`setKernelGatewayAppSettings (KernelGatewayAppSettings kernelGatewayAppSettings)` The kernel gateway app settings.
`void`	`setRSessionAppSettings (RSessionAppSettings rSessionAppSettings)` A collection of settings that configure the `RSessionGateway` app.
`void`	`setRStudioServerProAppSettings (RStudioServerProAppSettings rStudioServerProAppSettings)` A collection of settings that configure user interaction with the `RStudioServerPro` app.
`void`	`setSecurityGroups (Collection<String> securityGroups)` The security groups for the Amazon Virtual Private Cloud (VPC) that the domain uses for communication.
`void`	`setSharingSettings (SharingSettings sharingSettings)` Specifies options for sharing Amazon SageMaker Studio notebooks.
`void`	`setSpaceStorageSettings (DefaultSpaceStorageSettings spaceStorageSettings)` The storage settings for a space.
`void`	`setStudioWebPortal (String studioWebPortal)` Whether the user can access Studio.
`void`	`setStudioWebPortalSettings (StudioWebPortalSettings studioWebPortalSettings)` Studio settings.
`void`	`setTensorBoardAppSettings (TensorBoardAppSettings tensorBoardAppSettings)` The TensorBoard app settings.
`String`	`toString ()` Returns a string representation of this object.
`UserSettings`	`withCanvasAppSettings (CanvasAppSettings canvasAppSettings)` The Canvas app settings.
`UserSettings`	`withCodeEditorAppSettings (CodeEditorAppSettings codeEditorAppSettings)` The Code Editor application settings.
`UserSettings`	`withCustomFileSystemConfigs (Collection<CustomFileSystemConfig> customFileSystemConfigs)` The settings for assigning a custom file system to a user profile.
`UserSettings`	`withCustomFileSystemConfigs (CustomFileSystemConfig... customFileSystemConfigs)` The settings for assigning a custom file system to a user profile.
`UserSettings`	`withCustomPosixUserConfig (CustomPosixUserConfig customPosixUserConfig)` Details about the POSIX identity that is used for file system operations.
`UserSettings`	`withDefaultLandingUri (String defaultLandingUri)` The default experience that the user is directed to when accessing the domain.
`UserSettings`	`withExecutionRole (String executionRole)` The execution role for the user.
`UserSettings`	`withJupyterLabAppSettings (JupyterLabAppSettings jupyterLabAppSettings)` The settings for the JupyterLab application.
`UserSettings`	`withJupyterServerAppSettings (JupyterServerAppSettings jupyterServerAppSettings)` The Jupyter server's app settings.
`UserSettings`	`withKernelGatewayAppSettings (KernelGatewayAppSettings kernelGatewayAppSettings)` The kernel gateway app settings.
`UserSettings`	`withRSessionAppSettings (RSessionAppSettings rSessionAppSettings)` A collection of settings that configure the `RSessionGateway` app.
`UserSettings`	`withRStudioServerProAppSettings (RStudioServerProAppSettings rStudioServerProAppSettings)` A collection of settings that configure user interaction with the `RStudioServerPro` app.
`UserSettings`	`withSecurityGroups (Collection<String> securityGroups)` The security groups for the Amazon Virtual Private Cloud (VPC) that the domain uses for communication.
`UserSettings`	`withSecurityGroups (String... securityGroups)` The security groups for the Amazon Virtual Private Cloud (VPC) that the domain uses for communication.
`UserSettings`	`withSharingSettings (SharingSettings sharingSettings)` Specifies options for sharing Amazon SageMaker Studio notebooks.
`UserSettings`	`withSpaceStorageSettings (DefaultSpaceStorageSettings spaceStorageSettings)` The storage settings for a space.
`UserSettings`	`withStudioWebPortal (String studioWebPortal)` Whether the user can access Studio.
`UserSettings`	`withStudioWebPortal (StudioWebPortal studioWebPortal)` Whether the user can access Studio.
`UserSettings`	`withStudioWebPortalSettings (StudioWebPortalSettings studioWebPortalSettings)` Studio settings.
`UserSettings`	`withTensorBoardAppSettings (TensorBoardAppSettings tensorBoardAppSettings)` The TensorBoard app settings.

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

- Constructor Detail
  - UserSettings
```
public UserSettings()
```
- Method Detail
  - setExecutionRole
```
public void setExecutionRole(String executionRole)
```
    The execution role for the user.
    
    Parameters:
    
    executionRole - The execution role for the user.
  - getExecutionRole
```
public String getExecutionRole()
```
    The execution role for the user.
    
    Returns:
    
    The execution role for the user.
  - withExecutionRole
```
public UserSettings withExecutionRole(String executionRole)
```
    The execution role for the user.
    
    Parameters:
    
    executionRole - The execution role for the user.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getSecurityGroups
```
public List<String> getSecurityGroups()
```
    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 adds a security group to allow NFS traffic from Amazon SageMaker Studio. Therefore, the number of security groups that you can specify is one less than the maximum number shown.
    
    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 adds a security group to allow NFS traffic from Amazon SageMaker Studio. Therefore, the number of security groups that you can specify is one less than the maximum number shown.
  - setSecurityGroups
```
public void setSecurityGroups(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 adds a security group to allow NFS traffic from Amazon SageMaker Studio. Therefore, the number of security groups that you can specify is one less than the maximum number shown.
    
    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 adds a security group to allow NFS traffic from Amazon SageMaker Studio. Therefore, the number of security groups that you can specify is one less than the maximum number shown.
  - withSecurityGroups
```
public UserSettings withSecurityGroups(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 adds a security group to allow NFS traffic from Amazon SageMaker Studio. Therefore, the number of security groups that you can specify is one less than the maximum number shown.
    
    NOTE: This method appends the values to the existing list (if any). Use setSecurityGroups(java.util.Collection) or withSecurityGroups(java.util.Collection) if you want to override the existing values.
    
    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 adds a security group to allow NFS traffic from Amazon SageMaker Studio. Therefore, the number of security groups that you can specify is one less than the maximum number shown.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withSecurityGroups
```
public UserSettings withSecurityGroups(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 adds a security group to allow NFS traffic from Amazon SageMaker Studio. Therefore, the number of security groups that you can specify is one less than the maximum number shown.
    
    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 adds a security group to allow NFS traffic from Amazon SageMaker Studio. Therefore, the number of security groups that you can specify is one less than the maximum number shown.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSharingSettings
```
public void setSharingSettings(SharingSettings sharingSettings)
```
    Specifies options for sharing Amazon SageMaker Studio notebooks.
    
    Parameters:
    
    sharingSettings - Specifies options for sharing Amazon SageMaker Studio notebooks.
  - getSharingSettings
```
public SharingSettings getSharingSettings()
```
    Specifies options for sharing Amazon SageMaker Studio notebooks.
    
    Returns:
    
    Specifies options for sharing Amazon SageMaker Studio notebooks.
  - withSharingSettings
```
public UserSettings withSharingSettings(SharingSettings sharingSettings)
```
    Specifies options for sharing Amazon SageMaker Studio notebooks.
    
    Parameters:
    
    sharingSettings - Specifies options for sharing Amazon SageMaker Studio notebooks.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setJupyterServerAppSettings
```
public void setJupyterServerAppSettings(JupyterServerAppSettings jupyterServerAppSettings)
```
    The Jupyter server's app settings.
    
    Parameters:
    
    jupyterServerAppSettings - The Jupyter server's app settings.
  - getJupyterServerAppSettings
```
public JupyterServerAppSettings getJupyterServerAppSettings()
```
    The Jupyter server's app settings.
    
    Returns:
    
    The Jupyter server's app settings.
  - withJupyterServerAppSettings
```
public UserSettings withJupyterServerAppSettings(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.
  - setKernelGatewayAppSettings
```
public void setKernelGatewayAppSettings(KernelGatewayAppSettings kernelGatewayAppSettings)
```
    The kernel gateway app settings.
    
    Parameters:
    
    kernelGatewayAppSettings - The kernel gateway app settings.
  - getKernelGatewayAppSettings
```
public KernelGatewayAppSettings getKernelGatewayAppSettings()
```
    The kernel gateway app settings.
    
    Returns:
    
    The kernel gateway app settings.
  - withKernelGatewayAppSettings
```
public UserSettings withKernelGatewayAppSettings(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.
  - setTensorBoardAppSettings
```
public void setTensorBoardAppSettings(TensorBoardAppSettings tensorBoardAppSettings)
```
    The TensorBoard app settings.
    
    Parameters:
    
    tensorBoardAppSettings - The TensorBoard app settings.
  - getTensorBoardAppSettings
```
public TensorBoardAppSettings getTensorBoardAppSettings()
```
    The TensorBoard app settings.
    
    Returns:
    
    The TensorBoard app settings.
  - withTensorBoardAppSettings
```
public UserSettings withTensorBoardAppSettings(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.
  - setRStudioServerProAppSettings
```
public void setRStudioServerProAppSettings(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.
  - getRStudioServerProAppSettings
```
public RStudioServerProAppSettings getRStudioServerProAppSettings()
```
    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.
  - withRStudioServerProAppSettings
```
public UserSettings withRStudioServerProAppSettings(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.
  - setRSessionAppSettings
```
public void setRSessionAppSettings(RSessionAppSettings rSessionAppSettings)
```
    A collection of settings that configure the RSessionGateway app.
    
    Parameters:
    
    rSessionAppSettings - A collection of settings that configure the RSessionGateway app.
  - getRSessionAppSettings
```
public RSessionAppSettings getRSessionAppSettings()
```
    A collection of settings that configure the RSessionGateway app.
    
    Returns:
    
    A collection of settings that configure the RSessionGateway app.
  - withRSessionAppSettings
```
public UserSettings withRSessionAppSettings(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.
  - setCanvasAppSettings
```
public void setCanvasAppSettings(CanvasAppSettings canvasAppSettings)
```
    The Canvas app settings.
    
    Parameters:
    
    canvasAppSettings - The Canvas app settings.
  - getCanvasAppSettings
```
public CanvasAppSettings getCanvasAppSettings()
```
    The Canvas app settings.
    
    Returns:
    
    The Canvas app settings.
  - withCanvasAppSettings
```
public UserSettings withCanvasAppSettings(CanvasAppSettings canvasAppSettings)
```
    The Canvas app settings.
    
    Parameters:
    
    canvasAppSettings - The Canvas app settings.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCodeEditorAppSettings
```
public void setCodeEditorAppSettings(CodeEditorAppSettings codeEditorAppSettings)
```
    The Code Editor application settings.
    
    Parameters:
    
    codeEditorAppSettings - The Code Editor application settings.
  - getCodeEditorAppSettings
```
public CodeEditorAppSettings getCodeEditorAppSettings()
```
    The Code Editor application settings.
    
    Returns:
    
    The Code Editor application settings.
  - withCodeEditorAppSettings
```
public UserSettings withCodeEditorAppSettings(CodeEditorAppSettings codeEditorAppSettings)
```
    The Code Editor application settings.
    
    Parameters:
    
    codeEditorAppSettings - The Code Editor application settings.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setJupyterLabAppSettings
```
public void setJupyterLabAppSettings(JupyterLabAppSettings jupyterLabAppSettings)
```
    The settings for the JupyterLab application.
    
    Parameters:
    
    jupyterLabAppSettings - The settings for the JupyterLab application.
  - getJupyterLabAppSettings
```
public JupyterLabAppSettings getJupyterLabAppSettings()
```
    The settings for the JupyterLab application.
    
    Returns:
    
    The settings for the JupyterLab application.
  - withJupyterLabAppSettings
```
public UserSettings withJupyterLabAppSettings(JupyterLabAppSettings jupyterLabAppSettings)
```
    The settings for the JupyterLab application.
    
    Parameters:
    
    jupyterLabAppSettings - The settings for the JupyterLab application.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSpaceStorageSettings
```
public void setSpaceStorageSettings(DefaultSpaceStorageSettings spaceStorageSettings)
```
    The storage settings for a space.
    
    Parameters:
    
    spaceStorageSettings - The storage settings for a space.
  - getSpaceStorageSettings
```
public DefaultSpaceStorageSettings getSpaceStorageSettings()
```
    The storage settings for a space.
    
    Returns:
    
    The storage settings for a space.
  - withSpaceStorageSettings
```
public UserSettings withSpaceStorageSettings(DefaultSpaceStorageSettings spaceStorageSettings)
```
    The storage settings for a space.
    
    Parameters:
    
    spaceStorageSettings - The storage settings for a space.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDefaultLandingUri
```
public void setDefaultLandingUri(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.
  - getDefaultLandingUri
```
public String getDefaultLandingUri()
```
    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.
  - withDefaultLandingUri
```
public UserSettings withDefaultLandingUri(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.
  - setStudioWebPortal
```
public void setStudioWebPortal(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.
    
    See Also:
    
    StudioWebPortal
  - getStudioWebPortal
```
public String getStudioWebPortal()
```
    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:
    
    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
  - withStudioWebPortal
```
public UserSettings withStudioWebPortal(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
  - withStudioWebPortal
```
public UserSettings withStudioWebPortal(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
  - setCustomPosixUserConfig
```
public void setCustomPosixUserConfig(CustomPosixUserConfig customPosixUserConfig)
```
    Details about the POSIX identity that is used for file system operations.
    
    Parameters:
    
    customPosixUserConfig - Details about the POSIX identity that is used for file system operations.
  - getCustomPosixUserConfig
```
public CustomPosixUserConfig getCustomPosixUserConfig()
```
    Details about the POSIX identity that is used for file system operations.
    
    Returns:
    
    Details about the POSIX identity that is used for file system operations.
  - withCustomPosixUserConfig
```
public UserSettings withCustomPosixUserConfig(CustomPosixUserConfig customPosixUserConfig)
```
    Details about the POSIX identity that is used for file system operations.
    
    Parameters:
    
    customPosixUserConfig - Details about the POSIX identity that is used for file system operations.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getCustomFileSystemConfigs
```
public List<CustomFileSystemConfig> getCustomFileSystemConfigs()
```
    The settings for assigning a custom file system to a user profile. Permitted users can access this file system in Amazon SageMaker Studio.
    
    Returns:
    
    The settings for assigning a custom file system to a user profile. Permitted users can access this file system in Amazon SageMaker Studio.
  - setCustomFileSystemConfigs
```
public void setCustomFileSystemConfigs(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 Studio.
    
    Parameters:
    
    customFileSystemConfigs - The settings for assigning a custom file system to a user profile. Permitted users can access this file system in Amazon SageMaker Studio.
  - withCustomFileSystemConfigs
```
public UserSettings withCustomFileSystemConfigs(CustomFileSystemConfig... customFileSystemConfigs)
```
    The settings for assigning a custom file system to a user profile. Permitted users can access this file system in Amazon SageMaker Studio.
    
    NOTE: This method appends the values to the existing list (if any). Use setCustomFileSystemConfigs(java.util.Collection) or withCustomFileSystemConfigs(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    customFileSystemConfigs - The settings for assigning a custom file system to a user profile. Permitted users can access this file system in Amazon SageMaker Studio.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withCustomFileSystemConfigs
```
public UserSettings withCustomFileSystemConfigs(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 Studio.
    
    Parameters:
    
    customFileSystemConfigs - The settings for assigning a custom file system to a user profile. Permitted users can access this file system in Amazon SageMaker Studio.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStudioWebPortalSettings
```
public void setStudioWebPortalSettings(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.
  - getStudioWebPortalSettings
```
public StudioWebPortalSettings getStudioWebPortalSettings()
```
    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.
  - withStudioWebPortalSettings
```
public UserSettings withStudioWebPortalSettings(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.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public UserSettings clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

AWS SDK for Java 1.x API Reference - 1.12.795

Class UserSettings

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

UserSettings

Method Detail

setExecutionRole

getExecutionRole

withExecutionRole

getSecurityGroups

setSecurityGroups

withSecurityGroups

withSecurityGroups

setSharingSettings

getSharingSettings

withSharingSettings

setJupyterServerAppSettings

getJupyterServerAppSettings

withJupyterServerAppSettings

setKernelGatewayAppSettings

getKernelGatewayAppSettings

withKernelGatewayAppSettings

setTensorBoardAppSettings

getTensorBoardAppSettings

withTensorBoardAppSettings

setRStudioServerProAppSettings

getRStudioServerProAppSettings

withRStudioServerProAppSettings

setRSessionAppSettings

getRSessionAppSettings

withRSessionAppSettings

setCanvasAppSettings

getCanvasAppSettings

withCanvasAppSettings

setCodeEditorAppSettings

getCodeEditorAppSettings

withCodeEditorAppSettings

setJupyterLabAppSettings

getJupyterLabAppSettings

withJupyterLabAppSettings

setSpaceStorageSettings

getSpaceStorageSettings

withSpaceStorageSettings

setDefaultLandingUri

getDefaultLandingUri

withDefaultLandingUri

setStudioWebPortal

getStudioWebPortal

withStudioWebPortal

withStudioWebPortal

setCustomPosixUserConfig

getCustomPosixUserConfig

withCustomPosixUserConfig

getCustomFileSystemConfigs

setCustomFileSystemConfigs

withCustomFileSystemConfigs

withCustomFileSystemConfigs

setStudioWebPortalSettings

getStudioWebPortalSettings

withStudioWebPortalSettings

toString

equals

hashCode

clone

marshall