Package software.amazon.awscdk.services.sagemaker

Class CfnClusterProps.Builder

java.lang.Object

software.amazon.awscdk.services.sagemaker.CfnClusterProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnClusterProps>

Enclosing interface:

CfnClusterProps

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

A builder for CfnClusterProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnClusterProps	build()	Builds the configured instance.
CfnClusterProps.Builder	clusterName(String clusterName)	Sets the value of CfnClusterProps.getClusterName()
CfnClusterProps.Builder	instanceGroups(List<? extends Object> instanceGroups)	Sets the value of CfnClusterProps.getInstanceGroups()
CfnClusterProps.Builder	instanceGroups(IResolvable instanceGroups)	Sets the value of CfnClusterProps.getInstanceGroups()
CfnClusterProps.Builder	nodeProvisioningMode(String nodeProvisioningMode)	Sets the value of CfnClusterProps.getNodeProvisioningMode()
CfnClusterProps.Builder	nodeRecovery(String nodeRecovery)	Sets the value of CfnClusterProps.getNodeRecovery()
CfnClusterProps.Builder	orchestrator(IResolvable orchestrator)	Sets the value of CfnClusterProps.getOrchestrator()
CfnClusterProps.Builder	orchestrator(CfnCluster.OrchestratorProperty orchestrator)	Sets the value of CfnClusterProps.getOrchestrator()
CfnClusterProps.Builder	restrictedInstanceGroups(List<? extends Object> restrictedInstanceGroups)	Sets the value of CfnClusterProps.getRestrictedInstanceGroups()
CfnClusterProps.Builder	restrictedInstanceGroups(IResolvable restrictedInstanceGroups)	Sets the value of CfnClusterProps.getRestrictedInstanceGroups()
CfnClusterProps.Builder	tags(List<? extends CfnTag> tags)	Sets the value of CfnClusterProps.getTags()
CfnClusterProps.Builder	vpcConfig(IResolvable vpcConfig)	Sets the value of CfnClusterProps.getVpcConfig()
CfnClusterProps.Builder	vpcConfig(CfnCluster.VpcConfigProperty vpcConfig)	Sets the value of CfnClusterProps.getVpcConfig()

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

clusterName

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

Sets the value of CfnClusterProps.getClusterName()

Parameters:

clusterName - The name of the SageMaker HyperPod cluster.

Returns:

this

instanceGroups

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

Sets the value of CfnClusterProps.getInstanceGroups()

Parameters:

instanceGroups - The instance groups of the SageMaker HyperPod cluster. To delete an instance group, remove it from the array.

Returns:

this

instanceGroups

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

Sets the value of CfnClusterProps.getInstanceGroups()

Parameters:

instanceGroups - The instance groups of the SageMaker HyperPod cluster. To delete an instance group, remove it from the array.

Returns:

this

nodeProvisioningMode

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

Sets the value of CfnClusterProps.getNodeProvisioningMode()

Parameters:

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.

Returns:

this

nodeRecovery

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

Sets the value of CfnClusterProps.getNodeRecovery()

Parameters:

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.

Returns:

this

orchestrator

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

Sets the value of CfnClusterProps.getOrchestrator()

Parameters:

orchestrator - The orchestrator type for the SageMaker HyperPod cluster. Currently, 'eks' is the only available option.

Returns:

this

orchestrator

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

Sets the value of CfnClusterProps.getOrchestrator()

Parameters:

orchestrator - The orchestrator type for the SageMaker HyperPod cluster. Currently, 'eks' is the only available option.

Returns:

this

restrictedInstanceGroups

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

Sets the value of CfnClusterProps.getRestrictedInstanceGroups()

Parameters:

restrictedInstanceGroups - The restricted instance groups of the SageMaker HyperPod cluster.

Returns:

this

restrictedInstanceGroups

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

Sets the value of CfnClusterProps.getRestrictedInstanceGroups()

Parameters:

restrictedInstanceGroups - The restricted instance groups of the SageMaker HyperPod cluster.

Returns:

this

tags

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

Sets the value of CfnClusterProps.getTags()

Parameters:

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 .

Returns:

this

vpcConfig

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

Sets the value of CfnClusterProps.getVpcConfig()

Parameters:

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 .

Returns:

this

vpcConfig

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

Sets the value of CfnClusterProps.getVpcConfig()

Parameters:

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 .

Returns:

this

build

@Stability(Stable)
public CfnClusterProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CfnClusterProps

Throws:

NullPointerException - if any required attribute was not provided