Amazon MQ

2 resource kinds. Generated from the operator's CRD schemas.

API Group: aws.konfig.io/v1alpha1

MQBroker # GA

MQBroker is the Schema for managing Amazon MQ brokers.

kubectl get mqbrokers · example on GitHub

Example

# MQBroker — Amazon MQ
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/mq.html#mqbroker
apiVersion: aws.konfig.io/v1alpha1
kind: MQBroker
metadata:
  name: example-mqbroker
  namespace: default
spec:
  autoMinorVersionUpgrade: false
  brokerName: example-mqbroker
  deploymentMode: SINGLE_INSTANCE
  engineType: ACTIVEMQ
  engineVersion: example
  hostInstanceType: example
  providerRef:
    name: example-mqbroker
    region: us-east-1
  publiclyAccessible: false
  securityGroupRefs:
  - name: example-securitygrouprefs
  subnetRefs:
  - name: example-subnetrefs
  tags:
    environment: dev
    team: platform
  users:
  - consoleAccess: false
    groups:
    - example
    passwordRef:
      key: example
      name: example-mqbroker
    username: example-mqbroker

Spec

Field	Type	Required	Description
`autoMinorVersionUpgrade`	boolean	—	AutoMinorVersionUpgrade enables automatic patch version upgrades.
`brokerName`	string	yes	BrokerName is the name of the broker.
`deploymentMode`	enum	yes	DeploymentMode is the broker deployment mode. Allowed: `SINGLE_INSTANCE, ACTIVE_STANDBY_MULTI_AZ, CLUSTER_MULTI_AZ`
`engineType`	enum	yes	EngineType is the broker engine. Allowed: `ACTIVEMQ, RABBITMQ`
`engineVersion`	string	—	EngineVersion is the broker engine version (e.g.
`hostInstanceType`	string	yes	HostInstanceType is the broker instance type (e.g.
`providerRef`	object	—	ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
`providerRef.name`	string	yes	Name of a cluster-scoped AWSProvider.
`providerRef.region`	string	—	Region overrides the provider's region for this resource only.
`publiclyAccessible`	boolean	—	PubliclyAccessible enables connections from outside the VPC.
`securityGroupRefs`	array<object>	—	SecurityGroupRefs are the security groups authorizing connections.
`securityGroupRefs[].id`	string	—	ID is a direct AWS Security Group ID (e.g.
`securityGroupRefs[].name`	string	—	Name of a SecurityGroup CR in the same namespace.
`subnetRefs`	array<object>	—	SubnetRefs are the subnets the broker is placed into.
`subnetRefs[].id`	string	—	ID is a direct AWS Subnet ID (e.g.
`subnetRefs[].name`	string	—	Name of a Subnet CR in the same namespace.
`tags`	map<string>	—	Tags are AWS resource tags to apply.
`users`	array<object>	—	Users are the broker users created at provisioning time.
`users[].consoleAccess`	boolean	—	ConsoleAccess enables access to the ActiveMQ Web Console.
`users[].groups`	array<string>	—	Groups is the list of ActiveMQ groups the user belongs to.
`users[].passwordRef`	object	yes	PasswordRef references the Kubernetes Secret holding the user's password.
`users[].passwordRef.key`	string	yes	Key is the key within the Secret whose value to use.
`users[].passwordRef.name`	string	yes	Name of the Kubernetes Secret.
`users[].username`	string	yes	Username of the broker user.

Status

Field	Type	Required	Description
`awsProvider`	object	—	AWSProvider confirms the account and region this resource was reconciled against.
`awsProvider.accountId`	string	—	AccountID the resource lives in.
`awsProvider.name`	string	—	Name of the AWSProvider used; empty when the operator's own credentials were used.
`awsProvider.region`	string	—	Region the resource lives in (empty for global services).
`brokerArn`	string	—	BrokerARN is the ARN of the broker.
`brokerId`	string	—	BrokerID is the unique ID Amazon MQ generates for the broker.
`brokerState`	string	—	BrokerState is the current broker state (e.g.
`conditions`	array<object>	—	Conditions describe the current state of the resource.
`conditions[].lastTransitionTime`	string	yes	lastTransitionTime is the last time the condition transitioned from one status to another.
`conditions[].message`	string	yes	message is a human readable message indicating details about the transition.
`conditions[].observedGeneration`	integer	—	observedGeneration represents the .metadata.generation that the condition was set based upon.
`conditions[].reason`	string	yes	reason contains a programmatic identifier indicating the reason for the condition's last transition.
`conditions[].status`	enum	yes	status of the condition, one of True, False, Unknown. Allowed: `True, False, Unknown`
`conditions[].type`	string	yes	type of condition in CamelCase or in foo.example.com/CamelCase.
`lastSyncTime`	string	—	LastSyncTime is when the resource was last successfully reconciled.
`observedGeneration`	integer	—	ObservedGeneration is the most recent .metadata.generation reconciled.

MQConfiguration # GA

MQConfiguration is the Schema for managing Amazon MQ configurations.

kubectl get mqconfigurations · example on GitHub

Example

# MQConfiguration — Amazon MQ
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/mq.html#mqconfiguration
apiVersion: aws.konfig.io/v1alpha1
kind: MQConfiguration
metadata:
  name: example-mqconfiguration
  namespace: default
spec:
  data: example
  engineType: ACTIVEMQ
  engineVersion: example
  name: example-mqconfiguration
  providerRef:
    name: example-mqconfiguration
    region: us-east-1
  tags:
    environment: dev
    team: platform

Spec

Field	Type	Required	Description
`data`	string	—	Data is the base64-encoded XML configuration (ActiveMQ) or Cuttlefish configuration (RabbitMQ).
`engineType`	enum	yes	EngineType is the broker engine. Allowed: `ACTIVEMQ, RABBITMQ`
`engineVersion`	string	—	EngineVersion is the broker engine version.
`name`	string	yes	Name of the configuration.
`providerRef`	object	—	ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
`providerRef.name`	string	yes	Name of a cluster-scoped AWSProvider.
`providerRef.region`	string	—	Region overrides the provider's region for this resource only.
`tags`	map<string>	—	Tags are AWS resource tags to apply.

Status

Field	Type	Required	Description
`arn`	string	—	ARN is the ARN of the configuration.
`awsProvider`	object	—	AWSProvider confirms the account and region this resource was reconciled against.
`awsProvider.accountId`	string	—	AccountID the resource lives in.
`awsProvider.name`	string	—	Name of the AWSProvider used; empty when the operator's own credentials were used.
`awsProvider.region`	string	—	Region the resource lives in (empty for global services).
`conditions`	array<object>	—	Conditions describe the current state of the resource.
`conditions[].lastTransitionTime`	string	yes	lastTransitionTime is the last time the condition transitioned from one status to another.
`conditions[].message`	string	yes	message is a human readable message indicating details about the transition.
`conditions[].observedGeneration`	integer	—	observedGeneration represents the .metadata.generation that the condition was set based upon.
`conditions[].reason`	string	yes	reason contains a programmatic identifier indicating the reason for the condition's last transition.
`conditions[].status`	enum	yes	status of the condition, one of True, False, Unknown. Allowed: `True, False, Unknown`
`conditions[].type`	string	yes	type of condition in CamelCase or in foo.example.com/CamelCase.
`configurationId`	string	—	ConfigurationID is the unique ID Amazon MQ generates for the configuration.
`lastSyncTime`	string	—	LastSyncTime is when the resource was last successfully reconciled.
`latestRevision`	integer	—	LatestRevision is the latest revision number of the configuration.
`observedGeneration`	integer	—	ObservedGeneration is the most recent .metadata.generation reconciled.