Class: Aws::SageMaker::Types::UserSettings

Inherits:
Struct
  • Object
show all
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`.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#canvas_app_settings ⇒ Types::CanvasAppSettings

The Canvas app settings.

Returns:



42086
42087
42088
42089
42090
42091
42092
42093
42094
42095
42096
42097
42098
 
# File 'lib/aws-sdk-sagemaker/types.rb', line 42086

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.

Returns:

  • (String) 


42086
42087
42088
42089
42090
42091
42092
42093
42094
42095
42096
42097
42098
 
# File 'lib/aws-sdk-sagemaker/types.rb', line 42086

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.

Returns:



42086
42087
42088
42089
42090
42091
42092
42093
42094
42095
42096
42097
42098
 
# File 'lib/aws-sdk-sagemaker/types.rb', line 42086

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.

Returns:



42086
42087
42088
42089
42090
42091
42092
42093
42094
42095
42096
42097
42098
 
# File 'lib/aws-sdk-sagemaker/types.rb', line 42086

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.

Returns:



42086
42087
42088
42089
42090
42091
42092
42093
42094
42095
42096
42097
42098
 
# File 'lib/aws-sdk-sagemaker/types.rb', line 42086

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.

Returns:



42086
42087
42088
42089
42090
42091
42092
42093
42094
42095
42096
42097
42098
 
# File 'lib/aws-sdk-sagemaker/types.rb', line 42086

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.

Returns:

  • (Array<String>) 


42086
42087
42088
42089
42090
42091
42092
42093
42094
42095
42096
42097
42098
 
# File 'lib/aws-sdk-sagemaker/types.rb', line 42086

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.

Returns:



42086
42087
42088
42089
42090
42091
42092
42093
42094
42095
42096
42097
42098
 
# File 'lib/aws-sdk-sagemaker/types.rb', line 42086

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.

Returns:



42086
42087
42088
42089
42090
42091
42092
42093
42094
42095
42096
42097
42098
 
# File 'lib/aws-sdk-sagemaker/types.rb', line 42086

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