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 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`.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#canvas_app_settings ⇒ Types::CanvasAppSettings
The Canvas app settings.
-
#execution_role ⇒ String
The execution role for the user.
-
#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 Studio uses for communication.
-
#sharing_settings ⇒ Types::SharingSettings
Specifies options for sharing SageMaker Studio notebooks.
-
#tensor_board_app_settings ⇒ Types::TensorBoardAppSettings
The TensorBoard app settings.
Instance Attribute Details
#canvas_app_settings ⇒ Types::CanvasAppSettings
The Canvas app settings.
41713 41714 41715 41716 41717 41718 41719 41720 41721 41722 41723 41724 41725 |
# File 'lib/aws-sdk-sagemaker/types.rb', line 41713 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) SENSITIVE = [] include Aws::Structure end |
#execution_role ⇒ String
The execution role for the user.
41713 41714 41715 41716 41717 41718 41719 41720 41721 41722 41723 41724 41725 |
# File 'lib/aws-sdk-sagemaker/types.rb', line 41713 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) SENSITIVE = [] include Aws::Structure end |
#jupyter_server_app_settings ⇒ Types::JupyterServerAppSettings
The Jupyter server’s app settings.
41713 41714 41715 41716 41717 41718 41719 41720 41721 41722 41723 41724 41725 |
# File 'lib/aws-sdk-sagemaker/types.rb', line 41713 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) SENSITIVE = [] include Aws::Structure end |
#kernel_gateway_app_settings ⇒ Types::KernelGatewayAppSettings
The kernel gateway app settings.
41713 41714 41715 41716 41717 41718 41719 41720 41721 41722 41723 41724 41725 |
# File 'lib/aws-sdk-sagemaker/types.rb', line 41713 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) SENSITIVE = [] include Aws::Structure end |
#r_session_app_settings ⇒ Types::RSessionAppSettings
A collection of settings that configure the ‘RSessionGateway` app.
41713 41714 41715 41716 41717 41718 41719 41720 41721 41722 41723 41724 41725 |
# File 'lib/aws-sdk-sagemaker/types.rb', line 41713 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) 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.
41713 41714 41715 41716 41717 41718 41719 41720 41721 41722 41723 41724 41725 |
# File 'lib/aws-sdk-sagemaker/types.rb', line 41713 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) SENSITIVE = [] include Aws::Structure end |
#security_groups ⇒ Array<String>
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`, unless specified as part of the `DefaultUserSettings` for the domain.
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.
41713 41714 41715 41716 41717 41718 41719 41720 41721 41722 41723 41724 41725 |
# File 'lib/aws-sdk-sagemaker/types.rb', line 41713 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) SENSITIVE = [] include Aws::Structure end |
#sharing_settings ⇒ Types::SharingSettings
Specifies options for sharing SageMaker Studio notebooks.
41713 41714 41715 41716 41717 41718 41719 41720 41721 41722 41723 41724 41725 |
# File 'lib/aws-sdk-sagemaker/types.rb', line 41713 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) SENSITIVE = [] include Aws::Structure end |
#tensor_board_app_settings ⇒ Types::TensorBoardAppSettings
The TensorBoard app settings.
41713 41714 41715 41716 41717 41718 41719 41720 41721 41722 41723 41724 41725 |
# File 'lib/aws-sdk-sagemaker/types.rb', line 41713 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) SENSITIVE = [] include Aws::Structure end |