Broker

mq.services.k8s.aws/v1alpha1

Metadata#

Spec#

authenticationStrategy: string
autoMinorVersionUpgrade: boolean
configuration: 
  id: string
  revision: integer
creatorRequestID: string
deploymentMode: string
encryptionOptions: 
  kmsKeyID: string
  useAWSOwnedKey: boolean
engineType: string
engineVersion: string
hostInstanceType: string
ldapServerMetadata: 
  hosts:
  - string
  roleBase: string
  roleName: string
  roleSearchMatching: string
  roleSearchSubtree: boolean
  serviceAccountPassword: string
  serviceAccountUsername: string
  userBase: string
  userRoleName: string
  userSearchMatching: string
  userSearchSubtree: boolean
logs: 
  audit: boolean
  general: boolean
maintenanceWindowStartTime: 
  dayOfWeek: string
  timeOfDay: string
  timeZone: string
name: string
publiclyAccessible: boolean
securityGroupRefs:
  from: 
    name: string
    namespace: string
securityGroups:
- string
storageType: string
subnetIDs:
- string
subnetRefs:
  from: 
    name: string
    namespace: string
tags: {}
users:
- consoleAccess: boolean
  groups:
  - string
  password: 
    key: string
    name: string
    namespace: string
  username: string

from:
  name: my-api || **securityGroupRefs.[].from**<br/>Optional | **object**<br/>AWSResourceReference provides all the values necessary to reference another<br/>k8s resource for finding the identifier(Id/ARN/Name) |

| securityGroupRefs.[].from.name
Optional | string
| | securityGroupRefs.[].from.namespace
Optional | string
| | securityGroups
Optional | array
The list of rules (1 minimum, 125 maximum) that authorize connections to
brokers. | | securityGroups.[]
Required | string
|| storageType
Optional | string
The broker’s storage type. | | subnetIDs
Optional | array
The list of groups that define which subnets and IP ranges the broker can
use from different Availability Zones. If you specify more than one subnet,
the subnets must be in different Availability Zones. Amazon MQ will not be
able to create VPC endpoints for your broker with multiple subnets in the
same Availability Zone. A SINGLE_INSTANCE deployment requires one subnet
(for example, the default subnet). An ACTIVE_STANDBY_MULTI_AZ Amazon MQ for
ActiveMQ deployment requires two subnets. A CLUSTER_MULTI_AZ Amazon MQ for
RabbitMQ deployment has no subnet requirements when deployed with public
accessibility. Deployment without public accessibility requires at least
one subnet.

If you specify subnets in a shared VPC (https://docs.aws.amazon.com/vpc/latest/userguide/vpc-sharing.html)
for a RabbitMQ broker, the associated VPC to which the specified subnets
belong must be owned by your Amazon Web Services account. Amazon MQ will
not be able to create VPC endpoints in VPCs that are not owned by your Amazon
Web Services account. | | subnetIDs.[]
Required | string
|| subnetRefs
Optional | array
| | subnetRefs.[]
Required | object
AWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference type to provide more user friendly syntax for references using ‘from’ field Ex: APIIDRef:

from:
  name: my-api || **subnetRefs.[].from**<br/>Optional | **object**<br/>AWSResourceReference provides all the values necessary to reference another<br/>k8s resource for finding the identifier(Id/ARN/Name) |

| subnetRefs.[].from.name
Optional | string
| | subnetRefs.[].from.namespace
Optional | string
| | tags
Optional | object
Create tags when creating the broker. | | users
Required | array
The list of broker users (persons or applications) who can access queues
and topics. For Amazon MQ for RabbitMQ brokers, one and only one administrative
user is accepted and created when a broker is first provisioned. All subsequent
broker users are created by making RabbitMQ API calls directly to brokers
or via the RabbitMQ web console. | | users.[]
Required | object
A user associated with the broker. For Amazon MQ for RabbitMQ brokers, one and only one administrative user is accepted and created when a broker is first provisioned. All subsequent broker users are created by making RabbitMQ API calls directly to brokers or via the RabbitMQ web console. || users.[].consoleAccess
Optional | boolean
| | users.[].groups
Optional | array
| | users.[].groups.[]
Required | string
|| users.[].password
Optional | object
SecretKeyReference combines a k8s corev1.SecretReference with a
specific key within the referred-to Secret | | users.[].password.key
Required | string
Key is the key within the secret | | users.[].password.name
Optional | string
name is unique within a namespace to reference a secret resource. | | users.[].password.namespace
Optional | string
namespace defines the space within which the secret name must be unique. | | users.[].username
Optional | string
|

Status#

ackResourceMetadata: 
  arn: string
  ownerAccountID: string
  region: string
brokerID: string
brokerInstances:
- consoleURL: string
  endpoints:
  - string
  ipAddress: string
brokerState: string
conditions:
- lastTransitionTime: string
  message: string
  reason: string
  status: string
  type: string