Build section - Amazon ParallelCluster
Build properties
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).

Build section

(Required) Specifies the configuration in which the image will be built.

Build:
  Imds:
    ImdsSupport: string
  InstanceType: string
  SubnetId: string
  ParentImage: string
  Iam:
    InstanceRole: string
    InstanceProfile: string
    CleanupLambdaRole: string
    AdditionalIamPolicies:
      - Policy: string
    PermissionsBoundary: string
  Components:
    - Type: string
      Value: string
  Tags:
    - Key: string
      Value: string
  SecurityGroupIds:
    - string
  UpdateOsPackages:
    Enabled: boolean

Build properties

InstanceType (Required, String)

Specifies the instance type for the instance used to build the image.

SubnetId (Optional, String)

Specifies the ID of an existing subnet in which to provision the instance to build the image. The provided subnet requires internet access.

Warning

pcluster build-image uses the default VPC. If the default VPC has been deleted, perhaps by using Amazon Control Tower or Amazon Landing Zone, then the subnet ID must be specified.

ParentImage (Required, String)

Specifies the base image. The parent image can be either a non Amazon ParallelCluster AMI or an official Amazon ParallelCluster AMI for the same version. You can't use a Amazon ParallelCluster official or custom AMI from a different version of Amazon ParallelCluster. The format must either be the ARN of a image arn:Partition:imagebuilder:Region:Account:image/ImageName/ImageVersion or an AMI ID ami-12345678.

SecurityGroupIds (Optional, [String])

Specifies the list of security group IDs for the image.

Imds

Imds properties

(Optional) Specifies the Amazon EC2 ImageBuilder build and test instance metadata service (IMDS) settings.

Imds:
  ImdsSupport: string
ImdsSupport (Optional, String)

Specifies which IMDS versions are supported in the Amazon EC2 ImageBuilder build and test instances. Supported values are v2.0 and v1.0. The default value is v2.0.

If ImdsSupport is set to v1.0, both IMDSv1 and IMDSv2 are supported.

If ImdsSupport is set to v2.0, only IMDSv2 is supported.

For more information, see Use IMDSv2 in the Amazon EC2 User Guide for Linux instances.

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

Note

Starting with Amazon ParallelCluster version 3.7.0, the ImdsSupport default value is v2.0. We recommend that you set ImdsSupport to v2.0 and replace IMDSv1 with IMDSv2 in your custom actions calls.

Support for Imds / ImdsSupport is added with Amazon ParallelCluster version 3.3.0.

Iam

Iam properties

(Optional) Specifies the IAM resources for the image build.

Iam:
  InstanceRole: string
  InstanceProfile: string
  CleanupLambdaRole: string
  AdditionalIamPolicies:
    - Policy: string
  PermissionsBoundary: string
InstanceProfile (Optional, String)

Specifies an instance profile to override the default instance profile for the EC2 Image Builder instance. InstanceProfile and InstanceRole and AdditionalIamPolicies cannot be specified together. The format is arn:Partition:iam::Account:instance-profile/InstanceProfileName.

InstanceRole (Optional, String)

Specifies an instance role to override the default instance role for the EC2 Image Builder instance. InstanceProfile and InstanceRole and AdditionalIamPolicies cannot be specified together. The format is arn:Partition:iam::Account:role/RoleName.

CleanupLambdaRole (Optional, String)

The ARN of the IAM role to use for the Amazon Lambda function backing the Amazon CloudFormation custom resource that removes build artifacts on build completion. Lambda needs to be configured as the principal allowed to assume the role. The format is arn:Partition:iam::Account:role/RoleName.

AdditionalIamPolicies (Optional)

Specifies additional IAM policies to attach to the EC2 Image Builder instance used to produce the custom AMI.

AdditionalIamPolicies:
  - Policy: string
Policy (Optional, [String])

List of IAM policies. The format is arn:Partition:iam::Account:policy/PolicyName.

PermissionsBoundary (Optional, String)

The ARN of the IAM policy to use as permissions boundary for all roles created by Amazon ParallelCluster. For more information on IAM permissions boundaries please refer to Permissions boundaries for IAM entities in the IAM User Guide. The format is arn:Partition:iam::Account:policy/PolicyName.

Components

Components properties

(Optional) Specifies Amazon EC2 ImageBuilder components to use during the AMI build process in addition to the ones provided by default by Amazon ParallelCluster. Such components can be used to customize the AMI build process. For more information, see Amazon ParallelCluster AMI customization.

Components:
  - Type: string
    Value: string
Type (Optional, String)

Specifies the type of the type-value pair for the component. Type can be arn or script.

Value (Optional, String)

Specifies the value of the type-value pair for the component. When type is arn, this is the ARN of a EC2 Image Builder component. When type is script, this is the https or s3 link pointing to the script to use when creating the EC2 Image Builder component.

Tags

Tags properties

(Optional) Specifies the list of tags to be set in the resources used to build the AMI.

Tags:
  - Key: string
    Value: string
Key (Optional, String)

Defines the name of the tag.

Value (Optional, String)

Defines the value of the tag.

UpdateOsPackages

UpdateOsPackages properties

(Optional) Specifies whether the operating system is updated before installing Amazon ParallelCluster software stack.

UpdateOsPackages:
  Enabled: boolean
Enabled (Optional, Boolean)

If true, the OS is updated and rebooted before installing the Amazon ParallelCluster software. The default is false.

Note

When UpdateOsPackages is enabled, all available OS packages are updated, including the kernel. As a customer, you are responsible for verifying that the update is compatible with the AMI dependencies that aren't included in the update.

For example, suppose you're building an AMI for Amazon ParallelCluster version X.0 that's shipped with kernel version Y.0 and some component version Z.0. Suppose the available update includes updated kernel version Y.1 without updates to component Z.0. Before you enable UpdateOsPackages, it's your responsibility to verify that component Z.0 supports kernel Y.1.