Class: Aws::SageMaker::Types::UserSettings
- Inherits:
-
Struct
- Object
- Struct
- Aws::SageMaker::Types::UserSettings
- Includes:
- Aws::Structure
- Defined in:
- lib/aws-sdk-sagemaker/types.rb
Overview
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`.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#canvas_app_settings ⇒ Types::CanvasAppSettings
The Canvas app settings.
-
#code_editor_app_settings ⇒ Types::CodeEditorAppSettings
The Code Editor application settings.
-
#custom_file_system_configs ⇒ Array<Types::CustomFileSystemConfig>
The settings for assigning a custom file system to a user profile.
-
#custom_posix_user_config ⇒ Types::CustomPosixUserConfig
Details about the POSIX identity that is used for file system operations.
-
#default_landing_uri ⇒ String
The default experience that the user is directed to when accessing the domain.
-
#execution_role ⇒ String
The execution role for the user.
-
#jupyter_lab_app_settings ⇒ Types::JupyterLabAppSettings
The settings for the JupyterLab application.
-
#jupyter_server_app_settings ⇒ Types::JupyterServerAppSettings
The Jupyter server’s app settings.
-
#kernel_gateway_app_settings ⇒ Types::KernelGatewayAppSettings
The kernel gateway app settings.
-
#r_session_app_settings ⇒ Types::RSessionAppSettings
A collection of settings that configure the ‘RSessionGateway` app.
-
#r_studio_server_pro_app_settings ⇒ Types::RStudioServerProAppSettings
A collection of settings that configure user interaction with the ‘RStudioServerPro` app.
-
#security_groups ⇒ Array<String>
The security groups for the Amazon Virtual Private Cloud (VPC) that the domain uses for communication.
-
#sharing_settings ⇒ Types::SharingSettings
Specifies options for sharing Amazon SageMaker Studio notebooks.
-
#space_storage_settings ⇒ Types::DefaultSpaceStorageSettings
The storage settings for a space.
-
#studio_web_portal ⇒ String
Whether the user can access Studio.
-
#tensor_board_app_settings ⇒ Types::TensorBoardAppSettings
The TensorBoard app settings.
Instance Attribute Details
#canvas_app_settings ⇒ Types::CanvasAppSettings
The Canvas app settings.
44923 44924 44925 44926 44927 44928 44929 44930 44931 44932 44933 44934 44935 44936 44937 44938 44939 44940 44941 44942 |
# File 'lib/aws-sdk-sagemaker/types.rb', line 44923 class UserSettings < Struct.new( :execution_role, :security_groups, :sharing_settings, :jupyter_server_app_settings, :kernel_gateway_app_settings, :tensor_board_app_settings, :r_studio_server_pro_app_settings, :r_session_app_settings, :canvas_app_settings, :code_editor_app_settings, :jupyter_lab_app_settings, :space_storage_settings, :default_landing_uri, :studio_web_portal, :custom_posix_user_config, :custom_file_system_configs) SENSITIVE = [] include Aws::Structure end |
#code_editor_app_settings ⇒ Types::CodeEditorAppSettings
The Code Editor application settings.
44923 44924 44925 44926 44927 44928 44929 44930 44931 44932 44933 44934 44935 44936 44937 44938 44939 44940 44941 44942 |
# File 'lib/aws-sdk-sagemaker/types.rb', line 44923 class UserSettings < Struct.new( :execution_role, :security_groups, :sharing_settings, :jupyter_server_app_settings, :kernel_gateway_app_settings, :tensor_board_app_settings, :r_studio_server_pro_app_settings, :r_session_app_settings, :canvas_app_settings, :code_editor_app_settings, :jupyter_lab_app_settings, :space_storage_settings, :default_landing_uri, :studio_web_portal, :custom_posix_user_config, :custom_file_system_configs) SENSITIVE = [] include Aws::Structure end |
#custom_file_system_configs ⇒ Array<Types::CustomFileSystemConfig>
The settings for assigning a custom file system to a user profile. Permitted users can access this file system in Amazon SageMaker Studio.
44923 44924 44925 44926 44927 44928 44929 44930 44931 44932 44933 44934 44935 44936 44937 44938 44939 44940 44941 44942 |
# File 'lib/aws-sdk-sagemaker/types.rb', line 44923 class UserSettings < Struct.new( :execution_role, :security_groups, :sharing_settings, :jupyter_server_app_settings, :kernel_gateway_app_settings, :tensor_board_app_settings, :r_studio_server_pro_app_settings, :r_session_app_settings, :canvas_app_settings, :code_editor_app_settings, :jupyter_lab_app_settings, :space_storage_settings, :default_landing_uri, :studio_web_portal, :custom_posix_user_config, :custom_file_system_configs) SENSITIVE = [] include Aws::Structure end |
#custom_posix_user_config ⇒ Types::CustomPosixUserConfig
Details about the POSIX identity that is used for file system operations.
44923 44924 44925 44926 44927 44928 44929 44930 44931 44932 44933 44934 44935 44936 44937 44938 44939 44940 44941 44942 |
# File 'lib/aws-sdk-sagemaker/types.rb', line 44923 class UserSettings < Struct.new( :execution_role, :security_groups, :sharing_settings, :jupyter_server_app_settings, :kernel_gateway_app_settings, :tensor_board_app_settings, :r_studio_server_pro_app_settings, :r_session_app_settings, :canvas_app_settings, :code_editor_app_settings, :jupyter_lab_app_settings, :space_storage_settings, :default_landing_uri, :studio_web_portal, :custom_posix_user_config, :custom_file_system_configs) SENSITIVE = [] include Aws::Structure end |
#default_landing_uri ⇒ String
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.
44923 44924 44925 44926 44927 44928 44929 44930 44931 44932 44933 44934 44935 44936 44937 44938 44939 44940 44941 44942 |
# File 'lib/aws-sdk-sagemaker/types.rb', line 44923 class UserSettings < Struct.new( :execution_role, :security_groups, :sharing_settings, :jupyter_server_app_settings, :kernel_gateway_app_settings, :tensor_board_app_settings, :r_studio_server_pro_app_settings, :r_session_app_settings, :canvas_app_settings, :code_editor_app_settings, :jupyter_lab_app_settings, :space_storage_settings, :default_landing_uri, :studio_web_portal, :custom_posix_user_config, :custom_file_system_configs) SENSITIVE = [] include Aws::Structure end |
#execution_role ⇒ String
The execution role for the user.
44923 44924 44925 44926 44927 44928 44929 44930 44931 44932 44933 44934 44935 44936 44937 44938 44939 44940 44941 44942 |
# File 'lib/aws-sdk-sagemaker/types.rb', line 44923 class UserSettings < Struct.new( :execution_role, :security_groups, :sharing_settings, :jupyter_server_app_settings, :kernel_gateway_app_settings, :tensor_board_app_settings, :r_studio_server_pro_app_settings, :r_session_app_settings, :canvas_app_settings, :code_editor_app_settings, :jupyter_lab_app_settings, :space_storage_settings, :default_landing_uri, :studio_web_portal, :custom_posix_user_config, :custom_file_system_configs) SENSITIVE = [] include Aws::Structure end |
#jupyter_lab_app_settings ⇒ Types::JupyterLabAppSettings
The settings for the JupyterLab application.
44923 44924 44925 44926 44927 44928 44929 44930 44931 44932 44933 44934 44935 44936 44937 44938 44939 44940 44941 44942 |
# File 'lib/aws-sdk-sagemaker/types.rb', line 44923 class UserSettings < Struct.new( :execution_role, :security_groups, :sharing_settings, :jupyter_server_app_settings, :kernel_gateway_app_settings, :tensor_board_app_settings, :r_studio_server_pro_app_settings, :r_session_app_settings, :canvas_app_settings, :code_editor_app_settings, :jupyter_lab_app_settings, :space_storage_settings, :default_landing_uri, :studio_web_portal, :custom_posix_user_config, :custom_file_system_configs) SENSITIVE = [] include Aws::Structure end |
#jupyter_server_app_settings ⇒ Types::JupyterServerAppSettings
The Jupyter server’s app settings.
44923 44924 44925 44926 44927 44928 44929 44930 44931 44932 44933 44934 44935 44936 44937 44938 44939 44940 44941 44942 |
# File 'lib/aws-sdk-sagemaker/types.rb', line 44923 class UserSettings < Struct.new( :execution_role, :security_groups, :sharing_settings, :jupyter_server_app_settings, :kernel_gateway_app_settings, :tensor_board_app_settings, :r_studio_server_pro_app_settings, :r_session_app_settings, :canvas_app_settings, :code_editor_app_settings, :jupyter_lab_app_settings, :space_storage_settings, :default_landing_uri, :studio_web_portal, :custom_posix_user_config, :custom_file_system_configs) SENSITIVE = [] include Aws::Structure end |
#kernel_gateway_app_settings ⇒ Types::KernelGatewayAppSettings
The kernel gateway app settings.
44923 44924 44925 44926 44927 44928 44929 44930 44931 44932 44933 44934 44935 44936 44937 44938 44939 44940 44941 44942 |
# File 'lib/aws-sdk-sagemaker/types.rb', line 44923 class UserSettings < Struct.new( :execution_role, :security_groups, :sharing_settings, :jupyter_server_app_settings, :kernel_gateway_app_settings, :tensor_board_app_settings, :r_studio_server_pro_app_settings, :r_session_app_settings, :canvas_app_settings, :code_editor_app_settings, :jupyter_lab_app_settings, :space_storage_settings, :default_landing_uri, :studio_web_portal, :custom_posix_user_config, :custom_file_system_configs) SENSITIVE = [] include Aws::Structure end |
#r_session_app_settings ⇒ Types::RSessionAppSettings
A collection of settings that configure the ‘RSessionGateway` app.
44923 44924 44925 44926 44927 44928 44929 44930 44931 44932 44933 44934 44935 44936 44937 44938 44939 44940 44941 44942 |
# File 'lib/aws-sdk-sagemaker/types.rb', line 44923 class UserSettings < Struct.new( :execution_role, :security_groups, :sharing_settings, :jupyter_server_app_settings, :kernel_gateway_app_settings, :tensor_board_app_settings, :r_studio_server_pro_app_settings, :r_session_app_settings, :canvas_app_settings, :code_editor_app_settings, :jupyter_lab_app_settings, :space_storage_settings, :default_landing_uri, :studio_web_portal, :custom_posix_user_config, :custom_file_system_configs) SENSITIVE = [] include Aws::Structure end |
#r_studio_server_pro_app_settings ⇒ Types::RStudioServerProAppSettings
A collection of settings that configure user interaction with the ‘RStudioServerPro` app.
44923 44924 44925 44926 44927 44928 44929 44930 44931 44932 44933 44934 44935 44936 44937 44938 44939 44940 44941 44942 |
# File 'lib/aws-sdk-sagemaker/types.rb', line 44923 class UserSettings < Struct.new( :execution_role, :security_groups, :sharing_settings, :jupyter_server_app_settings, :kernel_gateway_app_settings, :tensor_board_app_settings, :r_studio_server_pro_app_settings, :r_session_app_settings, :canvas_app_settings, :code_editor_app_settings, :jupyter_lab_app_settings, :space_storage_settings, :default_landing_uri, :studio_web_portal, :custom_posix_user_config, :custom_file_system_configs) SENSITIVE = [] include Aws::Structure end |
#security_groups ⇒ Array<String>
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.
44923 44924 44925 44926 44927 44928 44929 44930 44931 44932 44933 44934 44935 44936 44937 44938 44939 44940 44941 44942 |
# File 'lib/aws-sdk-sagemaker/types.rb', line 44923 class UserSettings < Struct.new( :execution_role, :security_groups, :sharing_settings, :jupyter_server_app_settings, :kernel_gateway_app_settings, :tensor_board_app_settings, :r_studio_server_pro_app_settings, :r_session_app_settings, :canvas_app_settings, :code_editor_app_settings, :jupyter_lab_app_settings, :space_storage_settings, :default_landing_uri, :studio_web_portal, :custom_posix_user_config, :custom_file_system_configs) SENSITIVE = [] include Aws::Structure end |
#sharing_settings ⇒ Types::SharingSettings
Specifies options for sharing Amazon SageMaker Studio notebooks.
44923 44924 44925 44926 44927 44928 44929 44930 44931 44932 44933 44934 44935 44936 44937 44938 44939 44940 44941 44942 |
# File 'lib/aws-sdk-sagemaker/types.rb', line 44923 class UserSettings < Struct.new( :execution_role, :security_groups, :sharing_settings, :jupyter_server_app_settings, :kernel_gateway_app_settings, :tensor_board_app_settings, :r_studio_server_pro_app_settings, :r_session_app_settings, :canvas_app_settings, :code_editor_app_settings, :jupyter_lab_app_settings, :space_storage_settings, :default_landing_uri, :studio_web_portal, :custom_posix_user_config, :custom_file_system_configs) SENSITIVE = [] include Aws::Structure end |
#space_storage_settings ⇒ Types::DefaultSpaceStorageSettings
The storage settings for a space.
44923 44924 44925 44926 44927 44928 44929 44930 44931 44932 44933 44934 44935 44936 44937 44938 44939 44940 44941 44942 |
# File 'lib/aws-sdk-sagemaker/types.rb', line 44923 class UserSettings < Struct.new( :execution_role, :security_groups, :sharing_settings, :jupyter_server_app_settings, :kernel_gateway_app_settings, :tensor_board_app_settings, :r_studio_server_pro_app_settings, :r_session_app_settings, :canvas_app_settings, :code_editor_app_settings, :jupyter_lab_app_settings, :space_storage_settings, :default_landing_uri, :studio_web_portal, :custom_posix_user_config, :custom_file_system_configs) SENSITIVE = [] include Aws::Structure end |
#studio_web_portal ⇒ String
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.
44923 44924 44925 44926 44927 44928 44929 44930 44931 44932 44933 44934 44935 44936 44937 44938 44939 44940 44941 44942 |
# File 'lib/aws-sdk-sagemaker/types.rb', line 44923 class UserSettings < Struct.new( :execution_role, :security_groups, :sharing_settings, :jupyter_server_app_settings, :kernel_gateway_app_settings, :tensor_board_app_settings, :r_studio_server_pro_app_settings, :r_session_app_settings, :canvas_app_settings, :code_editor_app_settings, :jupyter_lab_app_settings, :space_storage_settings, :default_landing_uri, :studio_web_portal, :custom_posix_user_config, :custom_file_system_configs) SENSITIVE = [] include Aws::Structure end |
#tensor_board_app_settings ⇒ Types::TensorBoardAppSettings
The TensorBoard app settings.
44923 44924 44925 44926 44927 44928 44929 44930 44931 44932 44933 44934 44935 44936 44937 44938 44939 44940 44941 44942 |
# File 'lib/aws-sdk-sagemaker/types.rb', line 44923 class UserSettings < Struct.new( :execution_role, :security_groups, :sharing_settings, :jupyter_server_app_settings, :kernel_gateway_app_settings, :tensor_board_app_settings, :r_studio_server_pro_app_settings, :r_session_app_settings, :canvas_app_settings, :code_editor_app_settings, :jupyter_lab_app_settings, :space_storage_settings, :default_landing_uri, :studio_web_portal, :custom_posix_user_config, :custom_file_system_configs) SENSITIVE = [] include Aws::Structure end |