Skip to main content

@swamp/aws/docdb

v2026.04.23.3

AWS DOCDB infrastructure models

Repository

https://github.com/systeminit/swamp-extensions

Labels

awsdocdbcloudinfrastructure

Contents

Quality score

Verified by Swamp

How well-documented and verifiable this extension is.

100%

Grade A

  • Has README or module doc2/2earned
  • README has a code example1/1earned
  • README is substantive1/1earned
  • Most symbols documented1/1earned
  • No slow types1/1earned
  • Has description1/1earned
  • At least one platform tag (or universal)1/1earned
  • Two or more platform tags (or universal)1/1earned
  • License declared1/1earned
  • Verified public repository2/2earned

Install

$ swamp extension pull @swamp/aws/docdb

@swamp/aws/docdb/global-clusterv2026.04.23.2global_cluster.ts

Global Arguments

ArgumentTypeDescription
GlobalClusterIdentifierstringThe cluster identifier of the global cluster.
SourceDBClusterIdentifier?stringThe 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?enumThe database engine to use for this global cluster.
EngineVersion?stringThe engine version to use for this global cluster.
DeletionProtection?booleanIndicates whether the global cluster has deletion protection enabled. The global cluster can't be deleted when deletion protection is enabled.
StorageEncrypted?booleanIndicates whether the global cluster has storage encryption enabled.
Tags?arrayThe tags to be assigned to the Amazon DocumentDB resource.
createCreate a DocDB GlobalCluster
getGet a DocDB GlobalCluster
ArgumentTypeDescription
identifierstringThe primary identifier of the DocDB GlobalCluster
updateUpdate a DocDB GlobalCluster
deleteDelete a DocDB GlobalCluster
ArgumentTypeDescription
identifierstringThe primary identifier of the DocDB GlobalCluster
syncSync DocDB GlobalCluster state from AWS

Resources

state(infinite)— DocDB GlobalCluster resource state