Header menu logo FsCDK

DocumentDBClusterConfig Type

High-level Amazon DocumentDB (MongoDB-compatible) cluster builder following AWS best practices. **Default Settings:** - Engine = docdb - Instance class = db.t3.medium - Instances = 1 (single instance for dev) - Port = 27017 (MongoDB default) - Backup retention = 7 days - Preferred backup window = 03:00-04:00 UTC - Encryption at rest = enabled - Deletion protection = disabled (for dev) **Rationale:** These defaults follow AWS Well-Architected Framework: - MongoDB compatibility for easy migration from Cosmos DB - T3.medium suitable for development and testing - Encryption enabled by default for security - Single instance reduces costs for non-production **Use Cases:** - Document database applications - Content management systems - User profiles and catalogs - Mobile and web applications - Migration from MongoDB or Cosmos DB **Escape Hatch:** Access the underlying CDK DatabaseCluster via the `Cluster` property for advanced scenarios not covered by this builder.

Record fields

Record Field Description

BackupRetentionDays

Full Usage: BackupRetentionDays

Field type: int option
Field type: int option

ClusterName

Full Usage: ClusterName

Field type: string
Field type: string

ConstructId

Full Usage: ConstructId

Field type: string option
Field type: string option

DeletionProtection

Full Usage: DeletionProtection

Field type: bool option
Field type: bool option

InstanceType

Full Usage: InstanceType

Field type: string option
Field type: string option

Instances

Full Usage: Instances

Field type: int option
Field type: int option

MasterPassword

Full Usage: MasterPassword

Field type: ISecret option
Field type: ISecret option

MasterUsername

Full Usage: MasterUsername

Field type: string option
Field type: string option

Port

Full Usage: Port

Field type: int option
Field type: int option

PreferredBackupWindow

Full Usage: PreferredBackupWindow

Field type: string option
Field type: string option

PreferredMaintenanceWindow

Full Usage: PreferredMaintenanceWindow

Field type: string option
Field type: string option

RemovalPolicy

Full Usage: RemovalPolicy

Field type: RemovalPolicy option
Field type: RemovalPolicy option

SecurityGroup

Full Usage: SecurityGroup

Field type: ISecurityGroup option
Field type: ISecurityGroup option

StorageEncrypted

Full Usage: StorageEncrypted

Field type: bool option
Field type: bool option

Tags

Full Usage: Tags

Field type: (string * string) list
Field type: (string * string) list

Vpc

Full Usage: Vpc

Field type: IVpc option
Field type: IVpc option

VpcSubnets

Full Usage: VpcSubnets

Field type: SubnetSelection option
Field type: SubnetSelection option

Type something to start searching.