Package software.amazon.awscdk.cfnpropertymixins.services.sagemaker

Interface CfnClusterPropsMixin.ClusterLifeCycleConfigProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnClusterPropsMixin.ClusterLifeCycleConfigProperty.Jsii$Proxy

Enclosing class:

CfnClusterPropsMixin

@Stability(Stable)
public static interface CfnClusterPropsMixin.ClusterLifeCycleConfigProperty
extends software.amazon.jsii.JsiiSerializable

The lifecycle configuration for a SageMaker HyperPod cluster.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.sagemaker.*;
 ClusterLifeCycleConfigProperty clusterLifeCycleConfigProperty = ClusterLifeCycleConfigProperty.builder()
         .onCreate("onCreate")
         .sourceS3Uri("sourceS3Uri")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-clusterlifecycleconfig.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnClusterPropsMixin.ClusterLifeCycleConfigProperty.Builder	A builder for CfnClusterPropsMixin.ClusterLifeCycleConfigProperty
static final class	CfnClusterPropsMixin.ClusterLifeCycleConfigProperty.Jsii$Proxy	An implementation for CfnClusterPropsMixin.ClusterLifeCycleConfigProperty

Method Summary

Modifier and Type	Method	Description
static CfnClusterPropsMixin.ClusterLifeCycleConfigProperty.Builder	builder()
default String	getOnCreate()	The file name of the entrypoint script of lifecycle scripts under SourceS3Uri .
default String	getSourceS3Uri()	An Amazon S3 bucket path where your lifecycle scripts are stored.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getOnCreate

@Stability(Stable)
@Nullable
default String getOnCreate()

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

This entrypoint script runs during cluster creation.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-clusterlifecycleconfig.html#cfn-sagemaker-cluster-clusterlifecycleconfig-oncreate

getSourceS3Uri

@Stability(Stable)
@Nullable
default String getSourceS3Uri()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-clusterlifecycleconfig.html#cfn-sagemaker-cluster-clusterlifecycleconfig-sources3uri

builder

@Stability(Stable)
static CfnClusterPropsMixin.ClusterLifeCycleConfigProperty.Builder builder()

Returns:

a CfnClusterPropsMixin.ClusterLifeCycleConfigProperty.Builder of CfnClusterPropsMixin.ClusterLifeCycleConfigProperty