pcluster update-cluster - Amazon ParallelCluster
Named arguments
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

pcluster update-cluster

Updates an existing cluster to match the settings of a specified configuration file.

pcluster update-cluster [-h] 
                 --cluster-configuration CLUSTER_CONFIGURATION
                 --cluster-name CLUSTER_NAME
                [--debug]
                [--dryrun DRYRUN]
                [--force-update FORCE_UPDATE]
                [--query QUERY]
                [--region REGION]
                [--suppress-validators SUPPRESS_VALIDATORS [SUPPRESS_VALIDATORS ...]]
                [--validation-failure-level {INFO,WARNING,ERROR}]

Named arguments

-h, --help

Shows the help text for pcluster update-cluster.

--cluster-configuration, -c CLUSTER_CONFIGURATION

Specifies the YAML cluster configuration file.

--cluster-name, -n CLUSTER_NAME

Specifies the name of the cluster.

--debug

Enables debug logging.

--dryrun DRYRUN

When true, performs the validation without updating the cluster and creating any resources. It can be used to validate the image configuration and update requirements. (Defaults to false.)

--force-update FORCE_UPDATE

When true, forces the update by ignoring the update validation errors. (Defaults to false.)

--query QUERY

Specifies the JMESPath query to perform on the output.

--region, -r REGION

Specifies the Amazon Web Services Region to use. The Amazon Web Services Region must be specified, using the Region setting in the cluster configuration file, the AWS_DEFAULT_REGION environment variable, the region setting in the [default] section of the ~/.aws/config file, or the --region parameter.

--suppress-validators SUPPRESS_VALIDATORS [SUPPRESS_VALIDATORS ...]

Identifies one or more config validators to suppress.

Format: (ALL|type:[A-Za-z0-9]+)

--validation-failure-level {INFO,WARNING,ERROR}

Specifies the level of validation failures reported for update.

Example using Amazon ParallelCluster version 3.1.4:

$ pcluster update-cluster -c cluster-config.yaml -n cluster-v3 -r us-east-1
{
  "cluster": {
    "clusterName": "cluster-v3",
    "cloudformationStackStatus": "UPDATE_IN_PROGRESS",
    "cloudformationStackArn": "arn:aws:cloudformation:us-east-1:123456789012:stack/cluster-v3/1234abcd-56ef-78gh-90ij-abcd1234efgh",
    "region": "us-east-1",
    "version": "3.1.4",
    "clusterStatus": "UPDATE_IN_PROGRESS"
  },
  "changeSet": [
    {
      "parameter": "HeadNode.Iam.S3Access",
      "requestedValue": {
        "BucketName": "pc-beta-test",
        "KeyName": "output",
        "EnableWriteAccess": false
      }
    },
    {
      "parameter": "HeadNode.Iam.S3Access",
      "currentValue": {
        "BucketName": "pcluster-east-test-bucket",
        "KeyName": "logs",
        "EnableWriteAccess": true
      }
    }
  ]
}