Interface ClusterNodeDetails.Builder

All Superinterfaces:

Buildable, CopyableBuilder<ClusterNodeDetails.Builder,ClusterNodeDetails>, SdkBuilder<ClusterNodeDetails.Builder,ClusterNodeDetails>, SdkPojo

Enclosing class:

ClusterNodeDetails

@Mutable
@NotThreadSafe
public static interface ClusterNodeDetails.Builder
extends SdkPojo, CopyableBuilder<ClusterNodeDetails.Builder,ClusterNodeDetails>

Method Summary

Modifier and Type	Method	Description
ClusterNodeDetails.Builder	instanceGroupName(String instanceGroupName)	The instance group name in which the instance is.
ClusterNodeDetails.Builder	instanceId(String instanceId)	The ID of the instance.
default ClusterNodeDetails.Builder	instanceStatus(Consumer<ClusterInstanceStatusDetails.Builder> instanceStatus)	The status of the instance.
ClusterNodeDetails.Builder	instanceStatus(ClusterInstanceStatusDetails instanceStatus)	The status of the instance.
ClusterNodeDetails.Builder	instanceStorageConfigs(Collection<ClusterInstanceStorageConfig> instanceStorageConfigs)	The configurations of additional storage specified to the instance group where the instance (node) is launched.
ClusterNodeDetails.Builder	instanceStorageConfigs(Consumer<ClusterInstanceStorageConfig.Builder>... instanceStorageConfigs)	The configurations of additional storage specified to the instance group where the instance (node) is launched.
ClusterNodeDetails.Builder	instanceStorageConfigs(ClusterInstanceStorageConfig... instanceStorageConfigs)	The configurations of additional storage specified to the instance group where the instance (node) is launched.
ClusterNodeDetails.Builder	instanceType(String instanceType)	The type of the instance.
ClusterNodeDetails.Builder	instanceType(ClusterInstanceType instanceType)	The type of the instance.
ClusterNodeDetails.Builder	lastSoftwareUpdateTime(Instant lastSoftwareUpdateTime)	The time when the cluster was last updated.
ClusterNodeDetails.Builder	launchTime(Instant launchTime)	The time when the instance is launched.
default ClusterNodeDetails.Builder	lifeCycleConfig(Consumer<ClusterLifeCycleConfig.Builder> lifeCycleConfig)	The LifeCycle configuration applied to the instance.
ClusterNodeDetails.Builder	lifeCycleConfig(ClusterLifeCycleConfig lifeCycleConfig)	The LifeCycle configuration applied to the instance.
default ClusterNodeDetails.Builder	overrideVpcConfig(Consumer<VpcConfig.Builder> overrideVpcConfig)	The customized Amazon VPC configuration at the instance group level that overrides the default Amazon VPC configuration of the SageMaker HyperPod cluster.
ClusterNodeDetails.Builder	overrideVpcConfig(VpcConfig overrideVpcConfig)	The customized Amazon VPC configuration at the instance group level that overrides the default Amazon VPC configuration of the SageMaker HyperPod cluster.
default ClusterNodeDetails.Builder	placement(Consumer<ClusterInstancePlacement.Builder> placement)	The placement details of the SageMaker HyperPod cluster node.
ClusterNodeDetails.Builder	placement(ClusterInstancePlacement placement)	The placement details of the SageMaker HyperPod cluster node.
ClusterNodeDetails.Builder	privateDnsHostname(String privateDnsHostname)	The private DNS hostname of the SageMaker HyperPod cluster node.
ClusterNodeDetails.Builder	privatePrimaryIp(String privatePrimaryIp)	The private primary IP address of the SageMaker HyperPod cluster node.
ClusterNodeDetails.Builder	privatePrimaryIpv6(String privatePrimaryIpv6)	The private primary IPv6 address of the SageMaker HyperPod cluster node when configured with an Amazon VPC that supports IPv6 and includes subnets with IPv6 addressing enabled in either the cluster Amazon VPC configuration or the instance group Amazon VPC configuration.
ClusterNodeDetails.Builder	threadsPerCore(Integer threadsPerCore)	The number of threads per CPU core you specified under CreateCluster.

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Details

instanceGroupName

ClusterNodeDetails.Builder instanceGroupName(String instanceGroupName)

The instance group name in which the instance is.

Parameters:

instanceGroupName - The instance group name in which the instance is.

Returns:

Returns a reference to this object so that method calls can be chained together.

instanceId

ClusterNodeDetails.Builder instanceId(String instanceId)

The ID of the instance.

Parameters:

instanceId - The ID of the instance.

Returns:

Returns a reference to this object so that method calls can be chained together.

instanceStatus

ClusterNodeDetails.Builder instanceStatus(ClusterInstanceStatusDetails instanceStatus)

The status of the instance.

Parameters:

instanceStatus - The status of the instance.

Returns:

Returns a reference to this object so that method calls can be chained together.

instanceStatus

default ClusterNodeDetails.Builder instanceStatus(Consumer<ClusterInstanceStatusDetails.Builder> instanceStatus)

The status of the instance.

This is a convenience method that creates an instance of the ClusterInstanceStatusDetails.Builder avoiding the need to create one manually via ClusterInstanceStatusDetails.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to instanceStatus(ClusterInstanceStatusDetails).

Parameters:

instanceStatus - a consumer that will call methods on ClusterInstanceStatusDetails.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• instanceStatus(ClusterInstanceStatusDetails)

instanceType

ClusterNodeDetails.Builder instanceType(String instanceType)

The type of the instance.

Parameters:

instanceType - The type of the instance.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• ClusterInstanceType
• ClusterInstanceType

instanceType

ClusterNodeDetails.Builder instanceType(ClusterInstanceType instanceType)

The type of the instance.

Parameters:

instanceType - The type of the instance.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• ClusterInstanceType
• ClusterInstanceType

launchTime

ClusterNodeDetails.Builder launchTime(Instant launchTime)

The time when the instance is launched.

Parameters:

launchTime - The time when the instance is launched.

Returns:

Returns a reference to this object so that method calls can be chained together.

lastSoftwareUpdateTime

ClusterNodeDetails.Builder lastSoftwareUpdateTime(Instant lastSoftwareUpdateTime)

The time when the cluster was last updated.

Parameters:

lastSoftwareUpdateTime - The time when the cluster was last updated.

Returns:

Returns a reference to this object so that method calls can be chained together.

lifeCycleConfig

ClusterNodeDetails.Builder lifeCycleConfig(ClusterLifeCycleConfig lifeCycleConfig)

The LifeCycle configuration applied to the instance.

Parameters:

lifeCycleConfig - The LifeCycle configuration applied to the instance.

Returns:

Returns a reference to this object so that method calls can be chained together.

lifeCycleConfig

default ClusterNodeDetails.Builder lifeCycleConfig(Consumer<ClusterLifeCycleConfig.Builder> lifeCycleConfig)

The LifeCycle configuration applied to the instance.

This is a convenience method that creates an instance of the ClusterLifeCycleConfig.Builder avoiding the need to create one manually via ClusterLifeCycleConfig.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to lifeCycleConfig(ClusterLifeCycleConfig).

Parameters:

lifeCycleConfig - a consumer that will call methods on ClusterLifeCycleConfig.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• lifeCycleConfig(ClusterLifeCycleConfig)

overrideVpcConfig

ClusterNodeDetails.Builder overrideVpcConfig(VpcConfig overrideVpcConfig)

The customized Amazon VPC configuration at the instance group level that overrides the default Amazon VPC configuration of the SageMaker HyperPod cluster.

Parameters:

overrideVpcConfig - The customized Amazon VPC configuration at the instance group level that overrides the default Amazon VPC configuration of the SageMaker HyperPod cluster.

Returns:

Returns a reference to this object so that method calls can be chained together.

overrideVpcConfig

default ClusterNodeDetails.Builder overrideVpcConfig(Consumer<VpcConfig.Builder> overrideVpcConfig)

The customized Amazon VPC configuration at the instance group level that overrides the default Amazon VPC configuration of the SageMaker HyperPod cluster.

This is a convenience method that creates an instance of the VpcConfig.Builder avoiding the need to create one manually via VpcConfig.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to overrideVpcConfig(VpcConfig).

Parameters:

overrideVpcConfig - a consumer that will call methods on VpcConfig.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• overrideVpcConfig(VpcConfig)

threadsPerCore

ClusterNodeDetails.Builder threadsPerCore(Integer threadsPerCore)

The number of threads per CPU core you specified under CreateCluster.

Parameters:

threadsPerCore - The number of threads per CPU core you specified under CreateCluster.

Returns:

Returns a reference to this object so that method calls can be chained together.

instanceStorageConfigs

ClusterNodeDetails.Builder instanceStorageConfigs(Collection<ClusterInstanceStorageConfig> instanceStorageConfigs)

The configurations of additional storage specified to the instance group where the instance (node) is launched.

Parameters:

instanceStorageConfigs - The configurations of additional storage specified to the instance group where the instance (node) is launched.

Returns:

Returns a reference to this object so that method calls can be chained together.

instanceStorageConfigs

ClusterNodeDetails.Builder instanceStorageConfigs(ClusterInstanceStorageConfig... instanceStorageConfigs)

The configurations of additional storage specified to the instance group where the instance (node) is launched.

Parameters:

instanceStorageConfigs - The configurations of additional storage specified to the instance group where the instance (node) is launched.

Returns:

Returns a reference to this object so that method calls can be chained together.

instanceStorageConfigs

ClusterNodeDetails.Builder instanceStorageConfigs(Consumer<ClusterInstanceStorageConfig.Builder>... instanceStorageConfigs)

The configurations of additional storage specified to the instance group where the instance (node) is launched.

This is a convenience method that creates an instance of the ClusterInstanceStorageConfig.Builder avoiding the need to create one manually via ClusterInstanceStorageConfig.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to instanceStorageConfigs(List<ClusterInstanceStorageConfig>).

Parameters:

instanceStorageConfigs - a consumer that will call methods on ClusterInstanceStorageConfig.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• instanceStorageConfigs(java.util.Collection<ClusterInstanceStorageConfig>)

privatePrimaryIp

ClusterNodeDetails.Builder privatePrimaryIp(String privatePrimaryIp)

The private primary IP address of the SageMaker HyperPod cluster node.

Parameters:

privatePrimaryIp - The private primary IP address of the SageMaker HyperPod cluster node.

Returns:

Returns a reference to this object so that method calls can be chained together.

privatePrimaryIpv6

ClusterNodeDetails.Builder privatePrimaryIpv6(String privatePrimaryIpv6)

The private primary IPv6 address of the SageMaker HyperPod cluster node when configured with an Amazon VPC that supports IPv6 and includes subnets with IPv6 addressing enabled in either the cluster Amazon VPC configuration or the instance group Amazon VPC configuration.

Parameters:

privatePrimaryIpv6 - The private primary IPv6 address of the SageMaker HyperPod cluster node when configured with an Amazon VPC that supports IPv6 and includes subnets with IPv6 addressing enabled in either the cluster Amazon VPC configuration or the instance group Amazon VPC configuration.

Returns:

Returns a reference to this object so that method calls can be chained together.

privateDnsHostname

ClusterNodeDetails.Builder privateDnsHostname(String privateDnsHostname)

The private DNS hostname of the SageMaker HyperPod cluster node.

Parameters:

privateDnsHostname - The private DNS hostname of the SageMaker HyperPod cluster node.

Returns:

Returns a reference to this object so that method calls can be chained together.

placement

ClusterNodeDetails.Builder placement(ClusterInstancePlacement placement)

The placement details of the SageMaker HyperPod cluster node.

Parameters:

placement - The placement details of the SageMaker HyperPod cluster node.

Returns:

Returns a reference to this object so that method calls can be chained together.

placement

default ClusterNodeDetails.Builder placement(Consumer<ClusterInstancePlacement.Builder> placement)

The placement details of the SageMaker HyperPod cluster node.

This is a convenience method that creates an instance of the ClusterInstancePlacement.Builder avoiding the need to create one manually via ClusterInstancePlacement.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to placement(ClusterInstancePlacement).

Parameters:

placement - a consumer that will call methods on ClusterInstancePlacement.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• placement(ClusterInstancePlacement)