View a markdown version of this page

pcluster create - AWS ParallelCluster
Positional argumentsNamed arguments

This documentation references AWS ParallelCluster. For running HPC and AI workloads, we recommend AWS Parallel Computing Service (AWS PCS), our managed Slurm service that lets you focus on running your workloads rather than managing infrastructure.

pcluster create

Creates a new cluster.

pcluster create [ -h ] [ -c CONFIG_FILE ] [ -r REGION ] [ -nw ] [ -nr ]
                [ -u TEMPLATE_URL ] [ -t CLUSTER_TEMPLATE ]
                [ -p EXTRA_PARAMETERS ] [ -g TAGS ]
                cluster_name

Positional arguments

cluster_name

Defines the name of the cluster. The AWS CloudFormation stack name is parallelcluster-cluster_name.

Named arguments

-h, --help

Shows the help text for pcluster create.

-c CONFIG_FILE, --config CONFIG_FILE

Specifies the alternative configuration file to use.

Defaults to ~/.parallelcluster/config.

-r REGION, --region REGION

Specifies the AWS Region to use. The priority order used to select the AWS Region for a new cluster is as follows:

  1. -r or --region parameter to pcluster create.

  2. AWS_DEFAULT_REGION environment variable.

  3. aws_region_name setting in [aws] section of AWS ParallelCluster config file (default location is ~/.parallelcluster/config.) This is the location updated by the pcluster configure command.

  4. region setting in [default] section of AWS CLI config file (~/.aws/config.)

-nw, --nowait

Indicates not to wait for stack events after running a stack command.

Defaults to False.

-nr, --norollback

Disables stack rollback on error.

Defaults to False.

-u TEMPLATE_URL, --template-url TEMPLATE_URL

Specifies a URL for the custom AWS CloudFormation template if it was used when created.

-t CLUSTER_TEMPLATE, --cluster-template CLUSTER_TEMPLATE

Indicates the cluster template to use.

-p EXTRA_PARAMETERS, --extra-parameters EXTRA_PARAMETERS

Adds extra parameters to stack create.

-g TAGS, --tags TAGS

Specifies additional tags to add to the stack.

When the command is called and begins polling for the status of that call, it's safe to use "Ctrl-C" to exit. You can return to viewing the current status by calling pcluster status mycluster.

Examples using AWS ParallelCluster version 2.11.7:

$ pcluster create mycluster
    Beginning cluster creation for cluster: mycluster
Info: There is a newer version 3.1.4 of AWS ParallelCluster available.
Creating stack named: parallelcluster-mycluster
Status: ComputeFleetHITSubstack - CREATE_IN_PROGRESS
$ pcluster create mycluster --tags '{ "Key1" : "Value1" , "Key2" : "Value2" }'