Package software.amazon.awssdk.services.sagemaker.model

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

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	UserSettings.Builder

Method Summary

Modifier and Type	Method	Description
static UserSettings.Builder	builder()
CanvasAppSettings	canvasAppSettings()	The Canvas app settings.
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)
int	hashCode()
boolean	hasSecurityGroups()	For responses, this returns true if the service returned a value for the SecurityGroups property.
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.
List<SdkField<?>>	sdkFields()
List<String>	securityGroups()	The security groups for the Amazon Virtual Private Cloud (VPC) that Studio uses for communication.
static Class<? extends UserSettings.Builder>	serializableBuilderClass()
SharingSettings	sharingSettings()	Specifies options for sharing SageMaker Studio notebooks.
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.

Returns:

The execution role for the user.

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 Studio 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 SageMaker Studio. Therefore, the number of security groups that you can specify is one less than the maximum number shown.

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 Studio 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 SageMaker Studio. Therefore, the number of security groups that you can specify is one less than the maximum number shown.

sharingSettings

public final SharingSettings sharingSettings()

Specifies options for sharing SageMaker Studio notebooks.

Returns:

Specifies options for sharing SageMaker 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.

Returns:

The Canvas app settings.

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