Package software.amazon.awscdk.services.sagemaker

Interface CfnCluster.SharedEnvironmentConfigProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnCluster.SharedEnvironmentConfigProperty.Jsii$Proxy

Enclosing class:

CfnCluster

@Stability(Stable)
public static interface CfnCluster.SharedEnvironmentConfigProperty
extends software.amazon.jsii.JsiiSerializable

The shared environment configuration for restricted instance groups that use cluster-level shared FSx Lustre storage.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.sagemaker.*;
 SharedEnvironmentConfigProperty sharedEnvironmentConfigProperty = SharedEnvironmentConfigProperty.builder()
         .fSxLustreDeletionPolicy("fSxLustreDeletionPolicy")
         // the properties below are optional
         .fSxLustreConfig(FSxLustreConfigProperty.builder()
                 .perUnitStorageThroughput(123)
                 .sizeInGiB(123)
                 .build())
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnCluster.SharedEnvironmentConfigProperty.Builder	builder()
default Object	getFSxLustreConfig()	Configuration settings for an Amazon FSx for Lustre file system to be used with the cluster.
String	getFSxLustreDeletionPolicy()	The deletion policy for the shared FSx Lustre file system.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getFSxLustreDeletionPolicy

@Stability(Stable)
@NotNull
String getFSxLustreDeletionPolicy()

The deletion policy for the shared FSx Lustre file system.

Keep retains the FSx when RIGs are deleted. DeleteIfNotUsed deletes the FSx when no RIGs reference it.

See Also:

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

getFSxLustreConfig

@Stability(Stable)
@Nullable
default Object getFSxLustreConfig()

Configuration settings for an Amazon FSx for Lustre file system to be used with the cluster.

Returns union: either IResolvable or CfnCluster.FSxLustreConfigProperty

See Also:

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

builder

@Stability(Stable)
static CfnCluster.SharedEnvironmentConfigProperty.Builder builder()

Returns:

a CfnCluster.SharedEnvironmentConfigProperty.Builder of CfnCluster.SharedEnvironmentConfigProperty