API Reference

RabbitMQBroker

Tiers

This feature is available for the following tiers: Standard, Premium.

Packages:

• mq.entigo.com/v1alpha1

mq.entigo.com/v1alpha1

Resource Types:

• RabbitMQBroker

RabbitMQBroker

^{↩ Parent}

Name	Type	Description	Required
apiVersion	string	mq.entigo.com/v1alpha1	true
kind	string	RabbitMQBroker	true
metadata	object	Refer to the Kubernetes API documentation for the fields of the metadata field.	true
spec	object	Validations: !has(oldSelf.configuration) || has(self.configuration): spec.configuration cannot be removed once set; Amazon MQ does not support disassociating a broker configuration (only changing it)	true
status	object		false

RabbitMQBroker.spec

^{↩ Parent}

Name	Type	Description	Required
instanceType	string	Default: mq.m7g.medium	true
autoMinorVersionUpgrade	boolean	Whether to automatically upgrade to new minor versions of brokers as Amazon MQ makes releases available. Default: true	false
brokerName	string	Name of the broker.	false
configuration	object	Configuration for the broker. When set, an Amazon MQ Configuration is created from the provided rabbitmq.conf (Cuttlefish) content and associated with the broker.	false
deploymentMode	enum	Deployment mode of the broker. Valid values are SINGLE_INSTANCE, ACTIVE_STANDBY_MULTI_AZ, and CLUSTER_MULTI_AZ. Default is SINGLE_INSTANCE. Enum: SINGLE_INSTANCE, ACTIVE_STANDBY_MULTI_AZ, CLUSTER_MULTI_AZ Default: SINGLE_INSTANCE	false
engineType	string	Default: RabbitMQ	false
engineVersion	string	Version of the broker engine. Default: 4.2	false
maintenanceWindowStartTime	object	Configuration block for the maintenance window start time.	false
publiclyAccessible	boolean	Default: false	false

RabbitMQBroker.spec.configuration

^{↩ Parent}

Configuration for the broker. When set, an Amazon MQ Configuration is created from the provided rabbitmq.conf (Cuttlefish) content and associated with the broker.

Name	Type	Description	Required
data	string	Raw rabbitmq.conf (Cuttlefish) content for the broker configuration.	true
description	string	Optional description for the configuration.	false

RabbitMQBroker.spec.maintenanceWindowStartTime

^{↩ Parent}

Configuration block for the maintenance window start time.

Name	Type	Description	Required
dayOfWeek	string	Day of the week, e.g., MONDAY, TUESDAY, or WEDNESDAY.	false
timeOfDay	string	Time, in 24-hour format, e.g., 02:00.	false
timeZone	string	Time zone in either the Country/City format or the UTC offset format, e.g., CET.	false

RabbitMQBroker.status

^{↩ Parent}

Name	Type	Description	Required
amazonMQBrokerID	string		false
autoMinorVersionUpgrade	boolean		false
brokerName	string		false
configuration	object		false
deploymentMode	string		false
encryptionOptions	object		false
engineType	string		false
engineVersion	string		false
instanceType	string		false
instances	[]object		false
maintenanceWindowStartTime	object		false
pendingDataReplicationMode	string		false
publiclyAccessible	boolean		false
region	string		false
securityGroups	[]string		false
storageType	string		false
subnetIds	[]string		false

RabbitMQBroker.status.configuration

^{↩ Parent}

Name	Type	Description	Required
id	string	Configuration ID.	false
revision	number	Revision of the Configuration.	false

RabbitMQBroker.status.encryptionOptions

^{↩ Parent}

Name	Type	Description	Required
kmsKeyId	string	ARN of KMS CMK to use for encryption at rest. Requires setting use_aws_owned_key to false. To perform drift detection when AWS-managed CMKs or customer-managed CMKs are in use, this value must be configured.	false
useAwsOwnedKey	boolean	Whether to enable an AWS-owned KMS CMK not in your account. Defaults to true. Setting to false without configuring kms_key_id creates an AWS-managed CMK aliased to aws/mq in your account.	false

RabbitMQBroker.status.instances[index]

^{↩ Parent}

Name	Type	Description	Required
consoleUrl	string	URL of the ActiveMQ Web Console or the RabbitMQ Management UI depending on engine_type.	false
endpoints	[]string	Broker's wire-level protocol endpoints referenceable.	false
ipAddress	string	IP Address of the broker.	false

RabbitMQBroker.status.maintenanceWindowStartTime

^{↩ Parent}

Name	Type	Description	Required
dayOfWeek	string	Day of the week, e.g., MONDAY, TUESDAY, or WEDNESDAY.	false
timeOfDay	string	Time, in 24-hour format, e.g., 02:00.	false
timeZone	string	Time zone in either the Country/City format or the UTC offset format, e.g., CET.	false

Examples

Basic Broker

A minimal RabbitMQ Broker definition showing the required fields only.

apiVersion: mq.entigo.com/v1alpha1
kind: RabbitMQBroker
metadata:
  name: basic-broker
spec:
  instanceType: mq.m7g.medium

A RabbitMQ Broker definition with an explicit engine version and single-instance deployment.

apiVersion: mq.entigo.com/v1alpha1
kind: RabbitMQBroker
metadata:
  name: rabbitmq-example
spec:
  instanceType: mq.m7g.medium
  engineVersion: "4.2"
  engineType: RabbitMQ
  deploymentMode: SINGLE_INSTANCE
  publiclyAccessible: false

High Availability Broker

A RabbitMQ Broker deployed as a multi-AZ cluster with a maintenance window.

apiVersion: mq.entigo.com/v1alpha1
kind: RabbitMQBroker
metadata:
  name: ha-broker
spec:
  instanceType: mq.m7g.large
  engineVersion: "4.2"
  deploymentMode: CLUSTER_MULTI_AZ
  autoMinorVersionUpgrade: true
  maintenanceWindowStartTime:
    dayOfWeek: MONDAY
    timeOfDay: "02:00"
    timeZone: CET

Broker with Custom Configuration

A RabbitMQ Broker with a custom rabbitmq.conf (Cuttlefish) configuration.

apiVersion: mq.entigo.com/v1alpha1
kind: RabbitMQBroker
metadata:
  name: configured-broker
spec:
  instanceType: mq.m7g.medium
  engineVersion: "4.2"
  configuration:
    description: Custom broker configuration
    data: |
      consumer_timeout = 1800000
      channel_max = 2047