Class: AWSCDK::Sagemaker::CfnDomain::JupyterLabAppSettingsProperty

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

Overview

The settings for the JupyterLab application.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(app_lifecycle_management: nil, built_in_lifecycle_config_arn: nil, code_repositories: nil, custom_images: nil, default_resource_spec: nil, lifecycle_config_arns: nil) ⇒ JupyterLabAppSettingsProperty

Returns a new instance of JupyterLabAppSettingsProperty.

Parameters:



1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
 
# File 'sagemaker/cfn_domain.rb', line 1587

def initialize(app_lifecycle_management: nil, built_in_lifecycle_config_arn: nil, code_repositories: nil, custom_images: nil, default_resource_spec: nil, lifecycle_config_arns: nil)
  @app_lifecycle_management = app_lifecycle_management.is_a?(Hash) ? ::AWSCDK::Sagemaker::CfnDomain::AppLifecycleManagementProperty.new(**app_lifecycle_management.transform_keys(&:to_sym)) : app_lifecycle_management
  Jsii::Type.check_type(@app_lifecycle_management, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zYWdlbWFrZXIuQ2ZuRG9tYWluLkFwcExpZmVjeWNsZU1hbmFnZW1lbnRQcm9wZXJ0eSJ9XX19")), "appLifecycleManagement") unless @app_lifecycle_management.nil?
  @built_in_lifecycle_config_arn = built_in_lifecycle_config_arn
  Jsii::Type.check_type(@built_in_lifecycle_config_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "builtInLifecycleConfigArn") unless @built_in_lifecycle_config_arn.nil?
  @code_repositories = code_repositories
  Jsii::Type.check_type(@code_repositories, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc2FnZW1ha2VyLkNmbkRvbWFpbi5Db2RlUmVwb3NpdG9yeVByb3BlcnR5In1dfX0sImtpbmQiOiJhcnJheSJ9fV19fQ==")), "codeRepositories") unless @code_repositories.nil?
  @custom_images = custom_images
  Jsii::Type.check_type(@custom_images, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc2FnZW1ha2VyLkNmbkRvbWFpbi5DdXN0b21JbWFnZVByb3BlcnR5In1dfX0sImtpbmQiOiJhcnJheSJ9fV19fQ==")), "customImages") unless @custom_images.nil?
  @default_resource_spec = default_resource_spec.is_a?(Hash) ? ::AWSCDK::Sagemaker::CfnDomain::ResourceSpecProperty.new(**default_resource_spec.transform_keys(&:to_sym)) : default_resource_spec
  Jsii::Type.check_type(@default_resource_spec, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zYWdlbWFrZXIuQ2ZuRG9tYWluLlJlc291cmNlU3BlY1Byb3BlcnR5In1dfX0=")), "defaultResourceSpec") unless @default_resource_spec.nil?
  @lifecycle_config_arns = lifecycle_config_arns
  Jsii::Type.check_type(@lifecycle_config_arns, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "lifecycleConfigArns") unless @lifecycle_config_arns.nil?
end

Instance Attribute Details

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

Indicates whether idle shutdown is activated for JupyterLab applications.

Returns:

See Also:



1606
1607
1608
 
# File 'sagemaker/cfn_domain.rb', line 1606

def app_lifecycle_management
  @app_lifecycle_management
end

#built_in_lifecycle_config_arn ⇒ String? (readonly)

The lifecycle configuration that runs before the default lifecycle configuration.

It can override changes made in the default lifecycle configuration.

Returns:

  • (String, nil)

See Also:



1613
1614
1615
 
# File 'sagemaker/cfn_domain.rb', line 1613

def built_in_lifecycle_config_arn
  @built_in_lifecycle_config_arn
end

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

A list of Git repositories that SageMaker automatically displays to users for cloning in the JupyterLab application.

Returns:

See Also:



1618
1619
1620
 
# File 'sagemaker/cfn_domain.rb', line 1618

def code_repositories
  @code_repositories
end

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

A list of custom SageMaker images that are configured to run as a JupyterLab app.

Returns:

See Also:



1623
1624
1625
 
# File 'sagemaker/cfn_domain.rb', line 1623

def custom_images
  @custom_images
end

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

The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the JupyterLab app.

Returns:

See Also:



1628
1629
1630
 
# File 'sagemaker/cfn_domain.rb', line 1628

def default_resource_spec
  @default_resource_spec
end

#lifecycle_config_arns ⇒ Array<String>? (readonly)

The Amazon Resource Name (ARN) of the lifecycle configurations attached to the user profile or domain.

To remove a lifecycle config, you must set LifecycleConfigArns to an empty list.

Returns:

  • (Array<String>, nil)

See Also:



1635
1636
1637
 
# File 'sagemaker/cfn_domain.rb', line 1635

def lifecycle_config_arns
  @lifecycle_config_arns
end

Class Method Details

.jsii_properties ⇒ Object 



1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
 
# File 'sagemaker/cfn_domain.rb', line 1637

def self.jsii_properties
  {
    :app_lifecycle_management => "appLifecycleManagement",
    :built_in_lifecycle_config_arn => "builtInLifecycleConfigArn",
    :code_repositories => "codeRepositories",
    :custom_images => "customImages",
    :default_resource_spec => "defaultResourceSpec",
    :lifecycle_config_arns => "lifecycleConfigArns",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
 
# File 'sagemaker/cfn_domain.rb', line 1648

def to_jsii
  result = {}
  result.merge!({
    "appLifecycleManagement" => @app_lifecycle_management,
    "builtInLifecycleConfigArn" => @built_in_lifecycle_config_arn,
    "codeRepositories" => @code_repositories,
    "customImages" => @custom_images,
    "defaultResourceSpec" => @default_resource_spec,
    "lifecycleConfigArns" => @lifecycle_config_arns,
  })
  result.compact
end