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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb

Overview

Note:

When making an API call, you may pass UserSettings data as a hash:

{
  execution_role: "RoleArn",
  security_groups: ["SecurityGroupId"],
  sharing_settings: {
    notebook_output_option: "Allowed", # accepts Allowed, Disabled
    s3_output_path: "S3Uri",
    s3_kms_key_id: "KmsKeyId",
  },
  jupyter_server_app_settings: {
    default_resource_spec: {
      sage_maker_image_arn: "ImageArn",
      instance_type: "system", # accepts system, ml.t3.micro, ml.t3.small, ml.t3.medium, ml.t3.large, ml.t3.xlarge, ml.t3.2xlarge, ml.m5.large, ml.m5.xlarge, ml.m5.2xlarge, ml.m5.4xlarge, ml.m5.8xlarge, ml.m5.12xlarge, ml.m5.16xlarge, ml.m5.24xlarge, ml.c5.large, ml.c5.xlarge, ml.c5.2xlarge, ml.c5.4xlarge, ml.c5.9xlarge, ml.c5.12xlarge, ml.c5.18xlarge, ml.c5.24xlarge, ml.p3.2xlarge, ml.p3.8xlarge, ml.p3.16xlarge, ml.g4dn.xlarge, ml.g4dn.2xlarge, ml.g4dn.4xlarge, ml.g4dn.8xlarge, ml.g4dn.12xlarge, ml.g4dn.16xlarge
    },
  },
  kernel_gateway_app_settings: {
    default_resource_spec: {
      sage_maker_image_arn: "ImageArn",
      instance_type: "system", # accepts system, ml.t3.micro, ml.t3.small, ml.t3.medium, ml.t3.large, ml.t3.xlarge, ml.t3.2xlarge, ml.m5.large, ml.m5.xlarge, ml.m5.2xlarge, ml.m5.4xlarge, ml.m5.8xlarge, ml.m5.12xlarge, ml.m5.16xlarge, ml.m5.24xlarge, ml.c5.large, ml.c5.xlarge, ml.c5.2xlarge, ml.c5.4xlarge, ml.c5.9xlarge, ml.c5.12xlarge, ml.c5.18xlarge, ml.c5.24xlarge, ml.p3.2xlarge, ml.p3.8xlarge, ml.p3.16xlarge, ml.g4dn.xlarge, ml.g4dn.2xlarge, ml.g4dn.4xlarge, ml.g4dn.8xlarge, ml.g4dn.12xlarge, ml.g4dn.16xlarge
    },
  },
  tensor_board_app_settings: {
    default_resource_spec: {
      sage_maker_image_arn: "ImageArn",
      instance_type: "system", # accepts system, ml.t3.micro, ml.t3.small, ml.t3.medium, ml.t3.large, ml.t3.xlarge, ml.t3.2xlarge, ml.m5.large, ml.m5.xlarge, ml.m5.2xlarge, ml.m5.4xlarge, ml.m5.8xlarge, ml.m5.12xlarge, ml.m5.16xlarge, ml.m5.24xlarge, ml.c5.large, ml.c5.xlarge, ml.c5.2xlarge, ml.c5.4xlarge, ml.c5.9xlarge, ml.c5.12xlarge, ml.c5.18xlarge, ml.c5.24xlarge, ml.p3.2xlarge, ml.p3.8xlarge, ml.p3.16xlarge, ml.g4dn.xlarge, ml.g4dn.2xlarge, ml.g4dn.4xlarge, ml.g4dn.8xlarge, ml.g4dn.12xlarge, ml.g4dn.16xlarge
    },
  },
}

A collection of settings.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#execution_roleString

The execution role for the user.

Returns:

  • (String)


23287
23288
23289
23290
23291
23292
23293
23294
23295
23296
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 23287

class UserSettings < Struct.new(
  :execution_role,
  :security_groups,
  :sharing_settings,
  :jupyter_server_app_settings,
  :kernel_gateway_app_settings,
  :tensor_board_app_settings)
  SENSITIVE = []
  include Aws::Structure
end

#jupyter_server_app_settingsTypes::JupyterServerAppSettings

The Jupyter server's app settings.



23287
23288
23289
23290
23291
23292
23293
23294
23295
23296
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 23287

class UserSettings < Struct.new(
  :execution_role,
  :security_groups,
  :sharing_settings,
  :jupyter_server_app_settings,
  :kernel_gateway_app_settings,
  :tensor_board_app_settings)
  SENSITIVE = []
  include Aws::Structure
end

#kernel_gateway_app_settingsTypes::KernelGatewayAppSettings

The kernel gateway app settings.



23287
23288
23289
23290
23291
23292
23293
23294
23295
23296
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 23287

class UserSettings < Struct.new(
  :execution_role,
  :security_groups,
  :sharing_settings,
  :jupyter_server_app_settings,
  :kernel_gateway_app_settings,
  :tensor_board_app_settings)
  SENSITIVE = []
  include Aws::Structure
end

#security_groupsArray<String>

The security groups.

Returns:

  • (Array<String>)


23287
23288
23289
23290
23291
23292
23293
23294
23295
23296
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 23287

class UserSettings < Struct.new(
  :execution_role,
  :security_groups,
  :sharing_settings,
  :jupyter_server_app_settings,
  :kernel_gateway_app_settings,
  :tensor_board_app_settings)
  SENSITIVE = []
  include Aws::Structure
end

#sharing_settingsTypes::SharingSettings

The sharing settings.



23287
23288
23289
23290
23291
23292
23293
23294
23295
23296
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 23287

class UserSettings < Struct.new(
  :execution_role,
  :security_groups,
  :sharing_settings,
  :jupyter_server_app_settings,
  :kernel_gateway_app_settings,
  :tensor_board_app_settings)
  SENSITIVE = []
  include Aws::Structure
end

#tensor_board_app_settingsTypes::TensorBoardAppSettings

The TensorBoard app settings.



23287
23288
23289
23290
23291
23292
23293
23294
23295
23296
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 23287

class UserSettings < Struct.new(
  :execution_role,
  :security_groups,
  :sharing_settings,
  :jupyter_server_app_settings,
  :kernel_gateway_app_settings,
  :tensor_board_app_settings)
  SENSITIVE = []
  include Aws::Structure
end