Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. pcs
  5. getComputeNodeGroup

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.pcs.getComputeNodeGroup

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

AWS::PCS::ComputeNodeGroup resource creates an AWS PCS compute node group.

Using getComputeNodeGroup

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getComputeNodeGroup(args: GetComputeNodeGroupArgs, opts?: InvokeOptions): Promise<GetComputeNodeGroupResult>
function getComputeNodeGroupOutput(args: GetComputeNodeGroupOutputArgs, opts?: InvokeOptions): Output<GetComputeNodeGroupResult>
Copy
def get_compute_node_group(arn: Optional[str] = None,
                           opts: Optional[InvokeOptions] = None) -> GetComputeNodeGroupResult
def get_compute_node_group_output(arn: Optional[pulumi.Input[str]] = None,
                           opts: Optional[InvokeOptions] = None) -> Output[GetComputeNodeGroupResult]
Copy
func LookupComputeNodeGroup(ctx *Context, args *LookupComputeNodeGroupArgs, opts ...InvokeOption) (*LookupComputeNodeGroupResult, error)
func LookupComputeNodeGroupOutput(ctx *Context, args *LookupComputeNodeGroupOutputArgs, opts ...InvokeOption) LookupComputeNodeGroupResultOutput
Copy

> Note: This function is named LookupComputeNodeGroup in the Go SDK.

public static class GetComputeNodeGroup 
{
    public static Task<GetComputeNodeGroupResult> InvokeAsync(GetComputeNodeGroupArgs args, InvokeOptions? opts = null)
    public static Output<GetComputeNodeGroupResult> Invoke(GetComputeNodeGroupInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetComputeNodeGroupResult> getComputeNodeGroup(GetComputeNodeGroupArgs args, InvokeOptions options)
public static Output<GetComputeNodeGroupResult> getComputeNodeGroup(GetComputeNodeGroupArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: aws-native:pcs:getComputeNodeGroup
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Arn This property is required. string
The unique Amazon Resource Name (ARN) of the compute node group.
Arn This property is required. string
The unique Amazon Resource Name (ARN) of the compute node group.
arn This property is required. String
The unique Amazon Resource Name (ARN) of the compute node group.
arn This property is required. string
The unique Amazon Resource Name (ARN) of the compute node group.
arn This property is required. str
The unique Amazon Resource Name (ARN) of the compute node group.
arn This property is required. String
The unique Amazon Resource Name (ARN) of the compute node group.

getComputeNodeGroup Result

The following output properties are available:

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.
Arn string
The unique Amazon Resource Name (ARN) of the compute node group.
CustomLaunchTemplate Pulumi.AwsNative.Pcs.Outputs.CustomLaunchTemplateProperties
An Amazon EC2 launch template AWS PCS uses to launch compute nodes.
ErrorInfo List<Pulumi.AwsNative.Pcs.Outputs.ComputeNodeGroupErrorInfo>
The list of errors that occurred during compute node group provisioning.
IamInstanceProfileArn 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 pcs:RegisterComputeNodeGroupInstance permissions attached to provision instances correctly.
Id string
The generated unique ID of the compute node group.
PurchaseOption Pulumi.AwsNative.Pcs.ComputeNodeGroupPurchaseOption
Specifies how EC2 instances are purchased on your behalf. AWS PCS supports On-Demand and Spot instances. For more information, see Instance purchasing options in the Amazon Elastic Compute Cloud User Guide. If you don't provide this option, it defaults to On-Demand.
ScalingConfiguration Pulumi.AwsNative.Pcs.Outputs.ScalingConfigurationProperties
Specifies the boundaries of the compute node group auto scaling.
SlurmConfiguration Pulumi.AwsNative.Pcs.Outputs.SlurmConfigurationProperties
Additional options related to the Slurm scheduler.
SpotOptions Pulumi.AwsNative.Pcs.Outputs.SpotOptionsProperties
Additional configuration when you specify SPOT as the purchase option.
Status Pulumi.AwsNative.Pcs.ComputeNodeGroupStatus
The provisioning status of the compute node group. The provisioning status doesn't indicate the overall health of the compute node group.
SubnetIds List<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.
Tags Dictionary<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.
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.
Arn string
The unique Amazon Resource Name (ARN) of the compute node group.
CustomLaunchTemplate CustomLaunchTemplateProperties
An Amazon EC2 launch template AWS PCS uses to launch compute nodes.
ErrorInfo []ComputeNodeGroupErrorInfo
The list of errors that occurred during compute node group provisioning.
IamInstanceProfileArn 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 pcs:RegisterComputeNodeGroupInstance permissions attached to provision instances correctly.
Id string
The generated unique ID of the compute node group.
PurchaseOption ComputeNodeGroupPurchaseOption
Specifies how EC2 instances are purchased on your behalf. AWS PCS supports On-Demand and Spot instances. For more information, see Instance purchasing options in the Amazon Elastic Compute Cloud User Guide. If you don't provide this option, it defaults to On-Demand.
ScalingConfiguration ScalingConfigurationProperties
Specifies the boundaries of the compute node group auto scaling.
SlurmConfiguration SlurmConfigurationProperties
Additional options related to the Slurm scheduler.
SpotOptions SpotOptionsProperties
Additional configuration when you specify SPOT as the purchase option.
Status ComputeNodeGroupStatus
The provisioning status of the compute node group. The provisioning status doesn't indicate the overall health of the compute node group.
SubnetIds []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.
Tags map[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.
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.
arn String
The unique Amazon Resource Name (ARN) of the compute node group.
customLaunchTemplate CustomLaunchTemplateProperties
An Amazon EC2 launch template AWS PCS uses to launch compute nodes.
errorInfo List<ComputeNodeGroupErrorInfo>
The list of errors that occurred during compute node group provisioning.
iamInstanceProfileArn 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 pcs:RegisterComputeNodeGroupInstance permissions attached to provision instances correctly.
id String
The generated unique ID of the compute node group.
purchaseOption ComputeNodeGroupPurchaseOption
Specifies how EC2 instances are purchased on your behalf. AWS PCS supports On-Demand and Spot instances. For more information, see Instance purchasing options in the Amazon Elastic Compute Cloud User Guide. If you don't provide this option, it defaults to On-Demand.
scalingConfiguration ScalingConfigurationProperties
Specifies the boundaries of the compute node group auto scaling.
slurmConfiguration SlurmConfigurationProperties
Additional options related to the Slurm scheduler.
spotOptions SpotOptionsProperties
Additional configuration when you specify SPOT as the purchase option.
status ComputeNodeGroupStatus
The provisioning status of the compute node group. The provisioning status doesn't indicate the overall health of the compute node group.
subnetIds List<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.
tags Map<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.
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.
arn string
The unique Amazon Resource Name (ARN) of the compute node group.
customLaunchTemplate CustomLaunchTemplateProperties
An Amazon EC2 launch template AWS PCS uses to launch compute nodes.
errorInfo ComputeNodeGroupErrorInfo[]
The list of errors that occurred during compute node group provisioning.
iamInstanceProfileArn 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 pcs:RegisterComputeNodeGroupInstance permissions attached to provision instances correctly.
id string
The generated unique ID of the compute node group.
purchaseOption ComputeNodeGroupPurchaseOption
Specifies how EC2 instances are purchased on your behalf. AWS PCS supports On-Demand and Spot instances. For more information, see Instance purchasing options in the Amazon Elastic Compute Cloud User Guide. If you don't provide this option, it defaults to On-Demand.
scalingConfiguration ScalingConfigurationProperties
Specifies the boundaries of the compute node group auto scaling.
slurmConfiguration SlurmConfigurationProperties
Additional options related to the Slurm scheduler.
spotOptions SpotOptionsProperties
Additional configuration when you specify SPOT as the purchase option.
status ComputeNodeGroupStatus
The provisioning status of the compute node group. The provisioning status doesn't indicate the overall health of the compute node group.
subnetIds 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.
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.
ami_id str
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.
arn str
The unique Amazon Resource Name (ARN) of the compute node group.
custom_launch_template CustomLaunchTemplateProperties
An Amazon EC2 launch template AWS PCS uses to launch compute nodes.
error_info Sequence[ComputeNodeGroupErrorInfo]
The list of errors that occurred during compute node group provisioning.
iam_instance_profile_arn str
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 pcs:RegisterComputeNodeGroupInstance permissions attached to provision instances correctly.
id str
The generated unique ID of the compute node group.
purchase_option ComputeNodeGroupPurchaseOption
Specifies how EC2 instances are purchased on your behalf. AWS PCS supports On-Demand and Spot instances. For more information, see Instance purchasing options in the Amazon Elastic Compute Cloud User Guide. If you don't provide this option, it defaults to On-Demand.
scaling_configuration ScalingConfigurationProperties
Specifies the boundaries of the compute node group auto scaling.
slurm_configuration SlurmConfigurationProperties
Additional options related to the Slurm scheduler.
spot_options SpotOptionsProperties
Additional configuration when you specify SPOT as the purchase option.
status ComputeNodeGroupStatus
The provisioning status of the compute node group. The provisioning status doesn't indicate the overall health of the compute node group.
subnet_ids Sequence[str]
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 Mapping[str, str]
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.
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.
arn String
The unique Amazon Resource Name (ARN) of the compute node group.
customLaunchTemplate Property Map
An Amazon EC2 launch template AWS PCS uses to launch compute nodes.
errorInfo List<Property Map>
The list of errors that occurred during compute node group provisioning.
iamInstanceProfileArn 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 pcs:RegisterComputeNodeGroupInstance permissions attached to provision instances correctly.
id String
The generated unique ID of the compute node group.
purchaseOption "ONDEMAND" | "SPOT"
Specifies how EC2 instances are purchased on your behalf. AWS PCS supports On-Demand and Spot instances. For more information, see Instance purchasing options in the Amazon Elastic Compute Cloud User Guide. If you don't provide this option, it defaults to On-Demand.
scalingConfiguration Property Map
Specifies the boundaries of the compute node group auto scaling.
slurmConfiguration Property Map
Additional options related to the Slurm scheduler.
spotOptions Property Map
Additional configuration when you specify SPOT as the purchase option.
status "CREATING" | "ACTIVE" | "UPDATING" | "DELETING" | "CREATE_FAILED" | "DELETE_FAILED" | "UPDATE_FAILED"
The provisioning status of the compute node group. The provisioning status doesn't indicate the overall health of the compute node group.
subnetIds List<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.
tags Map<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.

Supporting Types

ComputeNodeGroupErrorInfo

Code string
The short-form error code.
Message string
The detailed error information.
Code string
The short-form error code.
Message string
The detailed error information.
code String
The short-form error code.
message String
The detailed error information.
code string
The short-form error code.
message string
The detailed error information.
code str
The short-form error code.
message str
The detailed error information.
code String
The short-form error code.
message String
The detailed error information.

ComputeNodeGroupPurchaseOption

ComputeNodeGroupSlurmCustomSetting

ParameterName This property is required. string
AWS PCS supports configuration of the following Slurm parameters for compute node groups: Weight and RealMemory.
ParameterValue This property is required. string
The value for the configured Slurm setting.
ParameterName This property is required. string
AWS PCS supports configuration of the following Slurm parameters for compute node groups: Weight and RealMemory.
ParameterValue This property is required. string
The value for the configured Slurm setting.
parameterName This property is required. String
AWS PCS supports configuration of the following Slurm parameters for compute node groups: Weight and RealMemory.
parameterValue This property is required. String
The value for the configured Slurm setting.
parameterName This property is required. string
AWS PCS supports configuration of the following Slurm parameters for compute node groups: Weight and RealMemory.
parameterValue This property is required. string
The value for the configured Slurm setting.
parameter_name This property is required. str
AWS PCS supports configuration of the following Slurm parameters for compute node groups: Weight and RealMemory.
parameter_value This property is required. str
The value for the configured Slurm setting.
parameterName This property is required. String
AWS PCS supports configuration of the following Slurm parameters for compute node groups: Weight and RealMemory.
parameterValue This property is required. String
The value for the configured Slurm setting.

ComputeNodeGroupSpotOptionsPropertiesAllocationStrategy

ComputeNodeGroupStatus

CustomLaunchTemplateProperties

Version This property is required. string
The version of the EC2 launch template to use to provision instances.
TemplateId string
The ID of the EC2 launch template to use to provision instances.
Version This property is required. string
The version of the EC2 launch template to use to provision instances.
TemplateId string
The ID of the EC2 launch template to use to provision instances.
version This property is required. String
The version of the EC2 launch template to use to provision instances.
templateId String
The ID of the EC2 launch template to use to provision instances.
version This property is required. string
The version of the EC2 launch template to use to provision instances.
templateId string
The ID of the EC2 launch template to use to provision instances.
version This property is required. str
The version of the EC2 launch template to use to provision instances.
template_id str
The ID of the EC2 launch template to use to provision instances.
version This property is required. String
The version of the EC2 launch template to use to provision instances.
templateId String
The ID of the EC2 launch template to use to provision instances.

ScalingConfigurationProperties

MaxInstanceCount This property is required. int
The upper bound of the number of instances allowed in the compute fleet.
MinInstanceCount This property is required. int
The lower bound of the number of instances allowed in the compute fleet.
MaxInstanceCount This property is required. int
The upper bound of the number of instances allowed in the compute fleet.
MinInstanceCount This property is required. int
The lower bound of the number of instances allowed in the compute fleet.
maxInstanceCount This property is required. Integer
The upper bound of the number of instances allowed in the compute fleet.
minInstanceCount This property is required. Integer
The lower bound of the number of instances allowed in the compute fleet.
maxInstanceCount This property is required. number
The upper bound of the number of instances allowed in the compute fleet.
minInstanceCount This property is required. number
The lower bound of the number of instances allowed in the compute fleet.
max_instance_count This property is required. int
The upper bound of the number of instances allowed in the compute fleet.
min_instance_count This property is required. int
The lower bound of the number of instances allowed in the compute fleet.
maxInstanceCount This property is required. Number
The upper bound of the number of instances allowed in the compute fleet.
minInstanceCount This property is required. Number
The lower bound of the number of instances allowed in the compute fleet.

SlurmConfigurationProperties

SlurmCustomSettings List<Pulumi.AwsNative.Pcs.Inputs.ComputeNodeGroupSlurmCustomSetting>
Additional Slurm-specific configuration that directly maps to Slurm settings.
SlurmCustomSettings []ComputeNodeGroupSlurmCustomSetting
Additional Slurm-specific configuration that directly maps to Slurm settings.
slurmCustomSettings List<ComputeNodeGroupSlurmCustomSetting>
Additional Slurm-specific configuration that directly maps to Slurm settings.
slurmCustomSettings ComputeNodeGroupSlurmCustomSetting[]
Additional Slurm-specific configuration that directly maps to Slurm settings.
slurm_custom_settings Sequence[ComputeNodeGroupSlurmCustomSetting]
Additional Slurm-specific configuration that directly maps to Slurm settings.
slurmCustomSettings List<Property Map>
Additional Slurm-specific configuration that directly maps to Slurm settings.

SpotOptionsProperties

AllocationStrategy Pulumi.AwsNative.Pcs.ComputeNodeGroupSpotOptionsPropertiesAllocationStrategy
The Amazon EC2 allocation strategy AWS PCS uses to provision EC2 instances. AWS PCS supports lowest price, capacity optimized, and price capacity optimized. If you don't provide this option, it defaults to price capacity optimized.
AllocationStrategy ComputeNodeGroupSpotOptionsPropertiesAllocationStrategy
The Amazon EC2 allocation strategy AWS PCS uses to provision EC2 instances. AWS PCS supports lowest price, capacity optimized, and price capacity optimized. If you don't provide this option, it defaults to price capacity optimized.
allocationStrategy ComputeNodeGroupSpotOptionsPropertiesAllocationStrategy
The Amazon EC2 allocation strategy AWS PCS uses to provision EC2 instances. AWS PCS supports lowest price, capacity optimized, and price capacity optimized. If you don't provide this option, it defaults to price capacity optimized.
allocationStrategy ComputeNodeGroupSpotOptionsPropertiesAllocationStrategy
The Amazon EC2 allocation strategy AWS PCS uses to provision EC2 instances. AWS PCS supports lowest price, capacity optimized, and price capacity optimized. If you don't provide this option, it defaults to price capacity optimized.
allocation_strategy ComputeNodeGroupSpotOptionsPropertiesAllocationStrategy
The Amazon EC2 allocation strategy AWS PCS uses to provision EC2 instances. AWS PCS supports lowest price, capacity optimized, and price capacity optimized. If you don't provide this option, it defaults to price capacity optimized.
allocationStrategy "lowest-price" | "capacity-optimized" | "price-capacity-optimized"
The Amazon EC2 allocation strategy AWS PCS uses to provision EC2 instances. AWS PCS supports lowest price, capacity optimized, and price capacity optimized. If you don't provide this option, it defaults to price capacity optimized.

Package Details

Repository
AWS Native pulumi/pulumi-aws-native
License
Apache-2.0

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native