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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

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) 


50682
50683
50684
50685
50686
50687
50688
50689
 
# File 'gems/aws-sdk-sagemaker/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:



50682
50683
50684
50685
50686
50687
50688
50689
 
# File 'gems/aws-sdk-sagemaker/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) 


50682
50683
50684
50685
50686
50687
50688
50689
 
# File 'gems/aws-sdk-sagemaker/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:



50682
50683
50684
50685
50686
50687
50688
50689
 
# File 'gems/aws-sdk-sagemaker/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