Interface UpdateClusterSoftwareRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<UpdateClusterSoftwareRequest.Builder,UpdateClusterSoftwareRequest>, SageMakerRequest.Builder, SdkBuilder<UpdateClusterSoftwareRequest.Builder,UpdateClusterSoftwareRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

UpdateClusterSoftwareRequest

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

Method Summary

Modifier and Type	Method	Description
UpdateClusterSoftwareRequest.Builder	clusterName(String clusterName)	Specify the name or the Amazon Resource Name (ARN) of the SageMaker HyperPod cluster you want to update for security patching.
default UpdateClusterSoftwareRequest.Builder	deploymentConfig(Consumer<DeploymentConfiguration.Builder> deploymentConfig)	The configuration to use when updating the AMI versions.
UpdateClusterSoftwareRequest.Builder	deploymentConfig(DeploymentConfiguration deploymentConfig)	The configuration to use when updating the AMI versions.
UpdateClusterSoftwareRequest.Builder	imageId(String imageId)	When configuring your HyperPod cluster, you can specify an image ID using one of the following options:
UpdateClusterSoftwareRequest.Builder	instanceGroups(Collection<UpdateClusterSoftwareInstanceGroupSpecification> instanceGroups)	The array of instance groups for which to update AMI versions.
UpdateClusterSoftwareRequest.Builder	instanceGroups(Consumer<UpdateClusterSoftwareInstanceGroupSpecification.Builder>... instanceGroups)	The array of instance groups for which to update AMI versions.
UpdateClusterSoftwareRequest.Builder	instanceGroups(UpdateClusterSoftwareInstanceGroupSpecification... instanceGroups)	The array of instance groups for which to update AMI versions.
UpdateClusterSoftwareRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
UpdateClusterSoftwareRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

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

copy

Methods inherited from interface software.amazon.awssdk.services.sagemaker.model.SageMakerRequest.Builder

build

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

clusterName

UpdateClusterSoftwareRequest.Builder clusterName(String clusterName)

Specify the name or the Amazon Resource Name (ARN) of the SageMaker HyperPod cluster you want to update for security patching.

Parameters:

clusterName - Specify the name or the Amazon Resource Name (ARN) of the SageMaker HyperPod cluster you want to update for security patching.

Returns:

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

instanceGroups

UpdateClusterSoftwareRequest.Builder instanceGroups(Collection<UpdateClusterSoftwareInstanceGroupSpecification> instanceGroups)

The array of instance groups for which to update AMI versions.

Parameters:

instanceGroups - The array of instance groups for which to update AMI versions.

Returns:

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

instanceGroups

UpdateClusterSoftwareRequest.Builder instanceGroups(UpdateClusterSoftwareInstanceGroupSpecification... instanceGroups)

The array of instance groups for which to update AMI versions.

Parameters:

instanceGroups - The array of instance groups for which to update AMI versions.

Returns:

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

instanceGroups

UpdateClusterSoftwareRequest.Builder instanceGroups(Consumer<UpdateClusterSoftwareInstanceGroupSpecification.Builder>... instanceGroups)

The array of instance groups for which to update AMI versions.

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

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

Parameters:

instanceGroups - a consumer that will call methods on UpdateClusterSoftwareInstanceGroupSpecification.Builder

Returns:

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

See Also:

• instanceGroups(java.util.Collection<UpdateClusterSoftwareInstanceGroupSpecification>)

deploymentConfig

UpdateClusterSoftwareRequest.Builder deploymentConfig(DeploymentConfiguration deploymentConfig)

The configuration to use when updating the AMI versions.

Parameters:

deploymentConfig - The configuration to use when updating the AMI versions.

Returns:

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

deploymentConfig

default UpdateClusterSoftwareRequest.Builder deploymentConfig(Consumer<DeploymentConfiguration.Builder> deploymentConfig)

The configuration to use when updating the AMI versions.

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

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

Parameters:

deploymentConfig - a consumer that will call methods on DeploymentConfiguration.Builder

Returns:

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

See Also:

• deploymentConfig(DeploymentConfiguration)

imageId

UpdateClusterSoftwareRequest.Builder imageId(String imageId)

When configuring your HyperPod cluster, you can specify an image ID using one of the following options:

• HyperPodPublicAmiId: Use a HyperPod public AMI

• CustomAmiId: Use your custom AMI

• default: Use the default latest system image

If you choose to use a custom AMI (CustomAmiId), ensure it meets the following requirements:

• Encryption: The custom AMI must be unencrypted.

• Ownership: The custom AMI must be owned by the same Amazon Web Services account that is creating the HyperPod cluster.

• Volume support: Only the primary AMI snapshot volume is supported; additional AMI volumes are not supported.

When updating the instance group's AMI through the UpdateClusterSoftware operation, if an instance group uses a custom AMI, you must provide an ImageId or use the default as input. Note that if you don't specify an instance group in your UpdateClusterSoftware request, then all of the instance groups are patched with the specified image.

Parameters:

imageId - When configuring your HyperPod cluster, you can specify an image ID using one of the following options:

• HyperPodPublicAmiId: Use a HyperPod public AMI

• CustomAmiId: Use your custom AMI

• default: Use the default latest system image

If you choose to use a custom AMI (CustomAmiId), ensure it meets the following requirements:

• Encryption: The custom AMI must be unencrypted.

• Ownership: The custom AMI must be owned by the same Amazon Web Services account that is creating the HyperPod cluster.

• Volume support: Only the primary AMI snapshot volume is supported; additional AMI volumes are not supported.

When updating the instance group's AMI through the UpdateClusterSoftware operation, if an instance group uses a custom AMI, you must provide an ImageId or use the default as input. Note that if you don't specify an instance group in your UpdateClusterSoftware request, then all of the instance groups are patched with the specified image.

Returns:

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

overrideConfiguration

UpdateClusterSoftwareRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

UpdateClusterSoftwareRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.