Class: AWSCDK::Sagemaker::CfnCluster::ClusterLifeCycleConfigProperty

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

Overview

The lifecycle configuration for a SageMaker HyperPod cluster.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(on_create: nil, on_init_complete: nil, source_s3_uri: nil) ⇒ ClusterLifeCycleConfigProperty

Returns a new instance of ClusterLifeCycleConfigProperty.

Parameters:

  • on_create (String, nil) (defaults to: nil) —

    The file name of the entrypoint script of lifecycle scripts under SourceS3Uri .

  • on_init_complete (String, nil) (defaults to: nil) —

    The file name of the extension script under SourceS3Uri.

  • source_s3_uri (String, nil) (defaults to: nil) —

    An Amazon S3 bucket path where your lifecycle scripts are stored.



1403
1404
1405
1406
1407
1408
1409
1410
 
# File 'sagemaker/cfn_cluster.rb', line 1403

def initialize(on_create: nil, on_init_complete: nil, source_s3_uri: nil)
  @on_create = on_create
  Jsii::Type.check_type(@on_create, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "onCreate") unless @on_create.nil?
  @on_init_complete = on_init_complete
  Jsii::Type.check_type(@on_init_complete, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "onInitComplete") unless @on_init_complete.nil?
  @source_s3_uri = source_s3_uri
  Jsii::Type.check_type(@source_s3_uri, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "sourceS3Uri") unless @source_s3_uri.nil?
end

Instance Attribute Details

#on_create ⇒ String? (readonly)

The file name of the entrypoint script of lifecycle scripts under SourceS3Uri .

This entrypoint script runs during cluster creation.

Returns:

  • (String, nil)

See Also:



1418
1419
1420
 
# File 'sagemaker/cfn_cluster.rb', line 1418

def on_create
  @on_create
end

#on_init_complete ⇒ String? (readonly)

The file name of the extension script under SourceS3Uri.

This script runs after HyperPod configures the default software on the instance. Mutually exclusive with OnCreate.

Returns:

  • (String, nil)

See Also:



1425
1426
1427
 
# File 'sagemaker/cfn_cluster.rb', line 1425

def on_init_complete
  @on_init_complete
end

#source_s3_uri ⇒ String? (readonly)

An Amazon S3 bucket path where your lifecycle scripts are stored.

Make sure that the S3 bucket path starts with s3://sagemaker- . The IAM role for SageMaker HyperPod has the managed AmazonSageMakerClusterInstanceRolePolicy attached, which allows access to S3 buckets with the specific prefix sagemaker- .

Returns:

  • (String, nil)

See Also:



1432
1433
1434
 
# File 'sagemaker/cfn_cluster.rb', line 1432

def source_s3_uri
  @source_s3_uri
end

Class Method Details

.jsii_properties ⇒ Object 



1434
1435
1436
1437
1438
1439
1440
 
# File 'sagemaker/cfn_cluster.rb', line 1434

def self.jsii_properties
  {
    :on_create => "onCreate",
    :on_init_complete => "onInitComplete",
    :source_s3_uri => "sourceS3Uri",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



1442
1443
1444
1445
1446
1447
1448
1449
1450
 
# File 'sagemaker/cfn_cluster.rb', line 1442

def to_jsii
  result = {}
  result.merge!({
    "onCreate" => @on_create,
    "onInitComplete" => @on_init_complete,
    "sourceS3Uri" => @source_s3_uri,
  })
  result.compact
end