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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-sagemaker/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

Instance Attribute Details

#canvas_app_settingsTypes::CanvasAppSettings

The Canvas app settings.



38183
38184
38185
38186
38187
38188
38189
38190
38191
38192
38193
38194
38195
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 38183

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_roleString

The execution role for the user.

Returns:

  • (String)


38183
38184
38185
38186
38187
38188
38189
38190
38191
38192
38193
38194
38195
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 38183

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_settingsTypes::JupyterServerAppSettings

The Jupyter server's app settings.



38183
38184
38185
38186
38187
38188
38189
38190
38191
38192
38193
38194
38195
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 38183

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_settingsTypes::KernelGatewayAppSettings

The kernel gateway app settings.



38183
38184
38185
38186
38187
38188
38189
38190
38191
38192
38193
38194
38195
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 38183

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_settingsTypes::RSessionAppSettings

A collection of settings that configure the RSessionGateway app.



38183
38184
38185
38186
38187
38188
38189
38190
38191
38192
38193
38194
38195
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 38183

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_settingsTypes::RStudioServerProAppSettings

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



38183
38184
38185
38186
38187
38188
38189
38190
38191
38192
38193
38194
38195
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 38183

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_groupsArray<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.

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>)


38183
38184
38185
38186
38187
38188
38189
38190
38191
38192
38193
38194
38195
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 38183

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_settingsTypes::SharingSettings

Specifies options for sharing SageMaker Studio notebooks.



38183
38184
38185
38186
38187
38188
38189
38190
38191
38192
38193
38194
38195
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 38183

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_settingsTypes::TensorBoardAppSettings

The TensorBoard app settings.



38183
38184
38185
38186
38187
38188
38189
38190
38191
38192
38193
38194
38195
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 38183

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