UserSettings (AWS SDK for Java

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 of Amazon SageMaker Studio. 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 Instance Methods Concrete Methods
Modifier and Type	Method and Description
`UserSettings`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getExecutionRole()` The execution role for the user.
`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 Studio uses for communication.
`SharingSettings`	`getSharingSettings()` Specifies options for sharing SageMaker Studio notebooks.
`TensorBoardAppSettings`	`getTensorBoardAppSettings()` The TensorBoard app settings.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setExecutionRole(String executionRole)` The execution role for the user.
`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 Studio uses for communication.
`void`	`setSharingSettings(SharingSettings sharingSettings)` Specifies options for sharing SageMaker Studio notebooks.
`void`	`setTensorBoardAppSettings(TensorBoardAppSettings tensorBoardAppSettings)` The TensorBoard app settings.
`String`	`toString()` Returns a string representation of this object.
`UserSettings`	`withExecutionRole(String executionRole)` The execution role for the user.
`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 Studio uses for communication.
`UserSettings`	`withSecurityGroups(String... securityGroups)` The security groups for the Amazon Virtual Private Cloud (VPC) that Studio uses for communication.
`UserSettings`	`withSharingSettings(SharingSettings sharingSettings)` Specifies options for sharing SageMaker Studio notebooks.
`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 Studio uses for communication.
    
    Optional when the CreateDomain.AppNetworkAccessType parameter is set to PublicInternetOnly.
    
    Required when the CreateDomain.AppNetworkAccessType parameter is set to VpcOnly.
    
    Amazon SageMaker adds a security group to allow NFS traffic from 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 Studio uses for communication.
    
    Optional when the CreateDomain.AppNetworkAccessType parameter is set to PublicInternetOnly.
    
    Required when the CreateDomain.AppNetworkAccessType parameter is set to VpcOnly .
    
    Amazon SageMaker adds a security group to allow NFS traffic from 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 Studio uses for communication.
    
    Optional when the CreateDomain.AppNetworkAccessType parameter is set to PublicInternetOnly.
    
    Required when the CreateDomain.AppNetworkAccessType parameter is set to VpcOnly.
    
    Amazon SageMaker adds a security group to allow NFS traffic from 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 Studio uses for communication.
    
    Optional when the CreateDomain.AppNetworkAccessType parameter is set to PublicInternetOnly.
    
    Required when the CreateDomain.AppNetworkAccessType parameter is set to VpcOnly.
    
    Amazon SageMaker adds a security group to allow NFS traffic from 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 Studio uses for communication.
    
    Optional when the CreateDomain.AppNetworkAccessType parameter is set to PublicInternetOnly.
    
    Required when the CreateDomain.AppNetworkAccessType parameter is set to VpcOnly.
    
    Amazon SageMaker adds a security group to allow NFS traffic from 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 Studio uses for communication.
    
    Optional when the CreateDomain.AppNetworkAccessType parameter is set to PublicInternetOnly.
    
    Required when the CreateDomain.AppNetworkAccessType parameter is set to VpcOnly.
    
    Amazon SageMaker adds a security group to allow NFS traffic from 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 Studio uses for communication.
    
    Optional when the CreateDomain.AppNetworkAccessType parameter is set to PublicInternetOnly.
    
    Required when the CreateDomain.AppNetworkAccessType parameter is set to VpcOnly.
    
    Amazon SageMaker adds a security group to allow NFS traffic from 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 Studio uses for communication.
    
    Optional when the CreateDomain.AppNetworkAccessType parameter is set to PublicInternetOnly.
    
    Required when the CreateDomain.AppNetworkAccessType parameter is set to VpcOnly.
    
    Amazon SageMaker adds a security group to allow NFS traffic from 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 SageMaker Studio notebooks.
    
    Parameters:
    
    sharingSettings - Specifies options for sharing SageMaker Studio notebooks.
  - getSharingSettings
```
public SharingSettings getSharingSettings()
```
    Specifies options for sharing SageMaker Studio notebooks.
    
    Returns:
    
    Specifies options for sharing SageMaker Studio notebooks.
  - withSharingSettings
```
public UserSettings withSharingSettings(SharingSettings sharingSettings)
```
    Specifies options for sharing SageMaker Studio notebooks.
    
    Parameters:
    
    sharingSettings - Specifies options for sharing 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.
  - 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.

Did this page help you?

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

toString

equals

hashCode

clone

marshall