@Generated(value="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
.
Modifier and Type | Class and Description |
---|---|
static interface |
UserSettings.Builder |
Modifier and Type | Method and Description |
---|---|
static UserSettings.Builder |
builder() |
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj)
Indicates whether some other object is "equal to" this one by SDK fields.
|
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()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString()
Returns a string representation of this object.
|
copy
public final String executionRole()
The execution role for the user.
public final boolean hasSecurityGroups()
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
.
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.
You can use hasSecurityGroups()
to see if a value was sent in this field.
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.
public final SharingSettings sharingSettings()
The sharing settings.
public final JupyterServerAppSettings jupyterServerAppSettings()
The Jupyter server's app settings.
public final KernelGatewayAppSettings kernelGatewayAppSettings()
The kernel gateway app settings.
public final TensorBoardAppSettings tensorBoardAppSettings()
The TensorBoard app settings.
public UserSettings.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<UserSettings.Builder,UserSettings>
public static UserSettings.Builder builder()
public static Class<? extends UserSettings.Builder> serializableBuilderClass()
public final boolean equalsBySdkFields(Object obj)
SdkPojo
SdkPojo
class,
and is generated based on a service model.
If an SdkPojo
class does not have any inherited fields, equalsBySdkFields
and equals
are essentially the same.
equalsBySdkFields
in interface SdkPojo
obj
- the object to be compared withpublic final String toString()
Copyright © 2021 Amazon Web Services, Inc. All Rights Reserved.