interface CfnComputeNodeGroupProps

Language	Type name
.NET	`Amazon.CDK.aws_pcs.CfnComputeNodeGroupProps`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awspcs#CfnComputeNodeGroupProps`
Java	`software.amazon.awscdk.services.pcs.CfnComputeNodeGroupProps`
Python	`aws_cdk.aws_pcs.CfnComputeNodeGroupProps`
TypeScript	`aws-cdk-lib` » `aws_pcs` » `CfnComputeNodeGroupProps`

Properties for defining a CfnComputeNodeGroup.

Example

// 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 cfnComputeNodeGroupProps: pcs.CfnComputeNodeGroupProps = {
  clusterId: 'clusterId',
  customLaunchTemplate: {
    version: 'version',

    // the properties below are optional
    templateId: 'templateId',
  },
  iamInstanceProfileArn: 'iamInstanceProfileArn',
  instanceConfigs: [{
    instanceType: 'instanceType',
  }],
  scalingConfiguration: {
    maxInstanceCount: 123,
    minInstanceCount: 123,
  },
  subnetIds: ['subnetIds'],

  // the properties below are optional
  amiId: 'amiId',
  name: 'name',
  purchaseOption: 'purchaseOption',
  slurmConfiguration: {
    slurmCustomSettings: [{
      parameterName: 'parameterName',
      parameterValue: 'parameterValue',
    }],
  },
  spotOptions: {
    allocationStrategy: 'allocationStrategy',
  },
  tags: {
    tagsKey: 'tags',
  },
};

Properties

Name	Type	Description
clusterId	`string`	The ID of the cluster of the compute node group.
customLaunchTemplate	`IResolvable` `\|` `CustomLaunchTemplateProperty`	An Amazon EC2 launch template AWS PCS uses to launch compute nodes.
iamInstanceProfileArn	`string`	The Amazon Resource Name (ARN) of the IAM instance profile used to pass an IAM role when launching EC2 instances.
instanceConfigs	`IResolvable` `\| (IResolvable` `\|` `InstanceConfigProperty)[]`	A list of EC2 instance configurations that AWS PCS can provision in the compute node group.
scalingConfiguration	`IResolvable` `\|` `ScalingConfigurationProperty`	Specifies the boundaries of the compute node group auto scaling.
subnetIds	`string[]`	The list of subnet IDs where instances are provisioned by the compute node group.
amiId?	`string`	The ID of the Amazon Machine Image (AMI) that AWS PCS uses to launch instances.
name?	`string`	The name that identifies the compute node group.
purchaseOption?	`string`	Specifies how EC2 instances are purchased on your behalf.
slurmConfiguration?	`IResolvable` `\|` `SlurmConfigurationProperty`	Additional options related to the Slurm scheduler.
spotOptions?	`IResolvable` `\|` `SpotOptionsProperty`	Additional configuration when you specify `SPOT` as the `purchaseOption` for the `CreateComputeNodeGroup` API action.
tags?	`{ [string]: string }`	1 or more tags added to the resource.

clusterId

Type: string

The ID of the cluster of the compute node group.

customLaunchTemplate

Type: IResolvable | CustomLaunchTemplateProperty

An Amazon EC2 launch template AWS PCS uses to launch compute nodes.

iamInstanceProfileArn

Type: string

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 in the AWS PCS User Guide .

instanceConfigs

Type: IResolvable | (IResolvable | InstanceConfigProperty)[]

A list of EC2 instance configurations that AWS PCS can provision in the compute node group.

scalingConfiguration

Type: IResolvable | ScalingConfigurationProperty

Specifies the boundaries of the compute node group auto scaling.

subnetIds

Type: string[]

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.

amiId?

Type: string (optional)

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.

name?

Type: string (optional)

The name that identifies the compute node group.

purchaseOption?

Type: string (optional)

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 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 in the AWS PCS User Guide . If you don't provide this option, it defaults to On-Demand.

slurmConfiguration?

Type: IResolvable | SlurmConfigurationProperty (optional)

Additional options related to the Slurm scheduler.

spotOptions?

Type: IResolvable | SpotOptionsProperty (optional)

Additional configuration when you specify SPOT as the purchaseOption for the CreateComputeNodeGroup API action.

tags?

Type: { [string]: string } (optional)

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.