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

Interface UserSettings.Builder

All Superinterfaces:

Buildable, CopyableBuilder<UserSettings.Builder,UserSettings>, SdkBuilder<UserSettings.Builder,UserSettings>, SdkPojo

Enclosing class:

UserSettings

public static interface UserSettings.Builder
extends SdkPojo, CopyableBuilder<UserSettings.Builder,UserSettings>

Method Summary

Modifier and Type	Method	Description
default UserSettings.Builder	canvasAppSettings(Consumer<CanvasAppSettings.Builder> canvasAppSettings)	The Canvas app settings.
UserSettings.Builder	canvasAppSettings(CanvasAppSettings canvasAppSettings)	The Canvas app settings.
default UserSettings.Builder	codeEditorAppSettings(Consumer<CodeEditorAppSettings.Builder> codeEditorAppSettings)	The Code Editor application settings.
UserSettings.Builder	codeEditorAppSettings(CodeEditorAppSettings codeEditorAppSettings)	The Code Editor application settings.
UserSettings.Builder	customFileSystemConfigs(Collection<CustomFileSystemConfig> customFileSystemConfigs)	The settings for assigning a custom file system to a user profile.
UserSettings.Builder	customFileSystemConfigs(Consumer<CustomFileSystemConfig.Builder>... customFileSystemConfigs)	The settings for assigning a custom file system to a user profile.
UserSettings.Builder	customFileSystemConfigs(CustomFileSystemConfig... customFileSystemConfigs)	The settings for assigning a custom file system to a user profile.
default UserSettings.Builder	customPosixUserConfig(Consumer<CustomPosixUserConfig.Builder> customPosixUserConfig)	Details about the POSIX identity that is used for file system operations.
UserSettings.Builder	customPosixUserConfig(CustomPosixUserConfig customPosixUserConfig)	Details about the POSIX identity that is used for file system operations.
UserSettings.Builder	defaultLandingUri(String defaultLandingUri)	The default experience that the user is directed to when accessing the domain.
UserSettings.Builder	executionRole(String executionRole)	The execution role for the user.
default UserSettings.Builder	jupyterLabAppSettings(Consumer<JupyterLabAppSettings.Builder> jupyterLabAppSettings)	The settings for the JupyterLab application.
UserSettings.Builder	jupyterLabAppSettings(JupyterLabAppSettings jupyterLabAppSettings)	The settings for the JupyterLab application.
default UserSettings.Builder	jupyterServerAppSettings(Consumer<JupyterServerAppSettings.Builder> jupyterServerAppSettings)	The Jupyter server's app settings.
UserSettings.Builder	jupyterServerAppSettings(JupyterServerAppSettings jupyterServerAppSettings)	The Jupyter server's app settings.
default UserSettings.Builder	kernelGatewayAppSettings(Consumer<KernelGatewayAppSettings.Builder> kernelGatewayAppSettings)	The kernel gateway app settings.
UserSettings.Builder	kernelGatewayAppSettings(KernelGatewayAppSettings kernelGatewayAppSettings)	The kernel gateway app settings.
default UserSettings.Builder	rSessionAppSettings(Consumer<RSessionAppSettings.Builder> rSessionAppSettings)	A collection of settings that configure the RSessionGateway app.
UserSettings.Builder	rSessionAppSettings(RSessionAppSettings rSessionAppSettings)	A collection of settings that configure the RSessionGateway app.
default UserSettings.Builder	rStudioServerProAppSettings(Consumer<RStudioServerProAppSettings.Builder> rStudioServerProAppSettings)	A collection of settings that configure user interaction with the RStudioServerPro app.
UserSettings.Builder	rStudioServerProAppSettings(RStudioServerProAppSettings rStudioServerProAppSettings)	A collection of settings that configure user interaction with the RStudioServerPro app.
UserSettings.Builder	securityGroups(String... securityGroups)	The security groups for the Amazon Virtual Private Cloud (VPC) that the domain uses for communication.
UserSettings.Builder	securityGroups(Collection<String> securityGroups)	The security groups for the Amazon Virtual Private Cloud (VPC) that the domain uses for communication.
default UserSettings.Builder	sharingSettings(Consumer<SharingSettings.Builder> sharingSettings)	Specifies options for sharing Amazon SageMaker Studio notebooks.
UserSettings.Builder	sharingSettings(SharingSettings sharingSettings)	Specifies options for sharing Amazon SageMaker Studio notebooks.
default UserSettings.Builder	spaceStorageSettings(Consumer<DefaultSpaceStorageSettings.Builder> spaceStorageSettings)	The storage settings for a private space.
UserSettings.Builder	spaceStorageSettings(DefaultSpaceStorageSettings spaceStorageSettings)	The storage settings for a private space.
UserSettings.Builder	studioWebPortal(String studioWebPortal)	Whether the user can access Studio.
UserSettings.Builder	studioWebPortal(StudioWebPortal studioWebPortal)	Whether the user can access Studio.
default UserSettings.Builder	tensorBoardAppSettings(Consumer<TensorBoardAppSettings.Builder> tensorBoardAppSettings)	The TensorBoard app settings.
UserSettings.Builder	tensorBoardAppSettings(TensorBoardAppSettings tensorBoardAppSettings)	The TensorBoard app settings.

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Method Detail

executionRole

UserSettings.Builder executionRole(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.

securityGroups

UserSettings.Builder securityGroups(Collection<String> 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 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 Amazon 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 the domain 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 Amazon 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.

securityGroups

UserSettings.Builder securityGroups(String... 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 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 Amazon 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 the domain 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 Amazon 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.

sharingSettings

UserSettings.Builder sharingSettings(SharingSettings sharingSettings)

Specifies options for sharing Amazon SageMaker Studio notebooks.

Parameters:

sharingSettings - Specifies options for sharing Amazon SageMaker Studio notebooks.

Returns:

Returns a reference to this object so that method calls can be chained together.

sharingSettings

default UserSettings.Builder sharingSettings(Consumer<SharingSettings.Builder> sharingSettings)

Specifies options for sharing Amazon SageMaker Studio notebooks.

This is a convenience method that creates an instance of the SharingSettings.Builder avoiding the need to create one manually via SharingSettings.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to sharingSettings(SharingSettings).

Parameters:

sharingSettings - a consumer that will call methods on SharingSettings.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

sharingSettings(SharingSettings)

jupyterServerAppSettings

UserSettings.Builder jupyterServerAppSettings(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.

jupyterServerAppSettings

default UserSettings.Builder jupyterServerAppSettings(Consumer<JupyterServerAppSettings.Builder> jupyterServerAppSettings)

The Jupyter server's app settings.

This is a convenience method that creates an instance of the JupyterServerAppSettings.Builder avoiding the need to create one manually via JupyterServerAppSettings.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to jupyterServerAppSettings(JupyterServerAppSettings).

Parameters:

jupyterServerAppSettings - a consumer that will call methods on JupyterServerAppSettings.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

jupyterServerAppSettings(JupyterServerAppSettings)

kernelGatewayAppSettings

UserSettings.Builder kernelGatewayAppSettings(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.

kernelGatewayAppSettings

default UserSettings.Builder kernelGatewayAppSettings(Consumer<KernelGatewayAppSettings.Builder> kernelGatewayAppSettings)

The kernel gateway app settings.

This is a convenience method that creates an instance of the KernelGatewayAppSettings.Builder avoiding the need to create one manually via KernelGatewayAppSettings.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to kernelGatewayAppSettings(KernelGatewayAppSettings).

Parameters:

kernelGatewayAppSettings - a consumer that will call methods on KernelGatewayAppSettings.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

kernelGatewayAppSettings(KernelGatewayAppSettings)

tensorBoardAppSettings

UserSettings.Builder tensorBoardAppSettings(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.

tensorBoardAppSettings

default UserSettings.Builder tensorBoardAppSettings(Consumer<TensorBoardAppSettings.Builder> tensorBoardAppSettings)

The TensorBoard app settings.

This is a convenience method that creates an instance of the TensorBoardAppSettings.Builder avoiding the need to create one manually via TensorBoardAppSettings.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tensorBoardAppSettings(TensorBoardAppSettings).

Parameters:

tensorBoardAppSettings - a consumer that will call methods on TensorBoardAppSettings.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

tensorBoardAppSettings(TensorBoardAppSettings)

rStudioServerProAppSettings

UserSettings.Builder rStudioServerProAppSettings(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.

rStudioServerProAppSettings

default UserSettings.Builder rStudioServerProAppSettings(Consumer<RStudioServerProAppSettings.Builder> rStudioServerProAppSettings)

A collection of settings that configure user interaction with the RStudioServerPro app.

This is a convenience method that creates an instance of the RStudioServerProAppSettings.Builder avoiding the need to create one manually via RStudioServerProAppSettings.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to rStudioServerProAppSettings(RStudioServerProAppSettings).

Parameters:

rStudioServerProAppSettings - a consumer that will call methods on RStudioServerProAppSettings.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

rStudioServerProAppSettings(RStudioServerProAppSettings)

rSessionAppSettings

UserSettings.Builder rSessionAppSettings(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.

rSessionAppSettings

default UserSettings.Builder rSessionAppSettings(Consumer<RSessionAppSettings.Builder> rSessionAppSettings)

A collection of settings that configure the RSessionGateway app.

This is a convenience method that creates an instance of the RSessionAppSettings.Builder avoiding the need to create one manually via RSessionAppSettings.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to rSessionAppSettings(RSessionAppSettings).

Parameters:

rSessionAppSettings - a consumer that will call methods on RSessionAppSettings.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

rSessionAppSettings(RSessionAppSettings)

canvasAppSettings

UserSettings.Builder canvasAppSettings(CanvasAppSettings canvasAppSettings)

The Canvas app settings.

Parameters:

canvasAppSettings - The Canvas app settings.

Returns:

Returns a reference to this object so that method calls can be chained together.

canvasAppSettings

default UserSettings.Builder canvasAppSettings(Consumer<CanvasAppSettings.Builder> canvasAppSettings)

The Canvas app settings.

This is a convenience method that creates an instance of the CanvasAppSettings.Builder avoiding the need to create one manually via CanvasAppSettings.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to canvasAppSettings(CanvasAppSettings).

Parameters:

canvasAppSettings - a consumer that will call methods on CanvasAppSettings.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

canvasAppSettings(CanvasAppSettings)

codeEditorAppSettings

UserSettings.Builder codeEditorAppSettings(CodeEditorAppSettings codeEditorAppSettings)

The Code Editor application settings.

Parameters:

codeEditorAppSettings - The Code Editor application settings.

Returns:

Returns a reference to this object so that method calls can be chained together.

codeEditorAppSettings

default UserSettings.Builder codeEditorAppSettings(Consumer<CodeEditorAppSettings.Builder> codeEditorAppSettings)

The Code Editor application settings.

This is a convenience method that creates an instance of the CodeEditorAppSettings.Builder avoiding the need to create one manually via CodeEditorAppSettings.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to codeEditorAppSettings(CodeEditorAppSettings).

Parameters:

codeEditorAppSettings - a consumer that will call methods on CodeEditorAppSettings.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

codeEditorAppSettings(CodeEditorAppSettings)

jupyterLabAppSettings

UserSettings.Builder jupyterLabAppSettings(JupyterLabAppSettings jupyterLabAppSettings)

The settings for the JupyterLab application.

Parameters:

jupyterLabAppSettings - The settings for the JupyterLab application.

Returns:

Returns a reference to this object so that method calls can be chained together.

jupyterLabAppSettings

default UserSettings.Builder jupyterLabAppSettings(Consumer<JupyterLabAppSettings.Builder> jupyterLabAppSettings)

The settings for the JupyterLab application.

This is a convenience method that creates an instance of the JupyterLabAppSettings.Builder avoiding the need to create one manually via JupyterLabAppSettings.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to jupyterLabAppSettings(JupyterLabAppSettings).

Parameters:

jupyterLabAppSettings - a consumer that will call methods on JupyterLabAppSettings.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

jupyterLabAppSettings(JupyterLabAppSettings)

spaceStorageSettings

UserSettings.Builder spaceStorageSettings(DefaultSpaceStorageSettings spaceStorageSettings)

The storage settings for a private space.

Parameters:

spaceStorageSettings - The storage settings for a private space.

Returns:

Returns a reference to this object so that method calls can be chained together.

spaceStorageSettings

default UserSettings.Builder spaceStorageSettings(Consumer<DefaultSpaceStorageSettings.Builder> spaceStorageSettings)

The storage settings for a private space.

This is a convenience method that creates an instance of the DefaultSpaceStorageSettings.Builder avoiding the need to create one manually via DefaultSpaceStorageSettings.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to spaceStorageSettings(DefaultSpaceStorageSettings).

Parameters:

spaceStorageSettings - a consumer that will call methods on DefaultSpaceStorageSettings.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

spaceStorageSettings(DefaultSpaceStorageSettings)

defaultLandingUri

UserSettings.Builder defaultLandingUri(String 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 if StudioWebPortal is set to ENABLED.

• app:JupyterServer:: Indicates that Studio Classic is the default experience.

Parameters:

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 if StudioWebPortal is set to ENABLED.

• app:JupyterServer:: Indicates that Studio Classic is the default experience.

Returns:

Returns a reference to this object so that method calls can be chained together.

studioWebPortal

UserSettings.Builder studioWebPortal(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

StudioWebPortal, StudioWebPortal

studioWebPortal

UserSettings.Builder studioWebPortal(StudioWebPortal 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

StudioWebPortal, StudioWebPortal

customPosixUserConfig

UserSettings.Builder customPosixUserConfig(CustomPosixUserConfig customPosixUserConfig)

Details about the POSIX identity that is used for file system operations.

Parameters:

customPosixUserConfig - Details about the POSIX identity that is used for file system operations.

Returns:

Returns a reference to this object so that method calls can be chained together.

customPosixUserConfig

default UserSettings.Builder customPosixUserConfig(Consumer<CustomPosixUserConfig.Builder> customPosixUserConfig)

Details about the POSIX identity that is used for file system operations.

This is a convenience method that creates an instance of the CustomPosixUserConfig.Builder avoiding the need to create one manually via CustomPosixUserConfig.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to customPosixUserConfig(CustomPosixUserConfig).

Parameters:

customPosixUserConfig - a consumer that will call methods on CustomPosixUserConfig.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

customPosixUserConfig(CustomPosixUserConfig)

customFileSystemConfigs

UserSettings.Builder customFileSystemConfigs(Collection<CustomFileSystemConfig> customFileSystemConfigs)

The settings for assigning a custom file system to a user profile. Permitted users can access this file system in Amazon SageMaker Studio.

Parameters:

customFileSystemConfigs - The settings for assigning a custom file system to a user profile. Permitted users can access this file system in Amazon SageMaker Studio.

Returns:

Returns a reference to this object so that method calls can be chained together.

customFileSystemConfigs

UserSettings.Builder customFileSystemConfigs(CustomFileSystemConfig... customFileSystemConfigs)

The settings for assigning a custom file system to a user profile. Permitted users can access this file system in Amazon SageMaker Studio.

Parameters:

customFileSystemConfigs - The settings for assigning a custom file system to a user profile. Permitted users can access this file system in Amazon SageMaker Studio.

Returns:

Returns a reference to this object so that method calls can be chained together.

customFileSystemConfigs

UserSettings.Builder customFileSystemConfigs(Consumer<CustomFileSystemConfig.Builder>... customFileSystemConfigs)

The settings for assigning a custom file system to a user profile. Permitted users can access this file system in Amazon SageMaker Studio.

This is a convenience method that creates an instance of the CustomFileSystemConfig.Builder avoiding the need to create one manually via CustomFileSystemConfig.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #customFileSystemConfigs(List).

Parameters:

customFileSystemConfigs - a consumer that will call methods on CustomFileSystemConfig.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#customFileSystemConfigs(java.util.Collection)