Aws/docdbelastic
@swamp/aws/docdbelasticv2026.09.21.1
01README
AWS DOCDBELASTIC infrastructure models
02Models
@swamp/aws/docdbelastic/clusterv2026.08.17.2cluster.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. |
| ClusterName | string | |
| AdminUserName | string | |
| AdminUserPassword? | string | |
| ShardCapacity | number | |
| ShardCount | number | |
| VpcSecurityGroupIds? | array | |
| SubnetIds? | array | |
| PreferredMaintenanceWindow? | string | |
| PreferredBackupWindow? | string | |
| BackupRetentionPeriod? | number | |
| ShardInstanceCount? | number | |
| KmsKeyId? | string | |
| Tags? | array | |
| AuthType | string |
fn create()
Create a DocDBElastic Cluster
fn get(identifier: string)
Get a DocDBElastic Cluster
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the DocDBElastic Cluster |
fn update()
Update a DocDBElastic Cluster
fn delete(identifier: string)
Delete a DocDBElastic Cluster
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the DocDBElastic Cluster |
fn sync()
Sync DocDBElastic Cluster state from AWS
fn list(maxPages?: number, resourceModel?: string)
List DocDBElastic 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)— DocDBElastic Cluster resource state
@swamp/aws/docdbelastic/cluster-snapshotv2026.09.16.1cluster_snapshot.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. |
| SnapshotName | string | The name of the elastic cluster snapshot. |
| ClusterArn | string | The ARN of the elastic cluster of which to create a snapshot. |
| Tags? | array | An array of key-value pairs to apply to the elastic cluster snapshot. |
fn create()
Create a DocDBElastic ClusterSnapshot
fn get(identifier: string)
Get a DocDBElastic ClusterSnapshot
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the DocDBElastic ClusterSnapshot |
fn update()
Update a DocDBElastic ClusterSnapshot
fn delete(identifier: string)
Delete a DocDBElastic ClusterSnapshot
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the DocDBElastic ClusterSnapshot |
fn sync()
Sync DocDBElastic ClusterSnapshot state from AWS
fn list(maxPages?: number, resourceModel?: string)
List DocDBElastic ClusterSnapshot 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)— DocDBElastic ClusterSnapshot resource state
03Previous Versions
2026.09.20.1
2026.09.19.1
2026.09.18.1
2026.09.17.1
2026.09.16.1
- Added: cluster_snapshot
Added 1 models
2026.09.15.1
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
04Stats
A
100 / 100
Downloads
0
Archive size
410.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