Class: Aws::SageMaker::Types::UpdateClusterSoftwareRequest

Inherits:

Struct

• Object
• Struct
• Aws::SageMaker::Types::UpdateClusterSoftwareRequest

Includes:

Aws::Structure

Defined in:

lib/aws-sdk-sagemaker/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #cluster_name ⇒ String

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

• #deployment_config ⇒ Types::DeploymentConfiguration

  The configuration to use when updating the AMI versions.

• #image_id ⇒ String

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

• #instance_groups ⇒ Array<Types::UpdateClusterSoftwareInstanceGroupSpecification>

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

Instance Attribute Details

#cluster_name ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-sagemaker/types.rb', line 50682

class UpdateClusterSoftwareRequest < Struct.new(
  :cluster_name,
  :instance_groups,
  :deployment_config,
  :image_id)
  SENSITIVE = []
  include Aws::Structure
end

#deployment_config ⇒ Types::DeploymentConfiguration

The configuration to use when updating the AMI versions.

Returns:

• (Types::DeploymentConfiguration)

# File 'lib/aws-sdk-sagemaker/types.rb', line 50682

class UpdateClusterSoftwareRequest < Struct.new(
  :cluster_name,
  :instance_groups,
  :deployment_config,
  :image_id)
  SENSITIVE = []
  include Aws::Structure
end

#image_id ⇒ String

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:

• (String)

# File 'lib/aws-sdk-sagemaker/types.rb', line 50682

class UpdateClusterSoftwareRequest < Struct.new(
  :cluster_name,
  :instance_groups,
  :deployment_config,
  :image_id)
  SENSITIVE = []
  include Aws::Structure
end

#instance_groups ⇒ Array<Types::UpdateClusterSoftwareInstanceGroupSpecification>

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

Returns:

• (Array<Types::UpdateClusterSoftwareInstanceGroupSpecification>)

# File 'lib/aws-sdk-sagemaker/types.rb', line 50682

class UpdateClusterSoftwareRequest < Struct.new(
  :cluster_name,
  :instance_groups,
  :deployment_config,
  :image_id)
  SENSITIVE = []
  include Aws::Structure
end