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

[ebs] section

Defines Amazon EBS volume configuration settings for volumes that are mounted on the head node and shared to the compute nodes through NFS.

To learn how to include Amazon EBS volumes in your cluster definition, see [cluster] section / ebs_settings.

To use an existing Amazon EBS volume for long-term permanent storage that's independent of the cluster life cycle, specify ebs_volume_id.

If you don't specify ebs_volume_id, Amazon ParallelCluster creates the EBS volume from the [ebs] settings when it creates the cluster and deletes the volume and data when the cluster is deleted.

For more information, see Best practices: moving a cluster to a new Amazon ParallelCluster minor or patch version.

The format is [ebs ebs-name]. ebs-name must start with a letter, contain no more than 30 characters, and only contain letters, numbers, hyphens (-), and underscores (_).

[ebs custom1]
shared_dir = vol1
ebs_snapshot_id = snap-xxxxx
volume_type = io1
volume_iops = 200
...

[ebs custom2]
shared_dir = vol2
...

...

shared_dir

(Required) Specifies the path where the shared Amazon EBS volume is mounted.

This parameter is required when using multiple Amazon EBS volumes.

When you use one Amazon EBS volume, this option overwrites the shared_dir that's specified under the [cluster] section. In the following example, the volume mounts to /vol1.

shared_dir = vol1

Update policy: If this setting is changed, the update is not allowed.

ebs_kms_key_id

(Optional) Specifies a custom Amazon KMS key to use for encryption.

This parameter must be used together with encrypted = true. It also must have a custom ec2_iam_role.

For more information, see Disk encryption with a custom KMS Key.

ebs_kms_key_id = xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

Update policy: If this setting is changed, the update is not allowed.

ebs_snapshot_id

(Optional) Defines the Amazon EBS snapshot ID if you're using a snapshot as the source for the volume.

There is no default value.

ebs_snapshot_id = snap-xxxxx

Update policy: If this setting is changed, the update is not allowed.

ebs_volume_id

(Optional) Defines the volume ID of an existing Amazon EBS volume to attach to the head node.

There is no default value.

ebs_volume_id = vol-xxxxxx

Update policy: If this setting is changed, the update is not allowed.

encrypted

(Optional) Specifies whether the Amazon EBS volume is encrypted. Note: Do not use with snapshots.

The default value is false.

encrypted = false

Update policy: If this setting is changed, the update is not allowed.

volume_iops

(Optional) Defines the number of IOPS for io1, io2, and gp3 type volumes.

The default value, supported values, and volume_iops to volume_size ratio varies by volume_type and volume_size.

volume_iops = 200

Update policy: This setting can be changed during an update.

† Maximum IOPS is guaranteed only on Instances built on the Nitro System provisioned with more than 32,000 IOPS. Other instances guarantee up to 32,000 IOPS. Unless you modify the volume, earlier io1 volumes might not reach full performance. io2 Block Express volumes support volume_iops values up to 256,000. For more information, see io2 Block Express volumes (In preview) in the Amazon EC2 User Guide.

volume_size

(Optional) Specifies the size of the volume to be created, in GiB (if you're not using a snapshot).

The default value and supported values varies by volume_type.

volume_size = 20

Update policy: If this setting is changed, the update is not allowed.

volume_throughput

(Optional) Defines the throughput for gp3 volume types, in MiB/s.

The default value is 125.

Supported values volume_throughput = 125–1000 MiB/s

The ratio of volume_throughput to volume_iops can be no more than 0.25. The maximum throughput of 1000 MiB/s requires that the volume_iops setting is at least 4000.

volume_throughput = 1000

Update policy: If this setting is changed, the update is not allowed.

volume_type

(Optional) Specifies the Amazon EBS volume type of the volume that you want to launch.

Valid options are the following volume types:

For more information, see Amazon EBS volume types in the Amazon EC2 User Guide.

The default value is gp2.

volume_type = io2

Update policy: If this setting is changed, the update is not allowed.