Skip to main content
Enterprise BYOA deployments run inside your cloud account. Before you can create a BYOA instance you register a cloud account, run the bootstrap script or CloudFormation template that grants FalkorDB the required permissions, and wait for the account configuration to reach READY. A cloud account is modelled as a deployment instance of the account configuration resource in a BYOA service plan. It has two identities:

​
Onboarding flow

1

Subscribe to a BYOA plan

Use Create subscription with an Enterprise BYOA product tier.
2

Register the cloud account

Call Create cloud account with your AWS account ID, GCP project, Azure subscription, or OCI tenancy.
3

Grant permissions

Call Describe account configuration and run the returned CloudFormation template or bootstrap shell command in your cloud account.
4

Wait for READY

Poll the account configuration until status is READY, then create BYOA instances with cloud_provider_account_config_id.

​
Cloud provider identifiers

The AWS bootstrap role ARN follows the pattern arn:aws:iam::<AWS_ACCOUNT_ID>:role/omnistrate-bootstrap-role. The GCP service account email follows bootstrap-<ORG_ID>@<GCP_PROJECT_ID>.iam.gserviceaccount.com, using your lowercase organization ID.