Skip to content

Add awscc_pcs_compute_node_group #2238

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Mar 17, 2025
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
98 changes: 98 additions & 0 deletions docs/data-sources/pcs_compute_node_group.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,98 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "awscc_pcs_compute_node_group Data Source - terraform-provider-awscc"
subcategory: ""
description: |-
Data Source schema for AWS::PCS::ComputeNodeGroup
---

# awscc_pcs_compute_node_group (Data Source)

Data Source schema for AWS::PCS::ComputeNodeGroup



<!-- schema generated by tfplugindocs -->
## Schema

### Required

- `id` (String) Uniquely identifies the resource.

### Read-Only

- `ami_id` (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.
- `cluster_id` (String) The ID of the cluster of the compute node group.
- `compute_node_group_id` (String) The generated unique ID of the compute node group.
- `custom_launch_template` (Attributes) An Amazon EC2 launch template AWS PCS uses to launch compute nodes. (see [below for nested schema](#nestedatt--custom_launch_template))
- `error_info` (Attributes List) The list of errors that occurred during compute node group provisioning. (see [below for nested schema](#nestedatt--error_info))
- `iam_instance_profile_arn` (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.
- `instance_configs` (Attributes List) A list of EC2 instance configurations that AWS PCS can provision in the compute node group. (see [below for nested schema](#nestedatt--instance_configs))
- `name` (String) The name that identifies the compute node group.
- `purchase_option` (String) 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` (Attributes) Specifies the boundaries of the compute node group auto scaling. (see [below for nested schema](#nestedatt--scaling_configuration))
- `slurm_configuration` (Attributes) Additional options related to the Slurm scheduler. (see [below for nested schema](#nestedatt--slurm_configuration))
- `spot_options` (Attributes) Additional configuration when you specify SPOT as the purchase option. (see [below for nested schema](#nestedatt--spot_options))
- `status` (String) The provisioning status of the compute node group. The provisioning status doesn't indicate the overall health of the compute node group.
- `subnet_ids` (List of 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 of 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.

<a id="nestedatt--custom_launch_template"></a>
### Nested Schema for `custom_launch_template`

Read-Only:

- `template_id` (String) The ID of the EC2 launch template to use to provision instances.
- `version` (String) The version of the EC2 launch template to use to provision instances.


<a id="nestedatt--error_info"></a>
### Nested Schema for `error_info`

Read-Only:

- `code` (String) The short-form error code.
- `message` (String) The detailed error information.


<a id="nestedatt--instance_configs"></a>
### Nested Schema for `instance_configs`

Read-Only:

- `instance_type` (String) The EC2 instance type that AWS PCS can provision in the compute node group.


<a id="nestedatt--scaling_configuration"></a>
### Nested Schema for `scaling_configuration`

Read-Only:

- `max_instance_count` (Number) The upper bound of the number of instances allowed in the compute fleet.
- `min_instance_count` (Number) The lower bound of the number of instances allowed in the compute fleet.


<a id="nestedatt--slurm_configuration"></a>
### Nested Schema for `slurm_configuration`

Read-Only:

- `slurm_custom_settings` (Attributes List) Additional Slurm-specific configuration that directly maps to Slurm settings. (see [below for nested schema](#nestedatt--slurm_configuration--slurm_custom_settings))

<a id="nestedatt--slurm_configuration--slurm_custom_settings"></a>
### Nested Schema for `slurm_configuration.slurm_custom_settings`

Read-Only:

- `parameter_name` (String) AWS PCS supports configuration of the following Slurm parameters for compute node groups: Weight and RealMemory.
- `parameter_value` (String) The value for the configured Slurm setting.



<a id="nestedatt--spot_options"></a>
### Nested Schema for `spot_options`

Read-Only:

- `allocation_strategy` (String) 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.
112 changes: 112 additions & 0 deletions docs/resources/pcs_compute_node_group.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,112 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "awscc_pcs_compute_node_group Resource - terraform-provider-awscc"
subcategory: ""
description: |-
AWS::PCS::ComputeNodeGroup resource creates an AWS PCS compute node group.
---

# awscc_pcs_compute_node_group (Resource)

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



<!-- schema generated by tfplugindocs -->
## Schema

### Required

- `cluster_id` (String) The ID of the cluster of the compute node group.
- `custom_launch_template` (Attributes) An Amazon EC2 launch template AWS PCS uses to launch compute nodes. (see [below for nested schema](#nestedatt--custom_launch_template))
- `iam_instance_profile_arn` (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.
- `instance_configs` (Attributes List) A list of EC2 instance configurations that AWS PCS can provision in the compute node group. (see [below for nested schema](#nestedatt--instance_configs))
- `scaling_configuration` (Attributes) Specifies the boundaries of the compute node group auto scaling. (see [below for nested schema](#nestedatt--scaling_configuration))
- `subnet_ids` (List of 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.

### Optional

- `ami_id` (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.
- `name` (String) The name that identifies the compute node group.
- `purchase_option` (String) 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.
- `slurm_configuration` (Attributes) Additional options related to the Slurm scheduler. (see [below for nested schema](#nestedatt--slurm_configuration))
- `spot_options` (Attributes) Additional configuration when you specify SPOT as the purchase option. (see [below for nested schema](#nestedatt--spot_options))
- `tags` (Map of 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.

### Read-Only

- `arn` (String) The unique Amazon Resource Name (ARN) of the compute node group.
- `compute_node_group_id` (String) The generated unique ID of the compute node group.
- `error_info` (Attributes List) The list of errors that occurred during compute node group provisioning. (see [below for nested schema](#nestedatt--error_info))
- `id` (String) Uniquely identifies the resource.
- `status` (String) The provisioning status of the compute node group. The provisioning status doesn't indicate the overall health of the compute node group.

<a id="nestedatt--custom_launch_template"></a>
### Nested Schema for `custom_launch_template`

Required:

- `version` (String) The version of the EC2 launch template to use to provision instances.

Optional:

- `template_id` (String) The ID of the EC2 launch template to use to provision instances.


<a id="nestedatt--instance_configs"></a>
### Nested Schema for `instance_configs`

Optional:

- `instance_type` (String) The EC2 instance type that AWS PCS can provision in the compute node group.


<a id="nestedatt--scaling_configuration"></a>
### Nested Schema for `scaling_configuration`

Required:

- `max_instance_count` (Number) The upper bound of the number of instances allowed in the compute fleet.
- `min_instance_count` (Number) The lower bound of the number of instances allowed in the compute fleet.


<a id="nestedatt--slurm_configuration"></a>
### Nested Schema for `slurm_configuration`

Optional:

- `slurm_custom_settings` (Attributes List) Additional Slurm-specific configuration that directly maps to Slurm settings. (see [below for nested schema](#nestedatt--slurm_configuration--slurm_custom_settings))

<a id="nestedatt--slurm_configuration--slurm_custom_settings"></a>
### Nested Schema for `slurm_configuration.slurm_custom_settings`

Optional:

- `parameter_name` (String) AWS PCS supports configuration of the following Slurm parameters for compute node groups: Weight and RealMemory.
- `parameter_value` (String) The value for the configured Slurm setting.



<a id="nestedatt--spot_options"></a>
### Nested Schema for `spot_options`

Optional:

- `allocation_strategy` (String) 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.


<a id="nestedatt--error_info"></a>
### Nested Schema for `error_info`

Read-Only:

- `code` (String) The short-form error code.
- `message` (String) The detailed error information.

## Import

Import is supported using the following syntax:

```shell
$ terraform import awscc_pcs_compute_node_group.example "arn"
```
15 changes: 9 additions & 6 deletions internal/aws/pcs/compute_node_group_resource_gen.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading
Loading