Aws/workspaces
@swamp/aws/workspacesv2026.09.15.1
01README
AWS WORKSPACES infrastructure models
02Models
@swamp/aws/workspaces/connection-aliasv2026.08.17.2connection_alias.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. |
| ConnectionString | string | |
| Tags? | array |
fn create()
Create a WorkSpaces ConnectionAlias
fn get(identifier: string)
Get a WorkSpaces ConnectionAlias
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the WorkSpaces ConnectionAlias |
fn delete(identifier: string)
Delete a WorkSpaces ConnectionAlias
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the WorkSpaces ConnectionAlias |
fn sync()
Sync WorkSpaces ConnectionAlias state from AWS
fn list(maxPages?: number, resourceModel?: string)
List WorkSpaces ConnectionAlias 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)— WorkSpaces ConnectionAlias resource state
@swamp/aws/workspaces/workspacev2026.08.17.2workspace.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. |
| BundleId | string | |
| DirectoryId | string | |
| RootVolumeEncryptionEnabled? | boolean | |
| Tags? | array | |
| UserName | string | |
| UserVolumeEncryptionEnabled? | boolean | |
| VolumeEncryptionKey? | string | |
| WorkspaceProperties? | object |
fn create()
Create a WorkSpaces Workspace
fn get(identifier: string)
Get a WorkSpaces Workspace
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the WorkSpaces Workspace |
fn update()
Update a WorkSpaces Workspace
fn delete(identifier: string)
Delete a WorkSpaces Workspace
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the WorkSpaces Workspace |
fn sync()
Sync WorkSpaces Workspace state from AWS
fn list(maxPages?: number, resourceModel?: string)
List WorkSpaces Workspace 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)— WorkSpaces Workspace resource state
@swamp/aws/workspaces/workspace-ip-groupv2026.08.17.2workspace_ip_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. |
| GroupName | string | The name of the group. |
| GroupDesc? | string | The description of the group. |
| UserRules? | array | The rules for the IP access control group. |
| Tags? | array | The tags for the IP access control group. |
fn create()
Create a WorkSpaces WorkspaceIpGroup
fn get(identifier: string)
Get a WorkSpaces WorkspaceIpGroup
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the WorkSpaces WorkspaceIpGroup |
fn update()
Update a WorkSpaces WorkspaceIpGroup
fn delete(identifier: string)
Delete a WorkSpaces WorkspaceIpGroup
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the WorkSpaces WorkspaceIpGroup |
fn sync()
Sync WorkSpaces WorkspaceIpGroup state from AWS
fn list(maxPages?: number, resourceModel?: string)
List WorkSpaces WorkspaceIpGroup 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)— WorkSpaces WorkspaceIpGroup resource state
@swamp/aws/workspaces/workspaces-poolv2026.08.17.2workspaces_pool.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. |
| Capacity | object | |
| PoolName | string | |
| Description? | string | |
| BundleId | string | |
| DirectoryId | string | |
| ApplicationSettings? | object | |
| TimeoutSettings? | object | |
| RunningMode? | enum | |
| Tags? | array |
fn create()
Create a WorkSpaces WorkspacesPool
fn get(identifier: string)
Get a WorkSpaces WorkspacesPool
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the WorkSpaces WorkspacesPool |
fn update()
Update a WorkSpaces WorkspacesPool
fn delete(identifier: string)
Delete a WorkSpaces WorkspacesPool
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the WorkSpaces WorkspacesPool |
fn sync()
Sync WorkSpaces WorkspacesPool state from AWS
fn list(maxPages?: number, resourceModel?: string)
List WorkSpaces WorkspacesPool 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)— WorkSpaces WorkspacesPool resource state
03Previous Versions
2026.09.14.1
2026.09.13.1
2026.09.12.1
2026.09.11.1
2026.09.10.1
2026.09.09.1
2026.09.08.1
2026.09.07.1
2026.09.06.3
2026.09.06.1
2026.09.05.1
2026.09.04.1
2026.09.03.1
2026.09.02.1
2026.09.01.1
2026.08.31.1
2026.08.30.1
2026.08.29.1
2026.08.28.1
04Stats
A
100 / 100
Downloads
0
Archive size
988.4 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
- Has description1/1earned
- Platform support declared (or universal)2/2earned
- License declared1/1earned
- Verified public repository2/2earned
05Platforms
06Labels