Aws/docdb
@swamp/aws/docdbv2026.09.20.1
01README
AWS DOCDB infrastructure models
02Models
@swamp/aws/docdb/dbcluster-parameter-groupv2026.08.22.1dbcluster_parameter_group.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| 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. |
| Description | string | The description for the DB cluster parameter group. |
| Parameters | record | An object containing key-value pairs of parameters to set for the DB cluster parameter group. |
| Family | string | The DB cluster parameter group family name (e.g. docdb5.0). |
| Tags? | array | An array of key-value pairs to apply to this resource. |
| Name? | string | The name of the DB cluster parameter group. If omitted, CloudFormation generates a unique name. The name is stored as lowercase. |
fn create()
Create a DocDB DBClusterParameterGroup
fn get(identifier: string)
Get a DocDB DBClusterParameterGroup
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the DocDB DBClusterParameterGroup |
fn update()
Update a DocDB DBClusterParameterGroup
fn delete(identifier: string)
Delete a DocDB DBClusterParameterGroup
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the DocDB DBClusterParameterGroup |
fn sync()
Sync DocDB DBClusterParameterGroup state from AWS
fn list(maxPages?: number, resourceModel?: string)
List DocDB DBClusterParameterGroup 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)— DocDB DBClusterParameterGroup resource state
@swamp/aws/docdb/dbsubnet-groupv2026.08.17.2dbsubnet_group.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| 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. |
| DBSubnetGroupName? | string | The name for the db subnet group. This value is stored as a lowercase string. |
| DBSubnetGroupDescription | string | The description for the subnet group. |
| SubnetIds | array | One or more subnet IDs to be assigned to the db subnet group. |
| Tags? | array | One or more tags to be assigned to the db subnet group |
fn create()
Create a DocDB DBSubnetGroup
fn get(identifier: string)
Get a DocDB DBSubnetGroup
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the DocDB DBSubnetGroup |
fn update()
Update a DocDB DBSubnetGroup
fn delete(identifier: string)
Delete a DocDB DBSubnetGroup
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the DocDB DBSubnetGroup |
fn sync()
Sync DocDB DBSubnetGroup state from AWS
fn list(maxPages?: number, resourceModel?: string)
List DocDB DBSubnetGroup 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)— DocDB DBSubnetGroup resource state
@swamp/aws/docdb/event-subscriptionv2026.08.17.2event_subscription.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| 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. |
| Enabled? | boolean | A Boolean value; set to true to activate the subscription, set to false to create the subscription but not active it. |
| EventCategories? | array | A list of event categories for a SourceType that you want to subscribe to. |
| SnsTopicArn | string | The Amazon Resource Name (ARN) of the SNS topic created for event notification. Amazon SNS creates the ARN when you create a topic and subscribe to it. |
| SubscriptionName? | string | The name of the subscription. |
| SourceIds? | array | The list of identifiers of the event sources for which events are returned |
| SourceType? | enum | The type of source that is generating the events. |
fn create()
Create a DocDB EventSubscription
fn get(identifier: string)
Get a DocDB EventSubscription
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the DocDB EventSubscription |
fn update()
Update a DocDB EventSubscription
fn delete(identifier: string)
Delete a DocDB EventSubscription
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the DocDB EventSubscription |
fn sync()
Sync DocDB EventSubscription state from AWS
fn list(maxPages?: number, resourceModel?: string)
List DocDB EventSubscription 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)— DocDB EventSubscription resource state
@swamp/aws/docdb/global-clusterv2026.08.17.2global_cluster.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| 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. |
| GlobalClusterIdentifier | string | The cluster identifier of the global cluster. |
| SourceDBClusterIdentifier? | string | The Amazon Resource Name (ARN) to use as the primary cluster of the global cluster. You may also choose to instead specify the DBClusterIdentifier. If you provide a value for this parameter, don't specify values for the following settings because Amazon DocumentDB uses the values from the specified source DB cluster: Engine, EngineVersion, StorageEncrypted |
| Engine? | enum | The database engine to use for this global cluster. |
| EngineVersion? | string | The engine version to use for this global cluster. |
| DeletionProtection? | boolean | Indicates whether the global cluster has deletion protection enabled. The global cluster can't be deleted when deletion protection is enabled. |
| StorageEncrypted? | boolean | Indicates whether the global cluster has storage encryption enabled. |
| Tags? | array | The tags to be assigned to the Amazon DocumentDB resource. |
fn create()
Create a DocDB GlobalCluster
fn get(identifier: string)
Get a DocDB GlobalCluster
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the DocDB GlobalCluster |
fn update()
Update a DocDB GlobalCluster
fn delete(identifier: string)
Delete a DocDB GlobalCluster
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the DocDB GlobalCluster |
fn sync()
Sync DocDB GlobalCluster state from AWS
fn list(maxPages?: number, resourceModel?: string)
List DocDB GlobalCluster 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)— DocDB GlobalCluster resource state
03Previous Versions
2026.09.19.1
2026.09.18.1
2026.09.17.1
2026.09.16.1
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
2026.09.02.1
04Stats
A
100 / 100
Downloads
0
Archive size
813.7 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