Package software.amazon.awscdk.services.sagemaker

Class CfnCluster.Builder

java.lang.Object

software.amazon.awscdk.services.sagemaker.CfnCluster.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnCluster>

Enclosing class:

CfnCluster

@Stability(Stable)
public static final class CfnCluster.Builder
extends Object
implements software.amazon.jsii.Builder<CfnCluster>

A fluent builder for CfnCluster.

Method Summary

Modifier and Type	Method	Description
CfnCluster.Builder	autoScaling(IResolvable autoScaling)	Configuration for cluster auto-scaling.
CfnCluster.Builder	autoScaling(CfnCluster.ClusterAutoScalingConfigProperty autoScaling)	Configuration for cluster auto-scaling.
CfnCluster	build()
CfnCluster.Builder	clusterName(String clusterName)	The name of the SageMaker HyperPod cluster.
CfnCluster.Builder	clusterRole(String clusterRole)	The cluster role for the autoscaler to assume.
static CfnCluster.Builder	create(software.constructs.Construct scope, String id)
CfnCluster.Builder	instanceGroups(List<? extends Object> instanceGroups)	The instance groups of the SageMaker HyperPod cluster.
CfnCluster.Builder	instanceGroups(IResolvable instanceGroups)	The instance groups of the SageMaker HyperPod cluster.
CfnCluster.Builder	nodeProvisioningMode(String nodeProvisioningMode)	Determines the scaling strategy for the SageMaker HyperPod cluster.
CfnCluster.Builder	nodeRecovery(String nodeRecovery)	Specifies whether to enable or disable the automatic node recovery feature of SageMaker HyperPod.
CfnCluster.Builder	orchestrator(IResolvable orchestrator)	The orchestrator type for the SageMaker HyperPod cluster.
CfnCluster.Builder	orchestrator(CfnCluster.OrchestratorProperty orchestrator)	The orchestrator type for the SageMaker HyperPod cluster.
CfnCluster.Builder	restrictedInstanceGroups(List<? extends Object> restrictedInstanceGroups)	The restricted instance groups of the SageMaker HyperPod cluster.
CfnCluster.Builder	restrictedInstanceGroups(IResolvable restrictedInstanceGroups)	The restricted instance groups of the SageMaker HyperPod cluster.
CfnCluster.Builder	tags(List<? extends CfnTag> tags)	A tag object that consists of a key and an optional value, used to manage metadata for SageMaker AWS resources.
CfnCluster.Builder	tieredStorageConfig(IResolvable tieredStorageConfig)	Configuration for tiered storage in the SageMaker HyperPod cluster.
CfnCluster.Builder	tieredStorageConfig(CfnCluster.TieredStorageConfigProperty tieredStorageConfig)	Configuration for tiered storage in the SageMaker HyperPod cluster.
CfnCluster.Builder	vpcConfig(IResolvable vpcConfig)	Specifies an Amazon Virtual Private Cloud (VPC) that your SageMaker jobs, hosted models, and compute resources have access to.
CfnCluster.Builder	vpcConfig(CfnCluster.VpcConfigProperty vpcConfig)	Specifies an Amazon Virtual Private Cloud (VPC) that your SageMaker jobs, hosted models, and compute resources have access to.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

@Stability(Stable)
public static CfnCluster.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnCluster.Builder.

autoScaling

@Stability(Stable)
public CfnCluster.Builder autoScaling(IResolvable autoScaling)

Configuration for cluster auto-scaling.

Parameters:

autoScaling - Configuration for cluster auto-scaling. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-cluster.html#cfn-sagemaker-cluster-autoscaling

autoScaling

@Stability(Stable)
public CfnCluster.Builder autoScaling(CfnCluster.ClusterAutoScalingConfigProperty autoScaling)

Configuration for cluster auto-scaling.

Parameters:

autoScaling - Configuration for cluster auto-scaling. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-cluster.html#cfn-sagemaker-cluster-autoscaling

clusterName

@Stability(Stable)
public CfnCluster.Builder clusterName(String clusterName)

The name of the SageMaker HyperPod cluster.

Parameters:

clusterName - The name of the SageMaker HyperPod cluster. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-cluster.html#cfn-sagemaker-cluster-clustername

clusterRole

@Stability(Stable)
public CfnCluster.Builder clusterRole(String clusterRole)

The cluster role for the autoscaler to assume.

Parameters:

clusterRole - The cluster role for the autoscaler to assume. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-cluster.html#cfn-sagemaker-cluster-clusterrole

instanceGroups

@Stability(Stable)
public CfnCluster.Builder instanceGroups(IResolvable instanceGroups)

The instance groups of the SageMaker HyperPod cluster.

To delete an instance group, remove it from the array.

Parameters:

instanceGroups - The instance groups of the SageMaker HyperPod cluster. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-cluster.html#cfn-sagemaker-cluster-instancegroups

instanceGroups

@Stability(Stable)
public CfnCluster.Builder instanceGroups(List<? extends Object> instanceGroups)

The instance groups of the SageMaker HyperPod cluster.

To delete an instance group, remove it from the array.

Parameters:

instanceGroups - The instance groups of the SageMaker HyperPod cluster. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-cluster.html#cfn-sagemaker-cluster-instancegroups

nodeProvisioningMode

@Stability(Stable)
public CfnCluster.Builder nodeProvisioningMode(String nodeProvisioningMode)

Determines the scaling strategy for the SageMaker HyperPod cluster.

When set to 'Continuous', enables continuous scaling which dynamically manages node provisioning. If the parameter is omitted, uses the standard scaling approach in previous release.

Parameters:

nodeProvisioningMode - Determines the scaling strategy for the SageMaker HyperPod cluster. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-cluster.html#cfn-sagemaker-cluster-nodeprovisioningmode

nodeRecovery

@Stability(Stable)
public CfnCluster.Builder nodeRecovery(String nodeRecovery)

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

Available values are Automatic for enabling and None for disabling.

Parameters:

nodeRecovery - Specifies whether to enable or disable the automatic node recovery feature of SageMaker HyperPod. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-cluster.html#cfn-sagemaker-cluster-noderecovery

orchestrator

@Stability(Stable)
public CfnCluster.Builder orchestrator(IResolvable orchestrator)

The orchestrator type for the SageMaker HyperPod cluster.

Currently, 'eks' is the only available option.

Parameters:

orchestrator - The orchestrator type for the SageMaker HyperPod cluster. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-cluster.html#cfn-sagemaker-cluster-orchestrator

orchestrator

@Stability(Stable)
public CfnCluster.Builder orchestrator(CfnCluster.OrchestratorProperty orchestrator)

The orchestrator type for the SageMaker HyperPod cluster.

Currently, 'eks' is the only available option.

Parameters:

orchestrator - The orchestrator type for the SageMaker HyperPod cluster. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-cluster.html#cfn-sagemaker-cluster-orchestrator

restrictedInstanceGroups

@Stability(Stable)
public CfnCluster.Builder restrictedInstanceGroups(IResolvable restrictedInstanceGroups)

The restricted instance groups of the SageMaker HyperPod cluster.

Parameters:

restrictedInstanceGroups - The restricted instance groups of the SageMaker HyperPod cluster. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-cluster.html#cfn-sagemaker-cluster-restrictedinstancegroups

restrictedInstanceGroups

@Stability(Stable)
public CfnCluster.Builder restrictedInstanceGroups(List<? extends Object> restrictedInstanceGroups)

The restricted instance groups of the SageMaker HyperPod cluster.

Parameters:

restrictedInstanceGroups - The restricted instance groups of the SageMaker HyperPod cluster. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-cluster.html#cfn-sagemaker-cluster-restrictedinstancegroups

tags

@Stability(Stable)
public CfnCluster.Builder tags(List<? extends CfnTag> tags)

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

You can add tags to notebook instances, training jobs, hyperparameter tuning jobs, batch transform jobs, models, labeling jobs, work teams, endpoint configurations, and endpoints. For more information on adding tags to SageMaker resources, see AddTags .

For more information on adding metadata to your AWS resources with tagging, see Tagging AWS resources . For advice on best practices for managing AWS resources with tagging, see Tagging Best Practices: Implement an Effective AWS Resource Tagging Strategy .

Parameters:

tags - A tag object that consists of a key and an optional value, used to manage metadata for SageMaker AWS resources. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-cluster.html#cfn-sagemaker-cluster-tags

tieredStorageConfig

@Stability(Stable)
public CfnCluster.Builder tieredStorageConfig(IResolvable tieredStorageConfig)

Configuration for tiered storage in the SageMaker HyperPod cluster.

Parameters:

tieredStorageConfig - Configuration for tiered storage in the SageMaker HyperPod cluster. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-cluster.html#cfn-sagemaker-cluster-tieredstorageconfig

tieredStorageConfig

@Stability(Stable)
public CfnCluster.Builder tieredStorageConfig(CfnCluster.TieredStorageConfigProperty tieredStorageConfig)

Configuration for tiered storage in the SageMaker HyperPod cluster.

Parameters:

tieredStorageConfig - Configuration for tiered storage in the SageMaker HyperPod cluster. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-cluster.html#cfn-sagemaker-cluster-tieredstorageconfig

vpcConfig

@Stability(Stable)
public CfnCluster.Builder vpcConfig(IResolvable vpcConfig)

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

You can control access to and from your resources by configuring a VPC. For more information, see Give SageMaker Access to Resources in your Amazon VPC .

Parameters:

vpcConfig - Specifies an Amazon Virtual Private Cloud (VPC) that your SageMaker jobs, hosted models, and compute resources have access to. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-cluster.html#cfn-sagemaker-cluster-vpcconfig

vpcConfig

@Stability(Stable)
public CfnCluster.Builder vpcConfig(CfnCluster.VpcConfigProperty vpcConfig)

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

You can control access to and from your resources by configuring a VPC. For more information, see Give SageMaker Access to Resources in your Amazon VPC .

Parameters:

vpcConfig - Specifies an Amazon Virtual Private Cloud (VPC) that your SageMaker jobs, hosted models, and compute resources have access to. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-cluster.html#cfn-sagemaker-cluster-vpcconfig

build

@Stability(Stable)
public CfnCluster build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnCluster>

Returns:

a newly built instance of CfnCluster.