Class: AWSCDK::Sagemaker::CfnCluster

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, ITaggableV2, Interfaces::AWSSagemaker::IClusterRef
Defined in:
sagemaker/cfn_cluster.rb

Overview

Creates an Amazon SageMaker HyperPod cluster.

SageMaker HyperPod is a capability of SageMaker for creating and managing persistent clusters for developing large machine learning models, such as large language models (LLMs) and diffusion models. To learn more, see Amazon SageMaker HyperPod in the Amazon SageMaker Developer Guide .

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props = nil) ⇒ CfnCluster

Create a new AWS::SageMaker::Cluster.

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::CfnClusterProps, nil) (defaults to: nil) —

    Resource properties.



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

def initialize(scope, id, props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::Sagemaker::CfnClusterProps.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("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc2FnZW1ha2VyLkNmbkNsdXN0ZXJQcm9wcyJ9")), "props") unless props.nil?
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.arn_for_cluster(resource) ⇒ String

Parameters:

Returns:

  • (String) 


88
89
90
91
 
# File 'sagemaker/cfn_cluster.rb', line 88

def self.arn_for_cluster(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19zYWdlbWFrZXIuSUNsdXN0ZXJSZWYifQ==")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_sagemaker.CfnCluster", "arnForCluster", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


195
196
197
 
# File 'sagemaker/cfn_cluster.rb', line 195

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

.is_cfn_cluster(x) ⇒ Boolean

Checks whether the given object is a CfnCluster.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


97
98
99
100
 
# File 'sagemaker/cfn_cluster.rb', line 97

def self.is_cfn_cluster(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_sagemaker.CfnCluster", "isCfnCluster", [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
 
# File 'sagemaker/cfn_cluster.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_cluster_arn => { kind: :property, name: "attrClusterArn", is_optional: false },
    :attr_cluster_status => { kind: :property, name: "attrClusterStatus", is_optional: false },
    :attr_creation_time => { kind: :property, name: "attrCreationTime", is_optional: false },
    :attr_failure_message => { kind: :property, name: "attrFailureMessage", is_optional: false },
    :cdk_tag_manager => { kind: :property, name: "cdkTagManager", is_optional: false },
    :cluster_ref => { kind: :property, name: "clusterRef", is_optional: false },
    :auto_scaling => { kind: :property, name: "autoScaling", is_optional: true },
    :cluster_name => { kind: :property, name: "clusterName", is_optional: true },
    :cluster_role => { kind: :property, name: "clusterRole", is_optional: true },
    :instance_groups => { kind: :property, name: "instanceGroups", is_optional: true },
    :node_provisioning_mode => { kind: :property, name: "nodeProvisioningMode", is_optional: true },
    :node_recovery => { kind: :property, name: "nodeRecovery", is_optional: true },
    :orchestrator => { kind: :property, name: "orchestrator", is_optional: true },
    :restricted_instance_groups => { kind: :property, name: "restrictedInstanceGroups", is_optional: true },
    :restricted_instance_groups_config => { kind: :property, name: "restrictedInstanceGroupsConfig", is_optional: true },
    :tags => { kind: :property, name: "tags", is_optional: true },
    :tiered_storage_config => { kind: :property, name: "tieredStorageConfig", is_optional: true },
    :vpc_config => { kind: :property, name: "vpcConfig", 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

#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.



427
428
429
430
 
# File 'sagemaker/cfn_cluster.rb', line 427

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:



439
440
441
442
 
# File 'sagemaker/cfn_cluster.rb', line 439

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:



449
450
451
452
 
# File 'sagemaker/cfn_cluster.rb', line 449

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:



460
461
462
463
464
 
# File 'sagemaker/cfn_cluster.rb', line 460

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.


517
518
519
520
521
 
# File 'sagemaker/cfn_cluster.rb', line 517

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.



527
528
529
530
 
# File 'sagemaker/cfn_cluster.rb', line 527

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.



539
540
541
542
543
 
# File 'sagemaker/cfn_cluster.rb', line 539

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

#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:



552
553
554
555
 
# File 'sagemaker/cfn_cluster.rb', line 552

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:



574
575
576
577
578
579
 
# File 'sagemaker/cfn_cluster.rb', line 574

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_cluster_arn ⇒ String

The Amazon Resource Name (ARN) of the SageMaker HyperPod cluster.

Returns:

  • (String) 


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

def attr_cluster_arn()
  jsii_get_property("attrClusterArn")
end

#attr_cluster_status ⇒ String

The status of the SageMaker HyperPod cluster.

Returns:

  • (String) 


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

def attr_cluster_status()
  jsii_get_property("attrClusterStatus")
end

#attr_creation_time ⇒ String

The time when the SageMaker HyperPod cluster is created.

Returns:

  • (String) 


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

def attr_creation_time()
  jsii_get_property("attrCreationTime")
end

#attr_failure_message ⇒ String

The failure message of the SageMaker HyperPod cluster.

Returns:

  • (String) 


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

def attr_failure_message()
  jsii_get_property("attrFailureMessage")
end

#auto_scaling ⇒ AWSCDK::IResolvable, ...

Configuration for cluster auto-scaling.

Returns:



244
245
246
 
# File 'sagemaker/cfn_cluster.rb', line 244

def auto_scaling()
  jsii_get_property("autoScaling")
end

#auto_scaling=(value) ⇒ Object 



248
249
250
251
252
 
# File 'sagemaker/cfn_cluster.rb', line 248

def auto_scaling=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Sagemaker::CfnCluster::ClusterAutoScalingConfigProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zYWdlbWFrZXIuQ2ZuQ2x1c3Rlci5DbHVzdGVyQXV0b1NjYWxpbmdDb25maWdQcm9wZXJ0eSJ9XX19")), "autoScaling") unless value.nil?
  jsii_set_property("autoScaling", value)
end

#cdk_tag_manager ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



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

def cdk_tag_manager()
  jsii_get_property("cdkTagManager")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



148
149
150
 
# File 'sagemaker/cfn_cluster.rb', line 148

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


153
154
155
 
# File 'sagemaker/cfn_cluster.rb', line 153

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


583
584
585
586
 
# File 'sagemaker/cfn_cluster.rb', line 583

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}) 


158
159
160
 
# File 'sagemaker/cfn_cluster.rb', line 158

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


165
166
167
 
# File 'sagemaker/cfn_cluster.rb', line 165

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#cluster_name ⇒ String?

The name of the SageMaker HyperPod cluster.

Returns:

  • (String, nil) 


257
258
259
 
# File 'sagemaker/cfn_cluster.rb', line 257

def cluster_name()
  jsii_get_property("clusterName")
end

#cluster_name=(value) ⇒ Object 



261
262
263
264
 
# File 'sagemaker/cfn_cluster.rb', line 261

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

#cluster_ref ⇒ AWSCDK::Interfaces::AWSSagemaker::ClusterReference

A reference to a Cluster resource.

Returns:



237
238
239
 
# File 'sagemaker/cfn_cluster.rb', line 237

def cluster_ref()
  jsii_get_property("clusterRef")
end

#cluster_role ⇒ String?

The cluster role for the autoscaler to assume.

Returns:

  • (String, nil) 


269
270
271
 
# File 'sagemaker/cfn_cluster.rb', line 269

def cluster_role()
  jsii_get_property("clusterRole")
end

#cluster_role=(value) ⇒ Object 



273
274
275
276
 
# File 'sagemaker/cfn_cluster.rb', line 273

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

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


110
111
112
 
# File 'sagemaker/cfn_cluster.rb', line 110

def creation_stack()
  jsii_get_property("creationStack")
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



170
171
172
 
# File 'sagemaker/cfn_cluster.rb', line 170

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:



596
597
598
599
600
 
# File 'sagemaker/cfn_cluster.rb', line 596

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:



607
608
609
610
 
# File 'sagemaker/cfn_cluster.rb', line 607

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:



677
678
679
680
 
# File 'sagemaker/cfn_cluster.rb', line 677

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

#instance_groups ⇒ AWSCDK::IResolvable, ...

The instance groups of the SageMaker HyperPod cluster.

Returns:



281
282
283
 
# File 'sagemaker/cfn_cluster.rb', line 281

def instance_groups()
  jsii_get_property("instanceGroups")
end

#instance_groups=(value) ⇒ Object 



285
286
287
288
 
# File 'sagemaker/cfn_cluster.rb', line 285

def instance_groups=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc2FnZW1ha2VyLkNmbkNsdXN0ZXIuQ2x1c3Rlckluc3RhbmNlR3JvdXBQcm9wZXJ0eSJ9XX19LCJraW5kIjoiYXJyYXkifX1dfX0=")), "instanceGroups") unless value.nil?
  jsii_set_property("instanceGroups", 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) 


122
123
124
 
# File 'sagemaker/cfn_cluster.rb', line 122

def logical_id()
  jsii_get_property("logicalId")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


105
106
107
 
# File 'sagemaker/cfn_cluster.rb', line 105

def node()
  jsii_get_property("node")
end

#node_provisioning_mode ⇒ String?

Determines the scaling strategy for the SageMaker HyperPod cluster.

Returns:

  • (String, nil) 


293
294
295
 
# File 'sagemaker/cfn_cluster.rb', line 293

def node_provisioning_mode()
  jsii_get_property("nodeProvisioningMode")
end

#node_provisioning_mode=(value) ⇒ Object 



297
298
299
300
 
# File 'sagemaker/cfn_cluster.rb', line 297

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

#node_recovery ⇒ String?

Specifies whether to enable or disable the automatic node recovery feature of SageMaker HyperPod.

Returns:

  • (String, nil) 


305
306
307
 
# File 'sagemaker/cfn_cluster.rb', line 305

def node_recovery()
  jsii_get_property("nodeRecovery")
end

#node_recovery=(value) ⇒ Object 



309
310
311
312
 
# File 'sagemaker/cfn_cluster.rb', line 309

def node_recovery=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "nodeRecovery") unless value.nil?
  jsii_set_property("nodeRecovery", value)
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:



618
619
620
 
# File 'sagemaker/cfn_cluster.rb', line 618

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:



625
626
627
 
# File 'sagemaker/cfn_cluster.rb', line 625

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

#orchestrator ⇒ AWSCDK::IResolvable, ...

The orchestrator type for the SageMaker HyperPod cluster.

Returns:



317
318
319
 
# File 'sagemaker/cfn_cluster.rb', line 317

def orchestrator()
  jsii_get_property("orchestrator")
end

#orchestrator=(value) ⇒ Object 



321
322
323
324
325
 
# File 'sagemaker/cfn_cluster.rb', line 321

def orchestrator=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Sagemaker::CfnCluster::OrchestratorProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zYWdlbWFrZXIuQ2ZuQ2x1c3Rlci5PcmNoZXN0cmF0b3JQcm9wZXJ0eSJ9XX19")), "orchestrator") unless value.nil?
  jsii_set_property("orchestrator", value)
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.



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

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

#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) 


141
142
143
 
# File 'sagemaker/cfn_cluster.rb', line 141

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:



636
637
638
639
 
# File 'sagemaker/cfn_cluster.rb', line 636

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}) 


643
644
645
646
 
# File 'sagemaker/cfn_cluster.rb', line 643

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:



653
654
655
656
657
 
# File 'sagemaker/cfn_cluster.rb', line 653

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

#restricted_instance_groups ⇒ AWSCDK::IResolvable, ...

The restricted instance groups of the SageMaker HyperPod cluster.

Returns:



330
331
332
 
# File 'sagemaker/cfn_cluster.rb', line 330

def restricted_instance_groups()
  jsii_get_property("restrictedInstanceGroups")
end

#restricted_instance_groups=(value) ⇒ Object 



334
335
336
337
 
# File 'sagemaker/cfn_cluster.rb', line 334

def restricted_instance_groups=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc2FnZW1ha2VyLkNmbkNsdXN0ZXIuQ2x1c3RlclJlc3RyaWN0ZWRJbnN0YW5jZUdyb3VwUHJvcGVydHkifV19fSwia2luZCI6ImFycmF5In19XX19")), "restrictedInstanceGroups") unless value.nil?
  jsii_set_property("restrictedInstanceGroups", value)
end

#restricted_instance_groups_config ⇒ AWSCDK::IResolvable, ...

The cluster-level configuration for restricted instance groups, including shared environment settings for inter-RIG communication and FSx Lustre sharing.

Returns:



342
343
344
 
# File 'sagemaker/cfn_cluster.rb', line 342

def restricted_instance_groups_config()
  jsii_get_property("restrictedInstanceGroupsConfig")
end

#restricted_instance_groups_config=(value) ⇒ Object 



346
347
348
349
350
 
# File 'sagemaker/cfn_cluster.rb', line 346

def restricted_instance_groups_config=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Sagemaker::CfnCluster::RestrictedInstanceGroupsConfigProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zYWdlbWFrZXIuQ2ZuQ2x1c3Rlci5SZXN0cmljdGVkSW5zdGFuY2VHcm91cHNDb25maWdQcm9wZXJ0eSJ9XX19")), "restrictedInstanceGroupsConfig") unless value.nil?
  jsii_set_property("restrictedInstanceGroupsConfig", 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.



662
663
664
 
# File 'sagemaker/cfn_cluster.rb', line 662

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:



131
132
133
 
# File 'sagemaker/cfn_cluster.rb', line 131

def stack()
  jsii_get_property("stack")
end

#tags ⇒ Array<AWSCDK::CfnTag>?

A tag object that consists of a key and an optional value, used to manage metadata for SageMaker AWS resources.

Returns:



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

def tags()
  jsii_get_property("tags")
end

#tags=(value) ⇒ Object 



359
360
361
362
363
 
# File 'sagemaker/cfn_cluster.rb', line 359

def tags=(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=")), "tags") unless value.nil?
  jsii_set_property("tags", value)
end

#tiered_storage_config ⇒ AWSCDK::IResolvable, ...

Configuration for tiered storage in the SageMaker HyperPod cluster.

Returns:



368
369
370
 
# File 'sagemaker/cfn_cluster.rb', line 368

def tiered_storage_config()
  jsii_get_property("tieredStorageConfig")
end

#tiered_storage_config=(value) ⇒ Object 



372
373
374
375
376
 
# File 'sagemaker/cfn_cluster.rb', line 372

def tiered_storage_config=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Sagemaker::CfnCluster::TieredStorageConfigProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zYWdlbWFrZXIuQ2ZuQ2x1c3Rlci5UaWVyZWRTdG9yYWdlQ29uZmlnUHJvcGVydHkifV19fQ==")), "tieredStorageConfig") unless value.nil?
  jsii_set_property("tieredStorageConfig", value)
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



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

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}) 


178
179
180
 
# File 'sagemaker/cfn_cluster.rb', line 178

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}) 


188
189
190
 
# File 'sagemaker/cfn_cluster.rb', line 188

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


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

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

#vpc_config ⇒ AWSCDK::IResolvable, ...

Specifies an Amazon Virtual Private Cloud (VPC) that your SageMaker jobs, hosted models, and compute resources have access to.

Returns:



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

def vpc_config()
  jsii_get_property("vpcConfig")
end

#vpc_config=(value) ⇒ Object 



385
386
387
388
389
 
# File 'sagemaker/cfn_cluster.rb', line 385

def vpc_config=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Sagemaker::CfnCluster::VPCConfigProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zYWdlbWFrZXIuQ2ZuQ2x1c3Rlci5WcGNDb25maWdQcm9wZXJ0eSJ9XX19")), "vpcConfig") unless value.nil?
  jsii_set_property("vpcConfig", 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) 


407
408
409
410
411
412
 
# File 'sagemaker/cfn_cluster.rb', line 407

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