Aws/pcs
@swamp/aws/pcsv2026.10.25.1
01README
AWS PCS infrastructure models
02Release Notes
- Updated: cluster, compute_node_group
03Behaviors
@swamp/aws/pcs/clusterv2026.10.25.1cluster.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| Name? | string | The name that identifies the cluster. |
| Networking | object | The networking configuration for the cluster's control plane. |
| Scheduler | object | The cluster management and job scheduling software associated with the cluster. |
| Size | enum | The size of the cluster. |
| SlurmConfiguration? | object | Additional options related to the Slurm scheduler. |
| Tags? | record | 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. |
fn create()
Create a PCS Cluster
fn get(identifier: string)
Get a PCS Cluster
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the PCS Cluster |
fn update()
Update a PCS Cluster
fn delete(identifier: string)
Delete a PCS Cluster
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the PCS Cluster |
fn sync()
Sync PCS Cluster state from AWS
fn list(maxPages?: number, resourceModel?: string)
List PCS Cluster resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— PCS Cluster resource state
@swamp/aws/pcs/compute-node-groupv2026.10.25.1compute_node_group.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| ClusterId | string | The ID of the cluster of the compute node group. |
| SpotOptions? | object | Additional configuration when you specify SPOT as the purchase option. |
| SlurmConfiguration? | object | Additional options related to the Slurm scheduler. |
| SubnetIds | array | 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. |
| Name? | string | The name that identifies the compute node group. |
| NodeLifecycleActions? | object | Custom scripts that run at defined points in a compute node's lifecycle. |
| ScalingConfiguration | object | Specifies the boundaries of the compute node group auto scaling. |
| InstanceConfigs | array | A list of EC2 instance configurations that AWS PCS can provision in the compute node group. |
| PurchaseOption? | enum | Specifies how EC2 instances are purchased on your behalf. AWS PCS supports On-Demand, Spot, Capacity Block, and Interruptible Capacity Reservation 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. |
| CustomLaunchTemplate? | object | An Amazon EC2 launch template AWS PCS uses to launch compute nodes. |
| Tags? | record | 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. |
| 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. |
fn create()
Create a PCS ComputeNodeGroup
fn get(identifier: string)
Get a PCS ComputeNodeGroup
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the PCS ComputeNodeGroup |
fn update()
Update a PCS ComputeNodeGroup
fn delete(identifier: string)
Delete a PCS ComputeNodeGroup
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the PCS ComputeNodeGroup |
fn sync()
Sync PCS ComputeNodeGroup state from AWS
fn list(maxPages?: number, resourceModel?: string)
List PCS ComputeNodeGroup resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— PCS ComputeNodeGroup resource state
@swamp/aws/pcs/queuev2026.10.23.1queue.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| ClusterId | string | The ID of the cluster of the queue. |
| ComputeNodeGroupConfigurations? | array | The list of compute node group configurations associated with the queue. Queues assign jobs to associated compute node groups. |
| Name? | string | The name that identifies the queue. |
| SlurmConfiguration? | object | The Slurm configuration for the queue. |
| Tags? | record | 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. |
fn create()
Create a PCS Queue
fn get(identifier: string)
Get a PCS Queue
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the PCS Queue |
fn update()
Update a PCS Queue
fn delete(identifier: string)
Delete a PCS Queue
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the PCS Queue |
fn sync()
Sync PCS Queue state from AWS
fn list(maxPages?: number, resourceModel?: string)
List PCS Queue resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— PCS Queue resource state
04Previous Versions
2026.10.24.1AGPL-3.0-or-later
2026.10.23.1AGPL-3.0-or-later
- Updated: cluster, compute_node_group, queue
2026.10.20.1AGPL-3.0-or-later(was none)
- Updated: compute_node_group
2026.10.13.1
- Updated: cluster, compute_node_group, queue
2026.10.08.1
2026.10.06.1
2026.10.04.1
2026.10.03.1
- Updated: compute_node_group
2026.10.02.1
2026.10.01.1
2026.09.30.1
2026.09.29.1
2026.09.28.1
2026.09.27.1
2026.09.26.1
2026.09.25.1
2026.09.24.1
2026.09.23.1
2026.09.22.1
05Stats
A
100 / 100
Downloads
35
Archive size
627.0 KB
Verified by Swamp
- Has README or module doc2/2earned
- README has a code example1/1earned
- README is substantive1/1earned
- Most symbols documented1/1earned
- No slow types (deprecated)1/1earned
- Dependencies pass trust audit2/2earned
- Docs keep secrets in a vault1/1earned
- Has description1/1earned
- Platform support declared (or universal)2/2earned
- License2/2earned
- Verified public repository2/2earned
06Platforms
07Labels