Skip to main content
The Aviatrix Cloud Terraform provider lets you manage Aviatrix Cloud resources as code in a repeatable, version-controlled workflow rather than using the Aviatrix Cloud console for each change. The avxcloud Terraform provider is published on the AviatrixSystems Terraform Namespace. The provider connects to the Aviatrix Cloud API at https://api.cloud.aviatrix.com.
Ensure that your workstation can reach https://api.cloud.aviatrix.com and the Terraform Registry.
Use the correct provider for your use case:
  • The avxcloud provider (source aviatrixsystems/avxcloud) manages Aviatrix Cloud resources.
  • The aviatrix provider manages Aviatrix Enterprise resources, not the Aviatrix Cloud resources.

​
What You Can Manage

The guides in the Automating with Terraform section cover the core Aviatrix Cloud resources you deploy with Terraform. For the full resource and data source list, see the provider documentation on the Terraform Registry. You can use the provider to:
  • Onboard existing AWS, Azure, and GCP accounts to a Fabric.
  • Register existing VPCs and VNets for Aviatrix Cloud management.
  • Configure egress and east-west traffic inspection.

​
Getting Started with the Terraform Provider

Follow these guides in order:
  1. Configure the Aviatrix Cloud Terraform Provider — Create your Terraform files, configure the provider, and run terraform init.
  2. Onboard Cloud Accounts to Aviatrix Cloud with Terraform — Onboard your first AWS, Azure, or GCP account.
  3. Manage Networks with the Aviatrix Cloud Terraform Provider — Manage a VPC or VNet and enable egress inspection.

​
Create API Access Keys from the Aviatrix Cloud Console

You can create API keys from the Aviatrix Cloud console by following these steps:
  1. In the Aviatrix Cloud console, navigate to Settings > General. API Access Keys
  2. Under API Access Keys, click Manage. The Manage API Access Keys form opens.
  3. Click Generate API Access Key.
  4. Fill in the form with the following details:
    • Name: A name for the API key.
    • Key Expiration: The number of days until the API key expires.
    • Permissions:
      • Read Only: For read-only access to all resources.
      • Admin: For full access to all resources.
  5. Click Generate API Access Key. A new API key is generated and displayed.
  6. Copy the API key and save it to a secure location.
The API key appears only once. If you lose it, you can generate a new one.