Class: AWSCDK::Sagemaker::CfnSpace::SpaceSettingsProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
sagemaker/cfn_space.rb

Overview

A collection of space settings.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(app_type: nil, code_editor_app_settings: nil, custom_file_systems: nil, jupyter_lab_app_settings: nil, jupyter_server_app_settings: nil, kernel_gateway_app_settings: nil, remote_access: nil, space_managed_resources: nil, space_storage_settings: nil) ⇒ SpaceSettingsProperty

Returns a new instance of SpaceSettingsProperty.

Parameters:



1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
 
# File 'sagemaker/cfn_space.rb', line 1295

def initialize(app_type: nil, code_editor_app_settings: nil, custom_file_systems: nil, jupyter_lab_app_settings: nil, jupyter_server_app_settings: nil, kernel_gateway_app_settings: nil, remote_access: nil, space_managed_resources: nil, space_storage_settings: nil)
  @app_type = app_type
  Jsii::Type.check_type(@app_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "appType") unless @app_type.nil?
  @code_editor_app_settings = code_editor_app_settings.is_a?(Hash) ? ::AWSCDK::Sagemaker::CfnSpace::SpaceCodeEditorAppSettingsProperty.new(**code_editor_app_settings.transform_keys(&:to_sym)) : code_editor_app_settings
  Jsii::Type.check_type(@code_editor_app_settings, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zYWdlbWFrZXIuQ2ZuU3BhY2UuU3BhY2VDb2RlRWRpdG9yQXBwU2V0dGluZ3NQcm9wZXJ0eSJ9XX19")), "codeEditorAppSettings") unless @code_editor_app_settings.nil?
  @custom_file_systems = custom_file_systems
  Jsii::Type.check_type(@custom_file_systems, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc2FnZW1ha2VyLkNmblNwYWNlLkN1c3RvbUZpbGVTeXN0ZW1Qcm9wZXJ0eSJ9XX19LCJraW5kIjoiYXJyYXkifX1dfX0=")), "customFileSystems") unless @custom_file_systems.nil?
  @jupyter_lab_app_settings = jupyter_lab_app_settings.is_a?(Hash) ? ::AWSCDK::Sagemaker::CfnSpace::SpaceJupyterLabAppSettingsProperty.new(**jupyter_lab_app_settings.transform_keys(&:to_sym)) : jupyter_lab_app_settings
  Jsii::Type.check_type(@jupyter_lab_app_settings, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zYWdlbWFrZXIuQ2ZuU3BhY2UuU3BhY2VKdXB5dGVyTGFiQXBwU2V0dGluZ3NQcm9wZXJ0eSJ9XX19")), "jupyterLabAppSettings") unless @jupyter_lab_app_settings.nil?
  @jupyter_server_app_settings = jupyter_server_app_settings.is_a?(Hash) ? ::AWSCDK::Sagemaker::CfnSpace::JupyterServerAppSettingsProperty.new(**jupyter_server_app_settings.transform_keys(&:to_sym)) : jupyter_server_app_settings
  Jsii::Type.check_type(@jupyter_server_app_settings, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zYWdlbWFrZXIuQ2ZuU3BhY2UuSnVweXRlclNlcnZlckFwcFNldHRpbmdzUHJvcGVydHkifV19fQ==")), "jupyterServerAppSettings") unless @jupyter_server_app_settings.nil?
  @kernel_gateway_app_settings = kernel_gateway_app_settings.is_a?(Hash) ? ::AWSCDK::Sagemaker::CfnSpace::KernelGatewayAppSettingsProperty.new(**kernel_gateway_app_settings.transform_keys(&:to_sym)) : kernel_gateway_app_settings
  Jsii::Type.check_type(@kernel_gateway_app_settings, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zYWdlbWFrZXIuQ2ZuU3BhY2UuS2VybmVsR2F0ZXdheUFwcFNldHRpbmdzUHJvcGVydHkifV19fQ==")), "kernelGatewayAppSettings") unless @kernel_gateway_app_settings.nil?
  @remote_access = remote_access
  Jsii::Type.check_type(@remote_access, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "remoteAccess") unless @remote_access.nil?
  @space_managed_resources = space_managed_resources
  Jsii::Type.check_type(@space_managed_resources, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "spaceManagedResources") unless @space_managed_resources.nil?
  @space_storage_settings = space_storage_settings.is_a?(Hash) ? ::AWSCDK::Sagemaker::CfnSpace::SpaceStorageSettingsProperty.new(**space_storage_settings.transform_keys(&:to_sym)) : space_storage_settings
  Jsii::Type.check_type(@space_storage_settings, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zYWdlbWFrZXIuQ2ZuU3BhY2UuU3BhY2VTdG9yYWdlU2V0dGluZ3NQcm9wZXJ0eSJ9XX19")), "spaceStorageSettings") unless @space_storage_settings.nil?
end

Instance Attribute Details

#app_type ⇒ String? (readonly)

The type of app created within the space.

If using the UpdateSpace API, you can't change the app type of your space by specifying a different value for this field.

Returns:

  • (String, nil)

See Also:



1322
1323
1324
 
# File 'sagemaker/cfn_space.rb', line 1322

def app_type
  @app_type
end

#code_editor_app_settings ⇒ AWSCDK::IResolvable, ... (readonly)

The Code Editor application settings.

Returns:

See Also:



1327
1328
1329
 
# File 'sagemaker/cfn_space.rb', line 1327

def code_editor_app_settings
  @code_editor_app_settings
end

#custom_file_systems ⇒ AWSCDK::IResolvable, ... (readonly)

A file system, created by you, that you assign to a space for an Amazon SageMaker AI Domain.

Permitted users can access this file system in Amazon SageMaker AI Studio.

Returns:

See Also:



1334
1335
1336
 
# File 'sagemaker/cfn_space.rb', line 1334

def custom_file_systems
  @custom_file_systems
end

#jupyter_lab_app_settings ⇒ AWSCDK::IResolvable, ... (readonly)

The settings for the JupyterLab application.

Returns:

See Also:



1339
1340
1341
 
# File 'sagemaker/cfn_space.rb', line 1339

def jupyter_lab_app_settings
  @jupyter_lab_app_settings
end

#jupyter_server_app_settings ⇒ AWSCDK::IResolvable, ... (readonly)

The JupyterServer app settings.

Returns:

See Also:



1344
1345
1346
 
# File 'sagemaker/cfn_space.rb', line 1344

def jupyter_server_app_settings
  @jupyter_server_app_settings
end

#kernel_gateway_app_settings ⇒ AWSCDK::IResolvable, ... (readonly)

The KernelGateway app settings.

Returns:

See Also:



1349
1350
1351
 
# File 'sagemaker/cfn_space.rb', line 1349

def kernel_gateway_app_settings
  @kernel_gateway_app_settings
end

#remote_access ⇒ String? (readonly)

A setting that enables or disables remote access for a SageMaker space.

When enabled, this allows you to connect to the remote space from your local IDE.

Returns:

  • (String, nil)

See Also:



1356
1357
1358
 
# File 'sagemaker/cfn_space.rb', line 1356

def remote_access
  @remote_access
end

#space_managed_resources ⇒ String? (readonly)

If you enable this option, SageMaker AI creates the following resources on your behalf when you create the space:.

  • The user profile that possesses the space.
  • The app that the space contains.

Returns:

  • (String, nil)

See Also:



1364
1365
1366
 
# File 'sagemaker/cfn_space.rb', line 1364

def space_managed_resources
  @space_managed_resources
end

#space_storage_settings ⇒ AWSCDK::IResolvable, ... (readonly)

The storage settings for a space.

Returns:

See Also:



1369
1370
1371
 
# File 'sagemaker/cfn_space.rb', line 1369

def space_storage_settings
  @space_storage_settings
end

Class Method Details

.jsii_properties ⇒ Object 



1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
 
# File 'sagemaker/cfn_space.rb', line 1371

def self.jsii_properties
  {
    :app_type => "appType",
    :code_editor_app_settings => "codeEditorAppSettings",
    :custom_file_systems => "customFileSystems",
    :jupyter_lab_app_settings => "jupyterLabAppSettings",
    :jupyter_server_app_settings => "jupyterServerAppSettings",
    :kernel_gateway_app_settings => "kernelGatewayAppSettings",
    :remote_access => "remoteAccess",
    :space_managed_resources => "spaceManagedResources",
    :space_storage_settings => "spaceStorageSettings",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
 
# File 'sagemaker/cfn_space.rb', line 1385

def to_jsii
  result = {}
  result.merge!({
    "appType" => @app_type,
    "codeEditorAppSettings" => @code_editor_app_settings,
    "customFileSystems" => @custom_file_systems,
    "jupyterLabAppSettings" => @jupyter_lab_app_settings,
    "jupyterServerAppSettings" => @jupyter_server_app_settings,
    "kernelGatewayAppSettings" => @kernel_gateway_app_settings,
    "remoteAccess" => @remote_access,
    "spaceManagedResources" => @space_managed_resources,
    "spaceStorageSettings" => @space_storage_settings,
  })
  result.compact
end