AWS CLI Command Reference

[ aws . pcs ]

register-compute-node-group-instance

Description

Warning

This API action isn’t intended for you to use.

PCS uses this API action to register the compute nodes it launches in your account.

See also: AWS API Documentation

Synopsis

  register-compute-node-group-instance
--cluster-identifier <value>
--bootstrap-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]

Options

--cluster-identifier (string) [required]

The name or ID of the cluster to register the compute node group instance in.

Constraints:

  • pattern: (pcs_[a-zA-Z0-9]+|[A-Za-z][A-Za-z0-9-]{2,40})

--bootstrap-id (string) [required]

The client-generated token to allow for retries.

Constraints:

  • min: 1
  • max: 1000
  • pattern: [\S]+

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table
  • yaml
  • yaml-stream
  • off

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

--cli-error-format (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

  • legacy
  • json
  • yaml
  • text
  • table
  • enhanced

Output

nodeID -> (string)

The scheduler node ID for this instance.

sharedSecret -> (string)

For the Slurm scheduler, this is the shared Munge key the scheduler uses to authenticate compute node group instances.

endpoints -> (list)

The list of endpoints available for interaction with the scheduler.

(structure)

An endpoint available for interaction with the scheduler.

type -> (string) [required]

Indicates the type of endpoint running at the specific IP address.

Possible values:

  • SLURMCTLD
  • SLURMDBD
  • SLURMRESTD

privateIpAddress -> (string) [required]

For clusters that use IPv4, this is the endpoint’s private IP address.

Example: 10.1.2.3

For clusters configured to use IPv6, this is an empty string.

publicIpAddress -> (string)

The endpoint’s public IP address.

Example: 192.0.2.1

ipv6Address -> (string)

The endpoint’s IPv6 address.

Example: 2001:db8::1

port -> (string) [required]

The endpoint’s connection port number.

Example: 1234

clusterName -> (string)

The name of the cluster that the compute node registered into.

computeNodeGroupId -> (string)

The ID of the compute node group that the compute node registered into.

computeNodeGroupName -> (string)

The name of the compute node group that the compute node registered into.

nodeLifecycleActions -> (structure)

The node lifecycle actions configured for the node group, including scripts to run when a compute node finishes bootstrapping or becomes ready to accept jobs.

stages -> (structure) [required]

The lifecycle stages where you configure scripts to run.

nodeBootstrapped -> (list)

The scripts to run after PCS finishes setting up the compute node and before the Slurm daemon (slurmd ) starts. Use this stage for tasks that must complete before the node accepts jobs, such as mounting shared storage, configuring networking, or installing software packages.

Constraints:

  • min: 1
  • max: 20

(structure)

A script to run during a compute node lifecycle stage.

name -> (string) [required]

A unique name for the script. The name can be up to 64 characters long. Valid characters are letters, numbers, spaces, underscores (_ ), and hyphens (- ). The first character must be a letter or a number.

Constraints:

  • min: 1
  • max: 64
  • pattern: [A-Za-z0-9][A-Za-z0-9 _-]*

scriptSource -> (structure) [required]

The source location and integrity information for the script.

scriptLocation -> (string) [required]

The location of the script. Specify either an Amazon S3 URI in the format s3://bucket-name/key or an HTTPS URL.

Constraints:

  • min: 1
  • max: 1024
  • pattern: (s3://[a-z0-9][a-z0-9.-]{1,61}[a-z0-9]/.+|https://([a-zA-Z0-9](?:[a-zA-Z0-9_-]{0,61}[a-zA-Z0-9])?\.)+[a-zA-Z]{2,63}(?::[0-9]{1,5})?(?:[/?#][^\s]*)?)

s3VersionId -> (string)

The Amazon S3 version ID of the script. Use this value to pin the script to a specific version in a versioned Amazon S3 bucket. This value is only valid when scriptLocation is an Amazon S3 URI.

Constraints:

  • min: 0
  • max: 1024

checksum -> (string)

The SHA-256 checksum of the script content, as a 64-character hexadecimal string. This value is optional. When specified, PCS uses this value to verify the integrity of the downloaded script.

Constraints:

  • min: 64
  • max: 64
  • pattern: [a-fA-F0-9]{64}

arguments -> (list)

The command-line arguments to pass to the script. You can specify up to 20 arguments, and each argument can be up to 256 characters long.

Constraints:

  • min: 0
  • max: 20

(string)

Constraints:

  • min: 0
  • max: 256

onError -> (string)

The behavior when the script fails. The default value is TERMINATE . Valid values:

  • TERMINATE – Terminates the compute node.
  • STOP_SEQUENCE – Stops running subsequent scripts in the sequence but doesn’t terminate the compute node.
  • CONTINUE – Ignores the error and continues running the next script.

Possible values:

  • TERMINATE
  • STOP_SEQUENCE
  • CONTINUE

executionPolicy -> (string)

The policy that determines when the script runs. The default value is FIRST_BOOT_ONLY . Valid values:

  • FIRST_BOOT_ONLY – Runs the script only the first time the compute node boots.
  • EVERY_BOOT – Runs the script every time the compute node boots, including reboots.

Possible values:

  • FIRST_BOOT_ONLY
  • EVERY_BOOT

nodeReady -> (list)

The scripts to run after the Slurm daemon (slurmd ) starts and the compute node registers with the Slurm controller. Use this stage for tasks that require Slurm to be running, such as running Slurm commands.

Constraints:

  • min: 1
  • max: 20

(structure)

A script to run during a compute node lifecycle stage.

name -> (string) [required]

A unique name for the script. The name can be up to 64 characters long. Valid characters are letters, numbers, spaces, underscores (_ ), and hyphens (- ). The first character must be a letter or a number.

Constraints:

  • min: 1
  • max: 64
  • pattern: [A-Za-z0-9][A-Za-z0-9 _-]*

scriptSource -> (structure) [required]

The source location and integrity information for the script.

scriptLocation -> (string) [required]

The location of the script. Specify either an Amazon S3 URI in the format s3://bucket-name/key or an HTTPS URL.

Constraints:

  • min: 1
  • max: 1024
  • pattern: (s3://[a-z0-9][a-z0-9.-]{1,61}[a-z0-9]/.+|https://([a-zA-Z0-9](?:[a-zA-Z0-9_-]{0,61}[a-zA-Z0-9])?\.)+[a-zA-Z]{2,63}(?::[0-9]{1,5})?(?:[/?#][^\s]*)?)

s3VersionId -> (string)

The Amazon S3 version ID of the script. Use this value to pin the script to a specific version in a versioned Amazon S3 bucket. This value is only valid when scriptLocation is an Amazon S3 URI.

Constraints:

  • min: 0
  • max: 1024

checksum -> (string)

The SHA-256 checksum of the script content, as a 64-character hexadecimal string. This value is optional. When specified, PCS uses this value to verify the integrity of the downloaded script.

Constraints:

  • min: 64
  • max: 64
  • pattern: [a-fA-F0-9]{64}

arguments -> (list)

The command-line arguments to pass to the script. You can specify up to 20 arguments, and each argument can be up to 256 characters long.

Constraints:

  • min: 0
  • max: 20

(string)

Constraints:

  • min: 0
  • max: 256

onError -> (string)

The behavior when the script fails. The default value is TERMINATE . Valid values:

  • TERMINATE – Terminates the compute node.
  • STOP_SEQUENCE – Stops running subsequent scripts in the sequence but doesn’t terminate the compute node.
  • CONTINUE – Ignores the error and continues running the next script.

Possible values:

  • TERMINATE
  • STOP_SEQUENCE
  • CONTINUE

executionPolicy -> (string)

The policy that determines when the script runs. The default value is FIRST_BOOT_ONLY . Valid values:

  • FIRST_BOOT_ONLY – Runs the script only the first time the compute node boots.
  • EVERY_BOOT – Runs the script every time the compute node boots, including reboots.

Possible values:

  • FIRST_BOOT_ONLY
  • EVERY_BOOT

scriptCachingPolicy -> (string)

The caching policy for node lifecycle scripts. The default value is CACHE_ONCE . Valid values:

  • CACHE_ONCE – Downloads each script once and reuses it on subsequent boots.
  • REFRESH_ON_REBOOT – Downloads each script on every boot.

Possible values:

  • CACHE_ONCE
  • REFRESH_ON_REBOOT
© Copyright 2026, Amazon Web Services. Created using Sphinx.