Class: AWSCDK::Sagemaker::CfnDomain::DomainSettingsProperty

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

Overview

A collection of settings that apply to the SageMaker Domain .

These settings are specified through the CreateDomain API call.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(docker_settings: nil, execution_role_identity_config: nil, ip_address_type: nil, r_studio_server_pro_domain_settings: nil, security_group_ids: nil, unified_studio_settings: nil) ⇒ DomainSettingsProperty

Returns a new instance of DomainSettingsProperty.

Parameters:



1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
 
# File 'sagemaker/cfn_domain.rb', line 1304

def initialize(docker_settings: nil, execution_role_identity_config: nil, ip_address_type: nil, r_studio_server_pro_domain_settings: nil, security_group_ids: nil, unified_studio_settings: nil)
  @docker_settings = docker_settings.is_a?(Hash) ? ::AWSCDK::Sagemaker::CfnDomain::DockerSettingsProperty.new(**docker_settings.transform_keys(&:to_sym)) : docker_settings
  Jsii::Type.check_type(@docker_settings, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zYWdlbWFrZXIuQ2ZuRG9tYWluLkRvY2tlclNldHRpbmdzUHJvcGVydHkifV19fQ==")), "dockerSettings") unless @docker_settings.nil?
  @execution_role_identity_config = execution_role_identity_config
  Jsii::Type.check_type(@execution_role_identity_config, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "executionRoleIdentityConfig") unless @execution_role_identity_config.nil?
  @ip_address_type = ip_address_type
  Jsii::Type.check_type(@ip_address_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "ipAddressType") unless @ip_address_type.nil?
  @r_studio_server_pro_domain_settings = r_studio_server_pro_domain_settings.is_a?(Hash) ? ::AWSCDK::Sagemaker::CfnDomain::RStudioServerProDomainSettingsProperty.new(**r_studio_server_pro_domain_settings.transform_keys(&:to_sym)) : r_studio_server_pro_domain_settings
  Jsii::Type.check_type(@r_studio_server_pro_domain_settings, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zYWdlbWFrZXIuQ2ZuRG9tYWluLlJTdHVkaW9TZXJ2ZXJQcm9Eb21haW5TZXR0aW5nc1Byb3BlcnR5In1dfX0=")), "rStudioServerProDomainSettings") unless @r_studio_server_pro_domain_settings.nil?
  @security_group_ids = security_group_ids
  Jsii::Type.check_type(@security_group_ids, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "securityGroupIds") unless @security_group_ids.nil?
  @unified_studio_settings = unified_studio_settings.is_a?(Hash) ? ::AWSCDK::Sagemaker::CfnDomain::UnifiedStudioSettingsProperty.new(**unified_studio_settings.transform_keys(&:to_sym)) : unified_studio_settings
  Jsii::Type.check_type(@unified_studio_settings, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zYWdlbWFrZXIuQ2ZuRG9tYWluLlVuaWZpZWRTdHVkaW9TZXR0aW5nc1Byb3BlcnR5In1dfX0=")), "unifiedStudioSettings") unless @unified_studio_settings.nil?
end

Instance Attribute Details

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

A collection of settings that configure the domain's Docker interaction.

Returns:

See Also:



1323
1324
1325
 
# File 'sagemaker/cfn_domain.rb', line 1323

def docker_settings
  @docker_settings
end

#execution_role_identity_config ⇒ String? (readonly)

The configuration for attaching a SageMaker AI user profile name to the execution role as a sts:SourceIdentity key .

Returns:

  • (String, nil)

See Also:



1328
1329
1330
 
# File 'sagemaker/cfn_domain.rb', line 1328

def execution_role_identity_config
  @execution_role_identity_config
end

#ip_address_type ⇒ String? (readonly)

The IP address type for the domain.

Specify ipv4 for IPv4-only connectivity or dualstack for both IPv4 and IPv6 connectivity. When you specify dualstack , the subnet must support IPv6 CIDR blocks. If not specified, defaults to ipv4 .

Returns:

  • (String, nil)

See Also:



1335
1336
1337
 
# File 'sagemaker/cfn_domain.rb', line 1335

def ip_address_type
  @ip_address_type
end

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

A collection of settings that configure the RStudioServerPro Domain-level app.

Returns:

See Also:



1340
1341
1342
 
# File 'sagemaker/cfn_domain.rb', line 1340

def r_studio_server_pro_domain_settings
  @r_studio_server_pro_domain_settings
end

#security_group_ids ⇒ Array<String>? (readonly)

The security groups for the Amazon Virtual Private Cloud that the Domain uses for communication between Domain-level apps and user apps.

Returns:

  • (Array<String>, nil)

See Also:



1345
1346
1347
 
# File 'sagemaker/cfn_domain.rb', line 1345

def security_group_ids
  @security_group_ids
end

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

The settings that apply to an SageMaker AI domain when you use it in Amazon SageMaker Unified Studio.

Returns:

See Also:



1350
1351
1352
 
# File 'sagemaker/cfn_domain.rb', line 1350

def unified_studio_settings
  @unified_studio_settings
end

Class Method Details

.jsii_properties ⇒ Object 



1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
 
# File 'sagemaker/cfn_domain.rb', line 1352

def self.jsii_properties
  {
    :docker_settings => "dockerSettings",
    :execution_role_identity_config => "executionRoleIdentityConfig",
    :ip_address_type => "ipAddressType",
    :r_studio_server_pro_domain_settings => "rStudioServerProDomainSettings",
    :security_group_ids => "securityGroupIds",
    :unified_studio_settings => "unifiedStudioSettings",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
 
# File 'sagemaker/cfn_domain.rb', line 1363

def to_jsii
  result = {}
  result.merge!({
    "dockerSettings" => @docker_settings,
    "executionRoleIdentityConfig" => @execution_role_identity_config,
    "ipAddressType" => @ip_address_type,
    "rStudioServerProDomainSettings" => @r_studio_server_pro_domain_settings,
    "securityGroupIds" => @security_group_ids,
    "unifiedStudioSettings" => @unified_studio_settings,
  })
  result.compact
end