PD AWS DocumentDB for WHMCS: getting started
PD AWS DocumentDB lets you offer Amazon DocumentDB clusters through WHMCS, using AWS. It suits MongoDB-compatible applications, with the resource linked to the customer’s service.
Before you start
Install PD Modules for WHMCS first, connect the account that holds your licence, then install PD AWS DocumentDB from its Store. Allow the administrator role that needs to use it.
You also need an AWS account with the permissions required for the chosen database service. Check the provider account’s permissions, available locations and capacity before enabling automatic provisioning.
Connect the account
Add the provider connection under System Settings → Servers, selecting this module for the server record. Assign the appropriate server group to the product. Keep provider credentials on the connection, separate from the product’s resource defaults.
Define what the customer receives
Create a product using PD AWS DocumentDB and review its Module Settings and configurable options. Start with Region, Plan, DocumentDB version. Together these describe the resource requested when a service is provisioned; they are not just labels on the order form.
Cluster endpoints are not an instruction to make a database public. Plan the permitted VPC access before handing connection details to a customer.
Choose which client controls the product exposes. If you offer configurable options, check that their values match the module’s supported choices and that the defaults describe the service you intend to sell.
Put the service into use
Set the product’s automatic-setup behaviour deliberately. If you want provisioning after payment, select that option rather than leaving setup manual. Keep the normal cron running for subsequent status and usage updates.
Check the first service
Review the instance or cluster state, the connection details and the access controls. A pending resource is not ready for application connections.
Creating a real service creates provider resources and can incur provider charges. Review the configuration first; use your normal controlled test process for the first provisioning rather than making an order solely to browse the settings.
Explore the module
See the PD AWS DocumentDB for WHMCS module page for the current product details.
AWS DocumentDB task guides
- Connect an AWS account to PD AWS DocumentDB in WHMCS
- Test the AWS connection for PD AWS DocumentDB in WHMCS
- Configure a DocumentDB database product in WHMCS
- Choose an AWS region for PD AWS DocumentDB in WHMCS
- Choose a DocumentDB instance plan in WHMCS
- Plan private DocumentDB network access in WHMCS
- Investigate a pending DocumentDB service in WHMCS
