interface IMongoDb

Language	Type name
Python	aws_rfdk.IMongoDb
TypeScript (source)	aws-rfdk » IMongoDb

Implemented by MongoDbInstance

Essential properties of a MongoDB database.

Properties

Name	Type	Description
adminUser	ISecret	Credentials for the admin user of the database.
certificateChain	ISecret	The certificate chain of trust for the MongoDB application's server certificate.
connections	Connections	The network connections associated with this resource.
fullHostname	string	The full host name that can be used to connect to the MongoDB application running on this instance.
node	Node	The tree node.
port	number	The port to connect to for MongoDB.
version	MongoDbVersion	The version of MongoDB that is running on this instance.

---

adminUser

Type: ISecret

Credentials for the admin user of the database.

This user has database role: [ { role: 'userAdminAnyDatabase', db: 'admin' }, 'readWriteAnyDatabase' ]

---

certificateChain

Type: ISecret

The certificate chain of trust for the MongoDB application's server certificate.

The contents of this secret is a single string containing the trust chain in PEM format, and can be saved to a file that is then passed as the --sslCAFile option when connecting to MongoDB using the mongo shell.

---

connections

Type: Connections

The network connections associated with this resource.

---

fullHostname

Type: string

The full host name that can be used to connect to the MongoDB application running on this instance.

---

node

Type: Node

The tree node.

---

port

Type: number

The port to connect to for MongoDB.

---

version

Type: MongoDbVersion

The version of MongoDB that is running on this instance.

Methods

Name	Description
addSecurityGroup(...securityGroups)	Adds security groups to the database.

---

addSecurityGroup(...securityGroups)

public addSecurityGroup(...securityGroups: ISecurityGroup[]): void

Parameters

• securityGroups ISecurityGroup — The security groups to add.

Adds security groups to the database.