Package software.amazon.awscdk.cfnpropertymixins.services.pcs

Interface CfnComputeNodeGroupMixinProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnComputeNodeGroupMixinProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:20:02.215Z")
@Stability(Stable)
public interface CfnComputeNodeGroupMixinProps
extends software.amazon.jsii.JsiiSerializable

Properties for CfnComputeNodeGroupPropsMixin.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.pcs.*;
 CfnComputeNodeGroupMixinProps cfnComputeNodeGroupMixinProps = CfnComputeNodeGroupMixinProps.builder()
         .amiId("amiId")
         .clusterId("clusterId")
         .customLaunchTemplate(CustomLaunchTemplateProperty.builder()
                 .templateId("templateId")
                 .version("version")
                 .build())
         .iamInstanceProfileArn("iamInstanceProfileArn")
         .instanceConfigs(List.of(InstanceConfigProperty.builder()
                 .instanceType("instanceType")
                 .build()))
         .name("name")
         .purchaseOption("purchaseOption")
         .scalingConfiguration(ScalingConfigurationProperty.builder()
                 .maxInstanceCount(123)
                 .minInstanceCount(123)
                 .build())
         .slurmConfiguration(SlurmConfigurationProperty.builder()
                 .slurmCustomSettings(List.of(SlurmCustomSettingProperty.builder()
                         .parameterName("parameterName")
                         .parameterValue("parameterValue")
                         .build()))
                 .build())
         .spotOptions(SpotOptionsProperty.builder()
                 .allocationStrategy("allocationStrategy")
                 .build())
         .subnetIds(List.of("subnetIds"))
         .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	CfnComputeNodeGroupMixinProps.Builder	A builder for CfnComputeNodeGroupMixinProps
static final class	CfnComputeNodeGroupMixinProps.Jsii$Proxy	An implementation for CfnComputeNodeGroupMixinProps

Method Summary

Modifier and Type	Method	Description
static CfnComputeNodeGroupMixinProps.Builder	builder()
default String	getAmiId()	The ID of the Amazon Machine Image (AMI) that AWS PCS uses to launch instances.
default String	getClusterId()	The ID of the cluster of the compute node group.
default Object	getCustomLaunchTemplate()	An Amazon EC2 launch template AWS PCS uses to launch compute nodes.
default String	getIamInstanceProfileArn()	The Amazon Resource Name (ARN) of the IAM instance profile used to pass an IAM role when launching EC2 instances.
default 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.
default 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.
default 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

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

getClusterId

@Stability(Stable)
@Nullable
default 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)
@Nullable
default Object getCustomLaunchTemplate()

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

Returns union: either IResolvable or CfnComputeNodeGroupPropsMixin.CustomLaunchTemplateProperty

See Also:

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

getIamInstanceProfileArn

@Stability(Stable)
@Nullable
default 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)
@Nullable
default Object getInstanceConfigs()

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

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnComputeNodeGroupPropsMixin.InstanceConfigProperty>

See Also:

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

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

getScalingConfiguration

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

Specifies the boundaries of the compute node group auto scaling.

Returns union: either IResolvable or CfnComputeNodeGroupPropsMixin.ScalingConfigurationProperty

See Also:

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

getSlurmConfiguration

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

Additional options related to the Slurm scheduler.

Returns union: either IResolvable or CfnComputeNodeGroupPropsMixin.SlurmConfigurationProperty

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.

Returns union: either IResolvable or CfnComputeNodeGroupPropsMixin.SpotOptionsProperty

See Also:

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

getSubnetIds

@Stability(Stable)
@Nullable
default 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

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 CfnComputeNodeGroupMixinProps.Builder builder()

Returns:

a CfnComputeNodeGroupMixinProps.Builder of CfnComputeNodeGroupMixinProps