Class UserSettings
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<UserSettings.Builder,
UserSettings>
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:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic UserSettings.Builder
builder()
final CanvasAppSettings
The Canvas app settings.final CodeEditorAppSettings
The Code Editor application settings.final List
<CustomFileSystemConfig> The settings for assigning a custom file system to a user profile.final CustomPosixUserConfig
Details about the POSIX identity that is used for file system operations.final String
The default experience that the user is directed to when accessing the domain.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final String
The execution role for the user.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the CustomFileSystemConfigs property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the SecurityGroups property.final JupyterLabAppSettings
The settings for the JupyterLab application.final JupyterServerAppSettings
The Jupyter server's app settings.final KernelGatewayAppSettings
The kernel gateway app settings.final RSessionAppSettings
A collection of settings that configure theRSessionGateway
app.A collection of settings that configure user interaction with theRStudioServerPro
app.The security groups for the Amazon Virtual Private Cloud (VPC) that the domain uses for communication.static Class
<? extends UserSettings.Builder> final SharingSettings
Specifies options for sharing Amazon SageMaker Studio notebooks.The storage settings for a space.final StudioWebPortal
Whether the user can access Studio.final String
Whether the user can access Studio.final TensorBoardAppSettings
The TensorBoard app settings.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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 theisEmpty()
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
The security groups for the Amazon Virtual Private Cloud (VPC) that the domain uses for communication.
Optional when the
CreateDomain.AppNetworkAccessType
parameter is set toPublicInternetOnly
.Required when the
CreateDomain.AppNetworkAccessType
parameter is set toVpcOnly
, unless specified as part of theDefaultUserSettings
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.
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 the domain uses for
communication.
Optional when the
CreateDomain.AppNetworkAccessType
parameter is set toPublicInternetOnly
.Required when the
CreateDomain.AppNetworkAccessType
parameter is set toVpcOnly
, unless specified as part of theDefaultUserSettings
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.
-
sharingSettings
Specifies options for sharing Amazon SageMaker Studio notebooks.
- Returns:
- Specifies options for sharing Amazon SageMaker Studio notebooks.
-
jupyterServerAppSettings
The Jupyter server's app settings.
- Returns:
- The Jupyter server's app settings.
-
kernelGatewayAppSettings
The kernel gateway app settings.
- Returns:
- The kernel gateway app settings.
-
tensorBoardAppSettings
The TensorBoard app settings.
- Returns:
- The TensorBoard app settings.
-
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
A collection of settings that configure the
RSessionGateway
app.- Returns:
- A collection of settings that configure the
RSessionGateway
app.
-
canvasAppSettings
The Canvas app settings.
- Returns:
- The Canvas app settings.
-
codeEditorAppSettings
The Code Editor application settings.
- Returns:
- The Code Editor application settings.
-
jupyterLabAppSettings
The settings for the JupyterLab application.
- Returns:
- The settings for the JupyterLab application.
-
spaceStorageSettings
The storage settings for a space.
- Returns:
- The storage settings for a space.
-
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 ifStudioWebPortal
is set toENABLED
. -
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 ifStudioWebPortal
is set toENABLED
. -
app:JupyterServer:
: Indicates that Studio Classic is the default experience.
-
-
-
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.If the service returns an enum value that is not available in the current SDK version,
studioWebPortal
will returnStudioWebPortal.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstudioWebPortalAsString()
.- 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:
-
studioWebPortalAsString
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.If the service returns an enum value that is not available in the current SDK version,
studioWebPortal
will returnStudioWebPortal.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstudioWebPortalAsString()
.- 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:
-
customPosixUserConfig
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.
-
hasCustomFileSystemConfigs
public final boolean hasCustomFileSystemConfigs()For responses, this returns true if the service returned a value for the CustomFileSystemConfigs property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
customFileSystemConfigs
The settings for assigning a custom file system to a user profile. Permitted users can access this file system in Amazon SageMaker Studio.
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
hasCustomFileSystemConfigs()
method.- Returns:
- The settings for assigning a custom file system to a user profile. Permitted users can access this file system in Amazon SageMaker Studio.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<UserSettings.Builder,
UserSettings> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-