Update-SMClusterSoftware Cmdlet

Amazon.PowerShell.Cmdlets.SM.AmazonSageMakerClientCmdlet.ClientConfig

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

An array that contains the alarms that SageMaker monitors to know whether to roll back the AMI update.

The duration in seconds that SageMaker waits before updating more instances in the cluster.

This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.

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.

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

Specifies whether SageMaker should process the update by amount or percentage of instances.

Specifies the amount or percentage of instances SageMaker updates at a time.

Changes the cmdlet behavior to return the value passed to the ClusterName parameter. The -PassThru parameter is deprecated, use -Select '^ClusterName' instead. This parameter will be removed in a future version.

Specifies whether SageMaker should process the update by amount or percentage of instances.

Specifies the amount or percentage of instances SageMaker updates at a time.

Use the -Select parameter to control the cmdlet output. The default value is 'ClusterArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.UpdateClusterSoftwareResponse). Specifying the name of a property of type Amazon.SageMaker.Model.UpdateClusterSoftwareResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.

The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.

An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.

The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.

Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.

Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.

The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.

The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.

The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.

The session token if the access and secret keys are temporary session-based credentials.