# CfnComputeNodeGroup

Creates an AWS PCS compute node group resource.

For more information, see [Creating a compute node group in AWS PCS](https://docs.aws.amazon.com/pcs/latest/userguide/working-with_cng_create.html) in the *AWS PCS User Guide* .

Extends: Construct › CfnElement › CfnRefElement › CfnResource › CfnComputeNodeGroup
Implements: IInspectable, ITaggableV2, IEnvironmentAware, IComputeNodeGroupRef, IConstruct, IDependable

- CloudFormation: [`AWS::PCS::ComputeNodeGroup`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-pcs-computenodegroup.html)
- Source: Generated code
- Type last changed: v2.274.0 · 20 Oct 2026

## Example

```ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_pcs as pcs } from 'aws-cdk-lib';
const cfnComputeNodeGroup = new pcs.CfnComputeNodeGroup(this, 'MyCfnComputeNodeGroup', {
  clusterId: 'clusterId',
  iamInstanceProfileArn: 'iamInstanceProfileArn',
  instanceConfigs: [{
    instanceType: 'instanceType',
  }],
  scalingConfiguration: {
    maxInstanceCount: 123,
    minInstanceCount: 123,
  },
  subnetIds: ['subnetIds'],

  // the properties below are optional
  amiId: 'amiId',
  customLaunchTemplate: {
    version: 'version',

    // the properties below are optional
    templateId: 'templateId',
  },
  name: 'name',
  nodeLifecycleActions: {
    stages: {
      nodeBootstrapped: [{
        name: 'name',
        scriptSource: {
          scriptLocation: 'scriptLocation',

          // the properties below are optional
          checksum: 'checksum',
          s3VersionId: 's3VersionId',
        },

        // the properties below are optional
        arguments: ['arguments'],
        executionPolicy: 'executionPolicy',
        onError: 'onError',
      }],
      nodeReady: [{
        name: 'name',
        scriptSource: {
          scriptLocation: 'scriptLocation',

          // the properties below are optional
          checksum: 'checksum',
          s3VersionId: 's3VersionId',
        },

        // the properties below are optional
        arguments: ['arguments'],
        executionPolicy: 'executionPolicy',
        onError: 'onError',
      }],
    },

    // the properties below are optional
    scriptCachingPolicy: 'scriptCachingPolicy',
  },
  purchaseOption: 'purchaseOption',
  slurmConfiguration: {
    gresCustomSettings: [{
      gresCustomSettingsKey: 'gresCustomSettings',
    }],
    scaleDownIdleTimeInSeconds: 123,
    slurmCustomSettings: [{
      parameterName: 'parameterName',
      parameterValue: 'parameterValue',
    }],
  },
  spotOptions: {
    allocationStrategy: 'allocationStrategy',
  },
  tags: {
    tagsKey: 'tags',
  },
});
```

## Initializer

```ts
new CfnComputeNodeGroup(scope: Construct, id: string, props: CfnComputeNodeGroupProps)
```

## Construct Props

- `amiId`: string — The ID of the Amazon Machine Image (AMI) that AWS PCS uses to launch instances.

  If not provided, AWS PCS uses the AMI ID specified in the custom launch template.

- `clusterId`: string (required) — The ID of the cluster of the compute node group.

- `customLaunchTemplate`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnComputeNodeGroup.CustomLaunchTemplateProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_pcs.CfnComputeNodeGroup.CustomLaunchTemplateProperty.html) — An Amazon EC2 launch template AWS PCS uses to launch compute nodes.

- `iamInstanceProfileArn`: string (required) — The Amazon Resource Name (ARN) of the IAM instance profile used to pass an IAM role when launching EC2 instances.

  The role contained in your instance profile must have the `pcs:RegisterComputeNodeGroupInstance` permission and the role name must start with `AWSPCS` or must have the path `/aws-pcs/` . For more information, see [IAM instance profiles for AWS PCS](https://docs.aws.amazon.com//pcs/latest/userguide/security-instance-profiles.html) in the *AWS PCS User Guide* .

- `instanceConfigs`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnComputeNodeGroup.InstanceConfigProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_pcs.CfnComputeNodeGroup.InstanceConfigProperty.html)[] (required) — A list of EC2 instance configurations that AWS PCS can provision in the compute node group.

- `name`: string — The name that identifies the compute node group.

- `nodeLifecycleActions`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnComputeNodeGroup.NodeLifecycleActionsProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_pcs.CfnComputeNodeGroup.NodeLifecycleActionsProperty.html) — Custom scripts that run at defined points in a compute node's lifecycle.

- `purchaseOption`: string — Specifies how EC2 instances are purchased on your behalf.

  AWS PCS supports On-Demand Instances, Spot Instances, and Amazon EC2 Capacity Blocks for ML. For more information, see [Amazon EC2 billing and purchasing options](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-purchasing-options.html) in the *Amazon Elastic Compute Cloud User Guide* . For more information about AWS PCS support for Capacity Blocks, see [Using Amazon EC2 Capacity Blocks for ML with AWS PCS](https://docs.aws.amazon.com/pcs/latest/userguide/capacity-blocks.html) in the *AWS PCS User Guide* . If you don't provide this option, it defaults to On-Demand.

- `scalingConfiguration`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnComputeNodeGroup.ScalingConfigurationProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_pcs.CfnComputeNodeGroup.ScalingConfigurationProperty.html) (required) — Specifies the boundaries of the compute node group auto scaling.

- `slurmConfiguration`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnComputeNodeGroup.SlurmConfigurationProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_pcs.CfnComputeNodeGroup.SlurmConfigurationProperty.html) — Additional options related to the Slurm scheduler.

- `spotOptions`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnComputeNodeGroup.SpotOptionsProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_pcs.CfnComputeNodeGroup.SpotOptionsProperty.html) — Additional configuration when you specify `SPOT` as the `purchaseOption` for the `CreateComputeNodeGroup` API action.

- `subnetIds`: string[] (required) — The list of subnet IDs where instances are provisioned by the compute node group.

  The subnets must be in the same VPC as the cluster.

- `tags`: { [key: string]: string } — 1 or more tags added to the resource.

  Each tag consists of a tag key and tag value. The tag value is optional and can be an empty string.

## Properties

- `amiId`: string — The ID of the Amazon Machine Image (AMI) that AWS PCS uses to launch instances.

- `attrArn`: string (required) — The unique Amazon Resource Name (ARN) of the compute node group.

- `attrErrorInfo`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) (required) — The list of errors that occurred during compute node group provisioning.

- `attrId`: string (required) — The generated unique ID of the compute node group.

- `attrStatus`: string (required) — The provisioning status of the compute node group.

  > The provisioning status doesn't indicate the overall health of the compute node group. > The resource enters the `SUSPENDING` and `SUSPENDED` states when the scheduler is beyond end of life and we have suspended the cluster. When in these states, you can't use the cluster. The cluster controller is down and all compute instances are terminated. The resources still count toward your service quotas. You can delete a resource if its status is `SUSPENDED` . For more information, see [Frequently asked questions about Slurm versions in AWS PCS](https://docs.aws.amazon.com//pcs/latest/userguide/slurm-versions_faq.html) in the *AWS PCS User Guide* .

- `cdkTagManager`: [TagManager](/cdk/api/v2/docs/aws-cdk-lib.TagManager.html) (required) — Tag Manager which manages the tags for this resource.

- `CFN_RESOURCE_TYPE_NAME`: string (required) (static) — The CloudFormation resource type name for this resource class.

- `cfnOptions`: [ICfnResourceOptions](/cdk/api/v2/docs/aws-cdk-lib.ICfnResourceOptions.html) (required) — Options for this resource, such as condition, update policy etc.

- `cfnResourceType`: string (required) — AWS resource type.

- `clusterId`: string (required) — The ID of the cluster of the compute node group.

- `computeNodeGroupRef`: [ComputeNodeGroupReference](/cdk/api/v2/docs/aws-cdk-lib.interfaces.aws_pcs.ComputeNodeGroupReference.html) (required) — A reference to a ComputeNodeGroup resource.

- `creationStack`: string[] (required)

- `customLaunchTemplate`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnComputeNodeGroup.CustomLaunchTemplateProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_pcs.CfnComputeNodeGroup.CustomLaunchTemplateProperty.html) — An Amazon EC2 launch template AWS PCS uses to launch compute nodes.

- `env`: [ResourceEnvironment](/cdk/api/v2/docs/aws-cdk-lib.interfaces.ResourceEnvironment.html) (required)

- `iamInstanceProfileArn`: string (required) — The Amazon Resource Name (ARN) of the IAM instance profile used to pass an IAM role when launching EC2 instances.

- `instanceConfigs`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnComputeNodeGroup.InstanceConfigProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_pcs.CfnComputeNodeGroup.InstanceConfigProperty.html)[] (required) — A list of EC2 instance configurations that AWS PCS can provision in the compute node group.

- `logicalId`: string (required) — The logical ID for this CloudFormation stack element.

  The logical ID of the element
  is calculated from the path of the resource node in the construct tree.

  To override this value, use `overrideLogicalId(newLogicalId)`.

- `name`: string — The name that identifies the compute node group.

- `node`: [Node](/cdk/api/v2/docs/constructs.Node.html) (required) — The tree node.

- `nodeLifecycleActions`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnComputeNodeGroup.NodeLifecycleActionsProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_pcs.CfnComputeNodeGroup.NodeLifecycleActionsProperty.html) — Custom scripts that run at defined points in a compute node's lifecycle.

- `purchaseOption`: string — Specifies how EC2 instances are purchased on your behalf.

- `ref`: string (required) — Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.

  If, by any chance, the intrinsic reference of a resource is not a string, you could
  coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`.

- `scalingConfiguration`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnComputeNodeGroup.ScalingConfigurationProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_pcs.CfnComputeNodeGroup.ScalingConfigurationProperty.html) (required) — Specifies the boundaries of the compute node group auto scaling.

- `slurmConfiguration`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnComputeNodeGroup.SlurmConfigurationProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_pcs.CfnComputeNodeGroup.SlurmConfigurationProperty.html) — Additional options related to the Slurm scheduler.

- `spotOptions`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnComputeNodeGroup.SpotOptionsProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_pcs.CfnComputeNodeGroup.SpotOptionsProperty.html) — Additional configuration when you specify `SPOT` as the `purchaseOption` for the `CreateComputeNodeGroup` API action.

- `stack`: [Stack](/cdk/api/v2/docs/aws-cdk-lib.Stack.html) (required) — The stack in which this element is defined.

  CfnElements must be defined within a stack scope (directly or indirectly).

- `subnetIds`: string[] (required) — The list of subnet IDs where instances are provisioned by the compute node group.

- `tags`: { [key: string]: string } — 1 or more tags added to the resource.

## Methods

- `addDeletionOverride(path: string): void` — Syntactic sugar for `addOverride(path, undefined)`.

  **Parameters**

  - `path` — The path of the value to delete.

- `addDependency(target: CfnResource): void` — Use `addResourceDependency` instead.

  This method has been renamed to `addResourceDependency` to more clearly
  set it apart from `construct.node.addDependency`. See the documentation
  of that function for more details.

- `addDependsOn(target: CfnResource): void` — Use `addResourceDependency` instead.

  This can be used for resources across stacks (or nested stack) boundaries
  and the dependency will automatically be transferred to the relevant scope.

  This method has been renamed to `addResourceDependency`, which makes it
  more clear that this method operates at a different level from the
  construct-level `construct.node.addDependency()` mechanism.

- `addMetadata(key: string, value: any): void` — Add a value to the CloudFormation Resource Metadata.

- `addOverride(path: string, value: any): void` — Adds an override to the synthesized CloudFormation resource.

  To add a
  property override, either use `addPropertyOverride` or prefix `path` with
  "Properties." (i.e. `Properties.TopicName`).

  If the override is nested, separate each nested level using a dot (.) in the path parameter.
  If there is an array as part of the nesting, specify the index in the path.

  To include a literal `.` in the property name, prefix with a `\`. In most
  programming languages you will need to write this as `"\\."` because the
  `\` itself will need to be escaped.

  For example,
  ```typescript
  cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
  cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
  ```
  would add the overrides
  ```json
  "Properties": {
    "GlobalSecondaryIndexes": [
      {
        "Projection": {
          "NonKeyAttributes": [ "myattribute" ]
          ...
        }
        ...
      },
      {
        "ProjectionType": "INCLUDE"
        ...
      },
    ]
    ...
  }
  ```

  The `value` argument to `addOverride` will not be processed or translated
  in any way. Pass raw JSON values in here with the correct capitalization
  for CloudFormation. If you pass CDK classes or structs, they will be
  rendered with lowercased key names, and CloudFormation will reject the
  template.

  **Parameters**

  - `path` — - The path of the property, you can use dot notation to override values in complex types.
  - `value` — - The value.

- `addPropertyDeletionOverride(propertyPath: string): void` — Adds an override that deletes the value of a property from the resource definition.

  **Parameters**

  - `propertyPath` — The path to the property.

- `addPropertyOverride(propertyPath: string, value: any): void` — Adds an override to a resource property.

  Syntactic sugar for `addOverride("Properties.<...>", value)`.

  **Parameters**

  - `propertyPath` — The path of the property.
  - `value` — The value.

- `addResourceDependency(target: CfnResource, reason?: string): void` — Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

  This can be used for resources across stacks (or nested stack) boundaries
  and the dependency will automatically be transferred to the relevant scope.

  This method only adds dependencies between L1 resources. If you are
  looking for a generic construct-to-construct dependency mechanism that works
  for all constructs including L2s, use `construct.node.addDependency` instead.

- `applyCrossStackReferenceStrength(strength: ReferenceStrength): void` — Sets the cross-stack reference strength for this resource.

  When set, any cross-stack reference to this resource will use the specified
  strength instead of the global default from the consuming stack's context.

  **Parameters**

  - `strength` — - The reference strength to use for this resource.

- `applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void` — Sets the deletion policy of the resource based on the removal policy specified.

  The Removal Policy controls what happens to this resource when it stops
  being managed by CloudFormation, either because you've removed it from the
  CDK application or because you've made a change that requires the resource
  to be replaced.

  The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
  account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some
  cases, a snapshot can be taken of the resource prior to deletion
  (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy
  can be found in the following link:

- `arnForComputeNodeGroup(resource: IComputeNodeGroupRef): string` (static)

- `cfnPropertyName(cdkPropertyName: string): string`

- `getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference` — Returns a token for an runtime attribute of this resource.

  Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility
  in case there is no generated attribute.

  **Parameters**

  - `attributeName` — The name of the attribute.

- `getMetadata(key: string): any` — Retrieve a value value from the CloudFormation Resource Metadata.

- `inspect(inspector: TreeInspector): void` — Examines the CloudFormation resource and discloses attributes.

  **Parameters**

  - `inspector` — tree inspector to collect and process attributes.

- `isCfnComputeNodeGroup(x: any): boolean` (static) — Checks whether the given object is a CfnComputeNodeGroup.

- `isCfnElement(x: any): boolean` (static) — Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

  Uses duck-typing instead of `instanceof` to allow stack elements from different
  versions of this library to be included in the same stack.

  **Returns:** The construct as a stack element or undefined if it is not a stack element.

- `isCfnResource(x: any): boolean` (static) — Check whether the given object is a CfnResource.

- `isConstruct(x: any): boolean` (static) — Checks if `x` is a construct.

  Use this method instead of `instanceof` to properly detect `Construct`
  instances, even when the construct library is symlinked.

  Explanation: in JavaScript, multiple copies of the `constructs` library on
  disk are seen as independent, completely different libraries. As a
  consequence, the class `Construct` in each copy of the `constructs` library
  is seen as a different class, and an instance of one class will not test as
  `instanceof` the other class. `npm install` will not create installations
  like this, but users may manually symlink construct libraries together or
  use a monorepo tool: in those cases, multiple copies of the `constructs`
  library can be accidentally installed, and `instanceof` will behave
  unpredictably. It is safest to avoid using `instanceof`, and using
  this type-testing method instead.

  **Parameters**

  - `x` — Any object.

  **Returns:** true if `x` is an object created from a class which extends `Construct`.

- `obtainDependencies(): Stack | CfnResource[]` — Retrieves an array of resources and stacks this resource depends on.

  For resources depended on directly, returns the `CfnResource` object. For
  dependencies on other stacks, returns the `Stack` object. The order of the
  array is not guaranteed.

- `overrideLogicalId(newLogicalId: string): void` — Overrides the auto-generated logical ID with a specific ID.

  **Parameters**

  - `newLogicalId` — The new logical ID to use for this stack element.

- `removeDependency(target: CfnResource): void` — Use `removeResourceDependency` instead

  This can be used for resources across stacks (including nested stacks)
  and the dependency will automatically be removed from the relevant scope.

- `removeResourceDependency(target: CfnResource): void` — Indicates that this resource no longer depends on another resource.

  This can be used for resources across stacks (including nested stacks)
  and the dependency will automatically be removed from the relevant scope.

- `replaceDependency(target: CfnResource, newTarget: CfnResource): void` — Replaces one dependency with another.

  **Parameters**

  - `target` — The dependency to replace.
  - `newTarget` — The new dependency to add.

- `toString(): string` — Returns a string representation of this construct.

  **Returns:** a string representation of this resource

- `with(...mixins: IMixin[]): IConstruct` — Applies one or more mixins to this construct.

  Mixins are applied in order. The list of constructs is captured at the
  start of the call, so constructs added by a mixin will not be visited.
  Use multiple `with()` calls if subsequent mixins should apply to added
  constructs.