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(value="software.amazon.awssdk:codegen")
public final class UserSettings
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<UserSettings.Builder,UserSettings>

A collection of settings.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	UserSettings.Builder

Method Summary

Modifier and Type	Method and Description
static UserSettings.Builder	builder()
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() Returns true if the SecurityGroups property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
JupyterServerAppSettings	jupyterServerAppSettings() The Jupyter server's app settings.
KernelGatewayAppSettings	kernelGatewayAppSettings() The kernel gateway app settings.
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() The sharing 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 String executionRole()

The execution role for the user.

Returns:

The execution role for the user.

hasSecurityGroups

public boolean hasSecurityGroups()

Returns true if the SecurityGroups property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

securityGroups

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

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

You can use hasSecurityGroups() to see if a value was sent in this field.

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.

sharingSettings

public SharingSettings sharingSettings()

The sharing settings.

Returns:

The sharing settings.

jupyterServerAppSettings

public JupyterServerAppSettings jupyterServerAppSettings()

The Jupyter server's app settings.

Returns:

The Jupyter server's app settings.

kernelGatewayAppSettings

public KernelGatewayAppSettings kernelGatewayAppSettings()

The kernel gateway app settings.

Returns:

The kernel gateway app settings.

tensorBoardAppSettings

public TensorBoardAppSettings tensorBoardAppSettings()

The TensorBoard app settings.

Returns:

The TensorBoard 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 int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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

getValueForField

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

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo