AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1). To view this page for the AWS CLI version 2, click here.

We announced the upcoming end-of-support for the AWS CLI v1. For dates, additional details, and information on how to migrate, please refer to the linked announcement. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ 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 <value>]
[--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>]
[--v2-debug]

Options

--cluster-identifier (string)

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

--bootstrap-id (string)

The client-generated token to allow for retries.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

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

--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.

--v2-debug (boolean)

Enable AWS CLI v2 migration assistance. Prints warnings if the command would face a breaking change after swapping AWS CLI v1 for AWS CLI v2 in the current environment. Prints one warning for each breaking change detected.

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)

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

privateIpAddress -> (string)

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)

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)

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.

(structure)

A script to run during a compute node lifecycle stage.

name -> (string)

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.

scriptSource -> (structure)

The source location and integrity information for the script.

scriptLocation -> (string)

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

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.

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.

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.

(string)

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.

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.

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.

(structure)

A script to run during a compute node lifecycle stage.

name -> (string)

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.

scriptSource -> (structure)

The source location and integrity information for the script.

scriptLocation -> (string)

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

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.

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.

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.

(string)

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.

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.

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.