Package software.amazon.awscdk.services.pcs

Interface CfnComputeNodeGroupProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnComputeNodeGroupProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.113.0 (build fc68b25)",
           date="2025-10-14T12:28:16.572Z")
@Stability(Stable)
public interface CfnComputeNodeGroupProps
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.pcs.*;
 CfnComputeNodeGroupProps cfnComputeNodeGroupProps = CfnComputeNodeGroupProps.builder()
         .clusterId("clusterId")
         .customLaunchTemplate(CustomLaunchTemplateProperty.builder()
                 .version("version")
                 // the properties below are optional
                 .templateId("templateId")
                 .build())
         .iamInstanceProfileArn("iamInstanceProfileArn")
         .instanceConfigs(List.of(InstanceConfigProperty.builder()
                 .instanceType("instanceType")
                 .build()))
         .scalingConfiguration(ScalingConfigurationProperty.builder()
                 .maxInstanceCount(123)
                 .minInstanceCount(123)
                 .build())
         .subnetIds(List.of("subnetIds"))
         // the properties below are optional
         .amiId("amiId")
         .name("name")
         .purchaseOption("purchaseOption")
         .slurmConfiguration(SlurmConfigurationProperty.builder()
                 .slurmCustomSettings(List.of(SlurmCustomSettingProperty.builder()
                         .parameterName("parameterName")
                         .parameterValue("parameterValue")
                         .build()))
                 .build())
         .spotOptions(SpotOptionsProperty.builder()
                 .allocationStrategy("allocationStrategy")
                 .build())
         .tags(Map.of(
                 "tagsKey", "tags"))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pcs-computenodegroup.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnComputeNodeGroupProps.Builder	A builder for CfnComputeNodeGroupProps
static final class	CfnComputeNodeGroupProps.Jsii$Proxy	An implementation for CfnComputeNodeGroupProps

Method Summary

Modifier and Type	Method	Description
static CfnComputeNodeGroupProps.Builder	builder()
default String	getAmiId()	The ID of the Amazon Machine Image (AMI) that AWS PCS uses to launch instances.
String	getClusterId()	The ID of the cluster of the compute node group.
Object	getCustomLaunchTemplate()	An Amazon EC2 launch template AWS PCS uses to launch compute nodes.
String	getIamInstanceProfileArn()	The Amazon Resource Name (ARN) of the IAM instance profile used to pass an IAM role when launching EC2 instances.
Object	getInstanceConfigs()	A list of EC2 instance configurations that AWS PCS can provision in the compute node group.
default String	getName()	The name that identifies the compute node group.
default String	getPurchaseOption()	Specifies how EC2 instances are purchased on your behalf.
Object	getScalingConfiguration()	Specifies the boundaries of the compute node group auto scaling.
default Object	getSlurmConfiguration()	Additional options related to the Slurm scheduler.
default Object	getSpotOptions()	Additional configuration when you specify SPOT as the purchaseOption for the CreateComputeNodeGroup API action.
List<String>	getSubnetIds()	The list of subnet IDs where instances are provisioned by the compute node group.
default Map<String,String>	getTags()	1 or more tags added to the resource.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getClusterId

@Stability(Stable)
@NotNull
String getClusterId()

The ID of the cluster of the compute node group.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pcs-computenodegroup.html#cfn-pcs-computenodegroup-clusterid

getCustomLaunchTemplate

@Stability(Stable)
@NotNull
Object getCustomLaunchTemplate()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pcs-computenodegroup.html#cfn-pcs-computenodegroup-customlaunchtemplate

getIamInstanceProfileArn

@Stability(Stable)
@NotNull
String getIamInstanceProfileArn()

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pcs-computenodegroup.html#cfn-pcs-computenodegroup-iaminstanceprofilearn

getInstanceConfigs

@Stability(Stable)
@NotNull
Object getInstanceConfigs()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pcs-computenodegroup.html#cfn-pcs-computenodegroup-instanceconfigs

getScalingConfiguration

@Stability(Stable)
@NotNull
Object getScalingConfiguration()

Specifies the boundaries of the compute node group auto scaling.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pcs-computenodegroup.html#cfn-pcs-computenodegroup-scalingconfiguration

getSubnetIds

@Stability(Stable)
@NotNull
List<String> getSubnetIds()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pcs-computenodegroup.html#cfn-pcs-computenodegroup-subnetids

getAmiId

@Stability(Stable)
@Nullable
default String getAmiId()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pcs-computenodegroup.html#cfn-pcs-computenodegroup-amiid

getName

@Stability(Stable)
@Nullable
default String getName()

The name that identifies the compute node group.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pcs-computenodegroup.html#cfn-pcs-computenodegroup-name

getPurchaseOption

@Stability(Stable)
@Nullable
default String getPurchaseOption()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pcs-computenodegroup.html#cfn-pcs-computenodegroup-purchaseoption

getSlurmConfiguration

@Stability(Stable)
@Nullable
default Object getSlurmConfiguration()

Additional options related to the Slurm scheduler.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pcs-computenodegroup.html#cfn-pcs-computenodegroup-slurmconfiguration

getSpotOptions

@Stability(Stable)
@Nullable
default Object getSpotOptions()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pcs-computenodegroup.html#cfn-pcs-computenodegroup-spotoptions

getTags

@Stability(Stable)
@Nullable
default Map<String,String> getTags()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pcs-computenodegroup.html#cfn-pcs-computenodegroup-tags

builder

@Stability(Stable)
static CfnComputeNodeGroupProps.Builder builder()

Returns:

a CfnComputeNodeGroupProps.Builder of CfnComputeNodeGroupProps