Skip to main content
An AutoMQ instance is the top-level data plane resource and corresponds to an independent Apache Kafka® cluster.

​
Instance lifecycle

  • Creating: AutoMQ is provisioning cloud resources and deploying the instance. Configuration changes are unavailable until creation completes.
  • Running: The instance can serve Kafka client requests and management APIs.
  • Modifying: AutoMQ is applying a configuration change or version upgrade. Additional changes are unavailable until the operation completes.
  • Service Exception: The instance cannot provide normal service because instance deployment, a change operation, or underlying infrastructure failed.
  • Deleting: AutoMQ is deleting the instance and releasing its managed resources. The instance no longer accepts client traffic.
  • Deleted: The instance and its managed resources have been released. The instance cannot be recovered.

​
Create an Instance

  1. Sign in to the AutoMQ Console.
  2. In the navigation pane, choose Instances, and then choose Create Instance.
  3. If prompted, select the Deployment Profile for the instance.
  4. Follow the wizard to configure the instance settings, capacity, additional settings, and IAM permissions. The wizard displays only the settings supported by the selected environment and AutoMQ version.
  5. Review the configuration and choose Create.
  6. Wait until the instance status is Running.

​
View an Instance

On the Instances page, choose the instance name. The details page displays status, endpoints, capacity, network, security, configuration, metrics, and related resources.

​
Scale an Instance

  1. Open the instance details page.
  2. Choose Change Configuration.
  3. Update the capacity settings and confirm the change.
  4. Wait until the instance returns to Running.

​
Upgrade an Instance

Review Release Notes before upgrading. The AutoMQ Console must support the target instance version; if required, first follow Upgrade Environment Version.
  1. Open the instance details page.
  2. Choose Upgrade when a target version is available.
  3. Review the target version and confirm the rolling upgrade.
AutoMQ performs instance upgrades as rolling operations. Monitor application error rates and latency throughout the change.

​
Delete an Instance

On the Instances page, open the actions menu for the instance, choose Delete, and confirm the operation.
Deleting an instance cannot be undone. Verify the instance name before you confirm the operation.