Class: AWSCDK::Sagemaker::CfnDomain::DefaultSpaceSettingsProperty

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

Overview

The default settings for shared spaces that users create in the domain.

SageMaker applies these settings only to shared spaces. It doesn't apply them to private spaces.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(execution_role:, custom_file_system_configs: nil, custom_posix_user_config: nil, jupyter_lab_app_settings: nil, jupyter_server_app_settings: nil, kernel_gateway_app_settings: nil, security_groups: nil, space_storage_settings: nil) ⇒ DefaultSpaceSettingsProperty

Returns a new instance of DefaultSpaceSettingsProperty.

Parameters:



1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
 
# File 'sagemaker/cfn_domain.rb', line 1125

def initialize(execution_role:, custom_file_system_configs: nil, custom_posix_user_config: nil, jupyter_lab_app_settings: nil, jupyter_server_app_settings: nil, kernel_gateway_app_settings: nil, security_groups: nil, space_storage_settings: nil)
  @execution_role = execution_role
  Jsii::Type.check_type(@execution_role, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "executionRole")
  @custom_file_system_configs = custom_file_system_configs
  Jsii::Type.check_type(@custom_file_system_configs, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc2FnZW1ha2VyLkNmbkRvbWFpbi5DdXN0b21GaWxlU3lzdGVtQ29uZmlnUHJvcGVydHkifV19fSwia2luZCI6ImFycmF5In19XX19")), "customFileSystemConfigs") unless @custom_file_system_configs.nil?
  @custom_posix_user_config = custom_posix_user_config.is_a?(Hash) ? ::AWSCDK::Sagemaker::CfnDomain::CustomPosixUserConfigProperty.new(**custom_posix_user_config.transform_keys(&:to_sym)) : custom_posix_user_config
  Jsii::Type.check_type(@custom_posix_user_config, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zYWdlbWFrZXIuQ2ZuRG9tYWluLkN1c3RvbVBvc2l4VXNlckNvbmZpZ1Byb3BlcnR5In1dfX0=")), "customPosixUserConfig") unless @custom_posix_user_config.nil?
  @jupyter_lab_app_settings = jupyter_lab_app_settings.is_a?(Hash) ? ::AWSCDK::Sagemaker::CfnDomain::JupyterLabAppSettingsProperty.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("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zYWdlbWFrZXIuQ2ZuRG9tYWluLkp1cHl0ZXJMYWJBcHBTZXR0aW5nc1Byb3BlcnR5In1dfX0=")), "jupyterLabAppSettings") unless @jupyter_lab_app_settings.nil?
  @jupyter_server_app_settings = jupyter_server_app_settings.is_a?(Hash) ? ::AWSCDK::Sagemaker::CfnDomain::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("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zYWdlbWFrZXIuQ2ZuRG9tYWluLkp1cHl0ZXJTZXJ2ZXJBcHBTZXR0aW5nc1Byb3BlcnR5In1dfX0=")), "jupyterServerAppSettings") unless @jupyter_server_app_settings.nil?
  @kernel_gateway_app_settings = kernel_gateway_app_settings.is_a?(Hash) ? ::AWSCDK::Sagemaker::CfnDomain::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("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zYWdlbWFrZXIuQ2ZuRG9tYWluLktlcm5lbEdhdGV3YXlBcHBTZXR0aW5nc1Byb3BlcnR5In1dfX0=")), "kernelGatewayAppSettings") unless @kernel_gateway_app_settings.nil?
  @security_groups = security_groups
  Jsii::Type.check_type(@security_groups, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "securityGroups") unless @security_groups.nil?
  @space_storage_settings = space_storage_settings.is_a?(Hash) ? ::AWSCDK::Sagemaker::CfnDomain::DefaultSpaceStorageSettingsProperty.new(**space_storage_settings.transform_keys(&:to_sym)) : space_storage_settings
  Jsii::Type.check_type(@space_storage_settings, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zYWdlbWFrZXIuQ2ZuRG9tYWluLkRlZmF1bHRTcGFjZVN0b3JhZ2VTZXR0aW5nc1Byb3BlcnR5In1dfX0=")), "spaceStorageSettings") unless @space_storage_settings.nil?
end

Instance Attribute Details

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

The settings for assigning a custom file system to a domain.

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

Returns:

See Also:



1155
1156
1157
 
# File 'sagemaker/cfn_domain.rb', line 1155

def custom_file_system_configs
  @custom_file_system_configs
end

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

Returns:

See Also:



1158
1159
1160
 
# File 'sagemaker/cfn_domain.rb', line 1158

def custom_posix_user_config
  @custom_posix_user_config
end

#execution_role ⇒ String (readonly)

The ARN of the execution role for the space.

Returns:

  • (String)

See Also:



1148
1149
1150
 
# File 'sagemaker/cfn_domain.rb', line 1148

def execution_role
  @execution_role
end

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

The JupyterLab app settings.

Returns:

See Also:



1163
1164
1165
 
# File 'sagemaker/cfn_domain.rb', line 1163

def jupyter_lab_app_settings
  @jupyter_lab_app_settings
end

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

The JupyterServer app settings.

Returns:

See Also:



1168
1169
1170
 
# File 'sagemaker/cfn_domain.rb', line 1168

def jupyter_server_app_settings
  @jupyter_server_app_settings
end

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

The KernelGateway app settings.

Returns:

See Also:



1173
1174
1175
 
# File 'sagemaker/cfn_domain.rb', line 1173

def kernel_gateway_app_settings
  @kernel_gateway_app_settings
end

#security_groups ⇒ Array<String>? (readonly)

The security group IDs for the Amazon VPC that the space uses for communication.

Returns:

  • (Array<String>, nil)

See Also:



1178
1179
1180
 
# File 'sagemaker/cfn_domain.rb', line 1178

def security_groups
  @security_groups
end

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

Default storage settings for a space.

Returns:

See Also:



1183
1184
1185
 
# File 'sagemaker/cfn_domain.rb', line 1183

def space_storage_settings
  @space_storage_settings
end

Class Method Details

.jsii_properties ⇒ Object 



1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
 
# File 'sagemaker/cfn_domain.rb', line 1185

def self.jsii_properties
  {
    :execution_role => "executionRole",
    :custom_file_system_configs => "customFileSystemConfigs",
    :custom_posix_user_config => "customPosixUserConfig",
    :jupyter_lab_app_settings => "jupyterLabAppSettings",
    :jupyter_server_app_settings => "jupyterServerAppSettings",
    :kernel_gateway_app_settings => "kernelGatewayAppSettings",
    :security_groups => "securityGroups",
    :space_storage_settings => "spaceStorageSettings",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
 
# File 'sagemaker/cfn_domain.rb', line 1198

def to_jsii
  result = {}
  result.merge!({
    "executionRole" => @execution_role,
    "customFileSystemConfigs" => @custom_file_system_configs,
    "customPosixUserConfig" => @custom_posix_user_config,
    "jupyterLabAppSettings" => @jupyter_lab_app_settings,
    "jupyterServerAppSettings" => @jupyter_server_app_settings,
    "kernelGatewayAppSettings" => @kernel_gateway_app_settings,
    "securityGroups" => @security_groups,
    "spaceStorageSettings" => @space_storage_settings,
  })
  result.compact
end