Class: AWSCDK::Sagemaker::CfnNotebookInstance

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, ITaggable, Interfaces::AWSSagemaker::INotebookInstanceRef
Defined in:
sagemaker/cfn_notebook_instance.rb

Overview

The AWS::SageMaker::NotebookInstance resource creates an Amazon SageMaker notebook instance.

A notebook instance is a machine learning (ML) compute instance running on a Jupyter notebook. For more information, see Use Notebook Instances .

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnNotebookInstance

Create a new AWS::SageMaker::NotebookInstance.

Parameters:

  • scope (Constructs::Construct) —

    Scope in which this resource is defined.

  • id (String) —

    Construct identifier for this resource (unique in its scope).

  • props (AWSCDK::Sagemaker::CfnNotebookInstanceProps) —

    Resource properties.



20
21
22
23
24
25
26
 
# File 'sagemaker/cfn_notebook_instance.rb', line 20

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::Sagemaker::CfnNotebookInstanceProps.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc2FnZW1ha2VyLkNmbk5vdGVib29rSW5zdGFuY2VQcm9wcyJ9")), "props")
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.arn_for_notebook_instance(resource) ⇒ String

Parameters:

Returns:

  • (String) 


90
91
92
93
 
# File 'sagemaker/cfn_notebook_instance.rb', line 90

def self.arn_for_notebook_instance(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19zYWdlbWFrZXIuSU5vdGVib29rSW5zdGFuY2VSZWYifQ==")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_sagemaker.CfnNotebookInstance", "arnForNotebookInstance", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


197
198
199
 
# File 'sagemaker/cfn_notebook_instance.rb', line 197

def self.CFN_RESOURCE_TYPE_NAME()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_sagemaker.CfnNotebookInstance", "CFN_RESOURCE_TYPE_NAME")
end

.is_cfn_notebook_instance(x) ⇒ Boolean

Checks whether the given object is a CfnNotebookInstance.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


99
100
101
102
 
# File 'sagemaker/cfn_notebook_instance.rb', line 99

def self.is_cfn_notebook_instance(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_sagemaker.CfnNotebookInstance", "isCfnNotebookInstance", [x])
end

.jsii_overridable_methods ⇒ Object 



28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'sagemaker/cfn_notebook_instance.rb', line 28

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :creation_stack => { kind: :property, name: "creationStack", is_optional: false },
    :logical_id => { kind: :property, name: "logicalId", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :ref => { kind: :property, name: "ref", is_optional: false },
    :cfn_options => { kind: :property, name: "cfnOptions", is_optional: false },
    :cfn_properties => { kind: :property, name: "cfnProperties", is_optional: false },
    :cfn_property_names => { kind: :property, name: "cfnPropertyNames", is_optional: false },
    :cfn_resource_type => { kind: :property, name: "cfnResourceType", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :updated_properites => { kind: :property, name: "updatedProperites", is_optional: false },
    :updated_properties => { kind: :property, name: "updatedProperties", is_optional: false },
    :attr_id => { kind: :property, name: "attrId", is_optional: false },
    :attr_notebook_instance_name => { kind: :property, name: "attrNotebookInstanceName", is_optional: false },
    :notebook_instance_ref => { kind: :property, name: "notebookInstanceRef", is_optional: false },
    :tags => { kind: :property, name: "tags", is_optional: false },
    :instance_type => { kind: :property, name: "instanceType", is_optional: false },
    :role_arn => { kind: :property, name: "roleArn", is_optional: false },
    :accelerator_types => { kind: :property, name: "acceleratorTypes", is_optional: true },
    :additional_code_repositories => { kind: :property, name: "additionalCodeRepositories", is_optional: true },
    :default_code_repository => { kind: :property, name: "defaultCodeRepository", is_optional: true },
    :direct_internet_access => { kind: :property, name: "directInternetAccess", is_optional: true },
    :instance_metadata_service_configuration => { kind: :property, name: "instanceMetadataServiceConfiguration", is_optional: true },
    :kms_key_id => { kind: :property, name: "kmsKeyId", is_optional: true },
    :lifecycle_config_name => { kind: :property, name: "lifecycleConfigName", is_optional: true },
    :notebook_instance_name => { kind: :property, name: "notebookInstanceName", is_optional: true },
    :platform_identifier => { kind: :property, name: "platformIdentifier", is_optional: true },
    :root_access => { kind: :property, name: "rootAccess", is_optional: true },
    :security_group_ids => { kind: :property, name: "securityGroupIds", is_optional: true },
    :subnet_id => { kind: :property, name: "subnetId", is_optional: true },
    :tags_raw => { kind: :property, name: "tagsRaw", is_optional: true },
    :volume_size_in_gb => { kind: :property, name: "volumeSizeInGb", is_optional: true },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :override_logical_id => { kind: :method, name: "overrideLogicalId", is_optional: false },
    :add_deletion_override => { kind: :method, name: "addDeletionOverride", is_optional: false },
    :add_dependency => { kind: :method, name: "addDependency", is_optional: false },
    :add_depends_on => { kind: :method, name: "addDependsOn", is_optional: false },
    :add_metadata => { kind: :method, name: "addMetadata", is_optional: false },
    :add_override => { kind: :method, name: "addOverride", is_optional: false },
    :add_property_deletion_override => { kind: :method, name: "addPropertyDeletionOverride", is_optional: false },
    :add_property_override => { kind: :method, name: "addPropertyOverride", is_optional: false },
    :apply_cross_stack_reference_strength => { kind: :method, name: "applyCrossStackReferenceStrength", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
    :cfn_property_name => { kind: :method, name: "cfnPropertyName", is_optional: false },
    :get_att => { kind: :method, name: "getAtt", is_optional: false },
    :get_metadata => { kind: :method, name: "getMetadata", is_optional: false },
    :obtain_dependencies => { kind: :method, name: "obtainDependencies", is_optional: false },
    :obtain_resource_dependencies => { kind: :method, name: "obtainResourceDependencies", is_optional: false },
    :remove_dependency => { kind: :method, name: "removeDependency", is_optional: false },
    :render_properties => { kind: :method, name: "renderProperties", is_optional: false },
    :replace_dependency => { kind: :method, name: "replaceDependency", is_optional: false },
    :should_synthesize => { kind: :method, name: "shouldSynthesize", is_optional: false },
    :validate_properties => { kind: :method, name: "validateProperties", is_optional: false },
    :inspect => { kind: :method, name: "inspect", is_optional: false },
  }
end

Instance Method Details

#accelerator_types ⇒ Array<String>?

A list of Amazon Elastic Inference (EI) instance types to associate with the notebook instance.

Returns:

  • (Array<String>, nil) 


254
255
256
 
# File 'sagemaker/cfn_notebook_instance.rb', line 254

def accelerator_types()
  jsii_get_property("acceleratorTypes")
end

#accelerator_types=(value) ⇒ Object 



258
259
260
261
 
# File 'sagemaker/cfn_notebook_instance.rb', line 258

def accelerator_types=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "acceleratorTypes") unless value.nil?
  jsii_set_property("acceleratorTypes", value)
end

#add_deletion_override(path) ⇒ void

This method returns an undefined value.

Syntactic sugar for addOverride(path, undefined).

Parameters:

  • path (String) —

    The path of the value to delete.



459
460
461
462
 
# File 'sagemaker/cfn_notebook_instance.rb', line 459

def add_deletion_override(path)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  jsii_call_method("addDeletionOverride", [path])
end

#add_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:



471
472
473
474
 
# File 'sagemaker/cfn_notebook_instance.rb', line 471

def add_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependency", [target])
end

#add_depends_on(target) ⇒ void

Deprecated.

use addDependency

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:



481
482
483
484
 
# File 'sagemaker/cfn_notebook_instance.rb', line 481

def add_depends_on(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependsOn", [target])
end

#add_metadata(key, value) ⇒ void

This method returns an undefined value.

Add a value to the CloudFormation Resource Metadata.

Parameters:

  • key (String)
  • value (Object)

See Also:



492
493
494
495
496
 
# File 'sagemaker/cfn_notebook_instance.rb', line 492

def add_metadata(key, value)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addMetadata", [key, value])
end

#add_override(path, value) ⇒ void

This method returns an undefined value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use add_property_override or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

# Example automatically generated from non-compiling source. May contain errors.
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to add_override will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

  • path (String) —
    • The path of the property, you can use dot notation to override values in complex types.
  • value (Object) —
    • The value.


549
550
551
552
553
 
# File 'sagemaker/cfn_notebook_instance.rb', line 549

def add_override(path, value)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addOverride", [path, value])
end

#add_property_deletion_override(property_path) ⇒ void

This method returns an undefined value.

Adds an override that deletes the value of a property from the resource definition.

Parameters:

  • property_path (String) —

    The path to the property.



559
560
561
562
 
# File 'sagemaker/cfn_notebook_instance.rb', line 559

def add_property_deletion_override(property_path)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  jsii_call_method("addPropertyDeletionOverride", [property_path])
end

#add_property_override(property_path, value) ⇒ void

This method returns an undefined value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

  • property_path (String) —

    The path of the property.

  • value (Object) —

    The value.



571
572
573
574
575
 
# File 'sagemaker/cfn_notebook_instance.rb', line 571

def add_property_override(property_path, value)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addPropertyOverride", [property_path, value])
end

#additional_code_repositories ⇒ Array<String>?

An array of up to three Git repositories associated with the notebook instance.

Returns:

  • (Array<String>, nil) 


266
267
268
 
# File 'sagemaker/cfn_notebook_instance.rb', line 266

def additional_code_repositories()
  jsii_get_property("additionalCodeRepositories")
end

#additional_code_repositories=(value) ⇒ Object 



270
271
272
273
 
# File 'sagemaker/cfn_notebook_instance.rb', line 270

def additional_code_repositories=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "additionalCodeRepositories") unless value.nil?
  jsii_set_property("additionalCodeRepositories", value)
end

#apply_cross_stack_reference_strength(strength) ⇒ void

This method returns an undefined value.

Sets the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack's context.

Parameters:



584
585
586
587
 
# File 'sagemaker/cfn_notebook_instance.rb', line 584

def apply_cross_stack_reference_strength(strength)
  Jsii::Type.check_type(strength, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZWZlcmVuY2VTdHJlbmd0aCJ9")), "strength")
  jsii_call_method("applyCrossStackReferenceStrength", [strength])
end

#apply_removal_policy(policy = nil, options = nil) ⇒ void

This method returns an undefined value.

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

See Also:



606
607
608
609
610
611
 
# File 'sagemaker/cfn_notebook_instance.rb', line 606

def apply_removal_policy(policy = nil, options = nil)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy") unless policy.nil?
  options = options.is_a?(Hash) ? ::AWSCDK::RemovalPolicyOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5T3B0aW9ucyJ9")), "options") unless options.nil?
  jsii_call_method("applyRemovalPolicy", [policy, options])
end

#attr_id ⇒ String

Returns:

  • (String) 


202
203
204
 
# File 'sagemaker/cfn_notebook_instance.rb', line 202

def attr_id()
  jsii_get_property("attrId")
end

#attr_notebook_instance_name ⇒ String

The name of the notebook instance, such as MyNotebookInstance .

Returns:

  • (String) 


209
210
211
 
# File 'sagemaker/cfn_notebook_instance.rb', line 209

def attr_notebook_instance_name()
  jsii_get_property("attrNotebookInstanceName")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

Returns:



150
151
152
 
# File 'sagemaker/cfn_notebook_instance.rb', line 150

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


155
156
157
 
# File 'sagemaker/cfn_notebook_instance.rb', line 155

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


615
616
617
618
 
# File 'sagemaker/cfn_notebook_instance.rb', line 615

def cfn_property_name(cdk_property_name)
  Jsii::Type.check_type(cdk_property_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "cdkPropertyName")
  jsii_call_method("cfnPropertyName", [cdk_property_name])
end

#cfn_property_names ⇒ Hash{String => String}

Returns:

  • (Hash{String => String}) 


160
161
162
 
# File 'sagemaker/cfn_notebook_instance.rb', line 160

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


167
168
169
 
# File 'sagemaker/cfn_notebook_instance.rb', line 167

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


112
113
114
 
# File 'sagemaker/cfn_notebook_instance.rb', line 112

def creation_stack()
  jsii_get_property("creationStack")
end

#default_code_repository ⇒ String?

The Git repository associated with the notebook instance as its default code repository.

Returns:

  • (String, nil) 


278
279
280
 
# File 'sagemaker/cfn_notebook_instance.rb', line 278

def default_code_repository()
  jsii_get_property("defaultCodeRepository")
end

#default_code_repository=(value) ⇒ Object 



282
283
284
285
 
# File 'sagemaker/cfn_notebook_instance.rb', line 282

def default_code_repository=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "defaultCodeRepository") unless value.nil?
  jsii_set_property("defaultCodeRepository", value)
end

#direct_internet_access ⇒ String?

Sets whether SageMaker AI provides internet access to the notebook instance.

Returns:

  • (String, nil) 


290
291
292
 
# File 'sagemaker/cfn_notebook_instance.rb', line 290

def direct_internet_access()
  jsii_get_property("directInternetAccess")
end

#direct_internet_access=(value) ⇒ Object 



294
295
296
297
 
# File 'sagemaker/cfn_notebook_instance.rb', line 294

def direct_internet_access=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "directInternetAccess") unless value.nil?
  jsii_set_property("directInternetAccess", value)
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



172
173
174
 
# File 'sagemaker/cfn_notebook_instance.rb', line 172

def env()
  jsii_get_property("env")
end

#get_att(attribute_name, type_hint = nil) ⇒ AWSCDK::Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

Returns:



628
629
630
631
632
 
# File 'sagemaker/cfn_notebook_instance.rb', line 628

def get_att(attribute_name, type_hint = nil)
  Jsii::Type.check_type(attribute_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "attributeName")
  Jsii::Type.check_type(type_hint, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZXNvbHV0aW9uVHlwZUhpbnQifQ==")), "typeHint") unless type_hint.nil?
  jsii_call_method("getAtt", [attribute_name, type_hint])
end

#get_metadata(key) ⇒ Object

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

  • key (String)

Returns:

  • (Object)

See Also:



639
640
641
642
 
# File 'sagemaker/cfn_notebook_instance.rb', line 639

def get_metadata(key)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  jsii_call_method("getMetadata", [key])
end

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



709
710
711
712
 
# File 'sagemaker/cfn_notebook_instance.rb', line 709

def inspect(inspector)
  Jsii::Type.check_type(inspector, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5UcmVlSW5zcGVjdG9yIn0=")), "inspector")
  jsii_call_method("inspect", [inspector])
end

#instance_metadata_service_configuration ⇒ AWSCDK::IResolvable, ...

Information on the IMDS configuration of the notebook instance.

Returns:



302
303
304
 
# File 'sagemaker/cfn_notebook_instance.rb', line 302

def instance_metadata_service_configuration()
  jsii_get_property("instanceMetadataServiceConfiguration")
end

#instance_metadata_service_configuration=(value) ⇒ Object 



306
307
308
309
310
 
# File 'sagemaker/cfn_notebook_instance.rb', line 306

def instance_metadata_service_configuration=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Sagemaker::CfnNotebookInstance::InstanceMetadataServiceConfigurationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zYWdlbWFrZXIuQ2ZuTm90ZWJvb2tJbnN0YW5jZS5JbnN0YW5jZU1ldGFkYXRhU2VydmljZUNvbmZpZ3VyYXRpb25Qcm9wZXJ0eSJ9XX19")), "instanceMetadataServiceConfiguration") unless value.nil?
  jsii_set_property("instanceMetadataServiceConfiguration", value)
end

#instance_type ⇒ String

The type of ML compute instance to launch for the notebook instance.

Returns:

  • (String) 


230
231
232
 
# File 'sagemaker/cfn_notebook_instance.rb', line 230

def instance_type()
  jsii_get_property("instanceType")
end

#instance_type=(value) ⇒ Object 



234
235
236
237
 
# File 'sagemaker/cfn_notebook_instance.rb', line 234

def instance_type=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "instanceType")
  jsii_set_property("instanceType", value)
end

#kms_key_id ⇒ String?

The Amazon Resource Name (ARN) of a AWS Key Management Service key that SageMaker AI uses to encrypt data on the storage volume attached to your notebook instance.

Returns:

  • (String, nil) 


315
316
317
 
# File 'sagemaker/cfn_notebook_instance.rb', line 315

def kms_key_id()
  jsii_get_property("kmsKeyId")
end

#kms_key_id=(value) ⇒ Object 



319
320
321
322
 
# File 'sagemaker/cfn_notebook_instance.rb', line 319

def kms_key_id=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "kmsKeyId") unless value.nil?
  jsii_set_property("kmsKeyId", value)
end

#lifecycle_config_name ⇒ String?

The name of a lifecycle configuration to associate with the notebook instance.

Returns:

  • (String, nil) 


327
328
329
 
# File 'sagemaker/cfn_notebook_instance.rb', line 327

def lifecycle_config_name()
  jsii_get_property("lifecycleConfigName")
end

#lifecycle_config_name=(value) ⇒ Object 



331
332
333
334
 
# File 'sagemaker/cfn_notebook_instance.rb', line 331

def lifecycle_config_name=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "lifecycleConfigName") unless value.nil?
  jsii_set_property("lifecycleConfigName", value)
end

#logical_id ⇒ String

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use override_logical_id(new_logical_id).

Returns:

  • (String) 


124
125
126
 
# File 'sagemaker/cfn_notebook_instance.rb', line 124

def logical_id()
  jsii_get_property("logicalId")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


107
108
109
 
# File 'sagemaker/cfn_notebook_instance.rb', line 107

def node()
  jsii_get_property("node")
end

#notebook_instance_name ⇒ String?

The name of the new notebook instance.

Returns:

  • (String, nil) 


339
340
341
 
# File 'sagemaker/cfn_notebook_instance.rb', line 339

def notebook_instance_name()
  jsii_get_property("notebookInstanceName")
end

#notebook_instance_name=(value) ⇒ Object 



343
344
345
346
 
# File 'sagemaker/cfn_notebook_instance.rb', line 343

def notebook_instance_name=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "notebookInstanceName") unless value.nil?
  jsii_set_property("notebookInstanceName", value)
end

#notebook_instance_ref ⇒ AWSCDK::Interfaces::AWSSagemaker::NotebookInstanceReference

A reference to a NotebookInstance resource.

Returns:



216
217
218
 
# File 'sagemaker/cfn_notebook_instance.rb', line 216

def notebook_instance_ref()
  jsii_get_property("notebookInstanceRef")
end

#obtain_dependencies ⇒ Array<AWSCDK::CfnResource, AWSCDK::Stack>

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Returns:



650
651
652
 
# File 'sagemaker/cfn_notebook_instance.rb', line 650

def obtain_dependencies()
  jsii_call_method("obtainDependencies", [])
end

#obtain_resource_dependencies ⇒ Array<AWSCDK::CfnResource>

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Returns:



657
658
659
 
# File 'sagemaker/cfn_notebook_instance.rb', line 657

def obtain_resource_dependencies()
  jsii_call_method("obtainResourceDependencies", [])
end

#override_logical_id(new_logical_id) ⇒ void

This method returns an undefined value.

Overrides the auto-generated logical ID with a specific ID.

Parameters:

  • new_logical_id (String) —

    The new logical ID to use for this stack element.



450
451
452
453
 
# File 'sagemaker/cfn_notebook_instance.rb', line 450

def override_logical_id(new_logical_id)
  Jsii::Type.check_type(new_logical_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "newLogicalId")
  jsii_call_method("overrideLogicalId", [new_logical_id])
end

#platform_identifier ⇒ String?

The platform identifier of the notebook instance runtime environment.

Returns:

  • (String, nil) 


351
352
353
 
# File 'sagemaker/cfn_notebook_instance.rb', line 351

def platform_identifier()
  jsii_get_property("platformIdentifier")
end

#platform_identifier=(value) ⇒ Object 



355
356
357
358
 
# File 'sagemaker/cfn_notebook_instance.rb', line 355

def platform_identifier=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "platformIdentifier") unless value.nil?
  jsii_set_property("platformIdentifier", value)
end

#ref ⇒ String

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

Returns:

  • (String) 


143
144
145
 
# File 'sagemaker/cfn_notebook_instance.rb', line 143

def ref()
  jsii_get_property("ref")
end

#remove_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:



668
669
670
671
 
# File 'sagemaker/cfn_notebook_instance.rb', line 668

def remove_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("removeDependency", [target])
end

#render_properties(props) ⇒ Hash{String => Object}

Parameters:

  • props (Hash{String => Object})

Returns:

  • (Hash{String => Object}) 


675
676
677
678
 
# File 'sagemaker/cfn_notebook_instance.rb', line 675

def render_properties(props)
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6ImFueSJ9LCJraW5kIjoibWFwIn19")), "props")
  jsii_call_method("renderProperties", [props])
end

#replace_dependency(target, new_target) ⇒ void

This method returns an undefined value.

Replaces one dependency with another.

Parameters:



685
686
687
688
689
 
# File 'sagemaker/cfn_notebook_instance.rb', line 685

def replace_dependency(target, new_target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  Jsii::Type.check_type(new_target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "newTarget")
  jsii_call_method("replaceDependency", [target, new_target])
end

#role_arn ⇒ String

When you send any requests to AWS resources from the notebook instance, SageMaker AI assumes this role to perform tasks on your behalf.

Returns:

  • (String) 


242
243
244
 
# File 'sagemaker/cfn_notebook_instance.rb', line 242

def role_arn()
  jsii_get_property("roleArn")
end

#role_arn=(value) ⇒ Object 



246
247
248
249
 
# File 'sagemaker/cfn_notebook_instance.rb', line 246

def role_arn=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "roleArn")
  jsii_set_property("roleArn", value)
end

#root_access ⇒ String?

Whether root access is enabled or disabled for users of the notebook instance.

The default value is Enabled .

Returns:

  • (String, nil) 


365
366
367
 
# File 'sagemaker/cfn_notebook_instance.rb', line 365

def root_access()
  jsii_get_property("rootAccess")
end

#root_access=(value) ⇒ Object 



369
370
371
372
 
# File 'sagemaker/cfn_notebook_instance.rb', line 369

def root_access=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "rootAccess") unless value.nil?
  jsii_set_property("rootAccess", value)
end

#security_group_ids ⇒ Array<String>?

The VPC security group IDs, in the form sg-xxxxxxxx.

Returns:

  • (Array<String>, nil) 


377
378
379
 
# File 'sagemaker/cfn_notebook_instance.rb', line 377

def security_group_ids()
  jsii_get_property("securityGroupIds")
end

#security_group_ids=(value) ⇒ Object 



381
382
383
384
 
# File 'sagemaker/cfn_notebook_instance.rb', line 381

def security_group_ids=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "securityGroupIds") unless value.nil?
  jsii_set_property("securityGroupIds", value)
end

#should_synthesize ⇒ Boolean

Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.

Returns:

  • (Boolean) —

    true if the resource should be included or false is the resource should be omitted.



694
695
696
 
# File 'sagemaker/cfn_notebook_instance.rb', line 694

def should_synthesize()
  jsii_call_method("shouldSynthesize", [])
end

#stack ⇒ AWSCDK::Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Returns:



133
134
135
 
# File 'sagemaker/cfn_notebook_instance.rb', line 133

def stack()
  jsii_get_property("stack")
end

#subnet_id ⇒ String?

The ID of the subnet in a VPC to which you would like to have a connectivity from your ML compute instance.

Returns:

  • (String, nil) 


389
390
391
 
# File 'sagemaker/cfn_notebook_instance.rb', line 389

def subnet_id()
  jsii_get_property("subnetId")
end

#subnet_id=(value) ⇒ Object 



393
394
395
396
 
# File 'sagemaker/cfn_notebook_instance.rb', line 393

def subnet_id=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "subnetId") unless value.nil?
  jsii_set_property("subnetId", value)
end

#tags ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



223
224
225
 
# File 'sagemaker/cfn_notebook_instance.rb', line 223

def tags()
  jsii_get_property("tags")
end

#tags_raw ⇒ Array<AWSCDK::CfnTag>?

A list of key-value pairs to apply to this resource.

Returns:



401
402
403
 
# File 'sagemaker/cfn_notebook_instance.rb', line 401

def tags_raw()
  jsii_get_property("tagsRaw")
end

#tags_raw=(value) ⇒ Object 



405
406
407
408
409
 
# File 'sagemaker/cfn_notebook_instance.rb', line 405

def tags_raw=(value)
  value = value.is_a?(Array) ? value.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tagsRaw") unless value.nil?
  jsii_set_property("tagsRaw", value)
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



426
427
428
 
# File 'sagemaker/cfn_notebook_instance.rb', line 426

def to_string()
  jsii_call_method("toString", [])
end

#updated_properites ⇒ Hash{String => Object}

Deprecated.

use updatedProperties Return properties modified after initiation Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Deprecated.

Returns:

  • (Hash{String => Object}) 


180
181
182
 
# File 'sagemaker/cfn_notebook_instance.rb', line 180

def updated_properites()
  jsii_get_property("updatedProperites")
end

#updated_properties ⇒ Hash{String => Object}

Return properties modified after initiation.

Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Returns:

  • (Hash{String => Object}) 


190
191
192
 
# File 'sagemaker/cfn_notebook_instance.rb', line 190

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


700
701
702
703
 
# File 'sagemaker/cfn_notebook_instance.rb', line 700

def validate_properties(_properties)
  Jsii::Type.check_type(_properties, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "_properties")
  jsii_call_method("validateProperties", [_properties])
end

#volume_size_in_gb ⇒ Numeric?

The size, in GB, of the ML storage volume to attach to the notebook instance.

Returns:

  • (Numeric, nil) 


414
415
416
 
# File 'sagemaker/cfn_notebook_instance.rb', line 414

def volume_size_in_gb()
  jsii_get_property("volumeSizeInGb")
end

#volume_size_in_gb=(value) ⇒ Object 



418
419
420
421
 
# File 'sagemaker/cfn_notebook_instance.rb', line 418

def volume_size_in_gb=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "volumeSizeInGb") unless value.nil?
  jsii_set_property("volumeSizeInGb", value)
end

#with(*mixins) ⇒ Constructs::IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

Parameters:

  • mixins (Array<Constructs::IMixin>)

Returns:

  • (Constructs::IConstruct) 


439
440
441
442
443
444
 
# File 'sagemaker/cfn_notebook_instance.rb', line 439

def with(*mixins)
  mixins.each_with_index do |item, index|
    Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLklNaXhpbiJ9")), "mixins[#{index}]")
  end
  jsii_call_method("with", [*mixins])
end