Broker

mq.services.k8s.aws/v1alpha1

TypeLink
GoDocmq-controller/apis/v1alpha1#Broker

Metadata

PropertyValue
ScopeNamespaced
KindBroker
ListKindBrokerList
Pluralbrokers
Singularbroker

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
FieldDescription
authenticationStrategy
Optional
string
autoMinorVersionUpgrade
Required
boolean
configuration
Optional
object
A list of information about the configuration.

Does not apply to RabbitMQ brokers.
configuration.id
Optional
string
configuration.revision
Optional
integer
creatorRequestID
Optional
string
deploymentMode
Required
string
encryptionOptions
Optional
object
Does not apply to RabbitMQ brokers.

Encryption options for the broker.
encryptionOptions.kmsKeyID
Optional
string
encryptionOptions.useAWSOwnedKey
Optional
boolean
engineType
Required
string
engineVersion
Required
string
hostInstanceType
Required
string
ldapServerMetadata
Optional
object
Optional. The metadata of the LDAP server used to authenticate and authorize
connections to the broker.

Does not apply to RabbitMQ brokers.
ldapServerMetadata.hosts
Optional
array
ldapServerMetadata.hosts.[]
Required
string
ldapServerMetadata.roleName
Optional
string
ldapServerMetadata.roleSearchMatching
Optional
string
ldapServerMetadata.roleSearchSubtree
Optional
boolean
ldapServerMetadata.serviceAccountPassword
Optional
string
ldapServerMetadata.serviceAccountUsername
Optional
string
ldapServerMetadata.userBase
Optional
string
ldapServerMetadata.userRoleName
Optional
string
ldapServerMetadata.userSearchMatching
Optional
string
ldapServerMetadata.userSearchSubtree
Optional
boolean
logs
Optional
object
The list of information about logs to be enabled for the specified broker.
logs.audit
Optional
boolean
logs.general
Optional
boolean
maintenanceWindowStartTime
Optional
object
The scheduled time period relative to UTC during which Amazon MQ begins to
apply pending updates or patches to the broker.
maintenanceWindowStartTime.dayOfWeek
Optional
string
maintenanceWindowStartTime.timeOfDay
Optional
string
maintenanceWindowStartTime.timeZone
Optional
string
name
Required
string
publiclyAccessible
Required
boolean
securityGroupRefs
Optional
array
securityGroupRefs.[]
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 || **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
| | securityGroups.[]
Required | string
|| storageType
Optional | string
| | subnetIDs
Optional | array
| | 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
| | users
Required | array
| | users.[]
Required | object
A user associated with the broker. 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
FieldDescription
ackResourceMetadata
Optional
object
All CRs managed by ACK have a common Status.ACKResourceMetadata member
that is used to contain resource sync state, account ownership,
constructed ARN for the resource
ackResourceMetadata.arn
Optional
string
ARN is the Amazon Resource Name for the resource. This is a
globally-unique identifier and is set only by the ACK service controller
once the controller has orchestrated the creation of the resource OR
when it has verified that an “adopted” resource (a resource where the
ARN annotation was set by the Kubernetes user on the CR) exists and
matches the supplied CR’s Spec field values.
https://github.com/aws/aws-controllers-k8s/issues/270
ackResourceMetadata.ownerAccountID
Required
string
OwnerAccountID is the AWS Account ID of the account that owns the
backend AWS service API resource.
ackResourceMetadata.region
Required
string
Region is the AWS region in which the resource exists or will exist.
brokerID
Optional
string
brokerInstances
Optional
array
brokerInstances.[]
Required
object
Returns information about all brokers.
brokerInstances.[].endpoints
Optional
array
brokerInstances.[].endpoints.[]
Required
string
brokerState
Optional
string
conditions
Optional
array
All CRS managed by ACK have a common Status.Conditions member that
contains a collection of ackv1alpha1.Condition objects that describe
the various terminal states of the CR and its backend AWS service API
resource
conditions.[]
Required
object
Condition is the common struct used by all CRDs managed by ACK service
controllers to indicate terminal states of the CR and its backend AWS
service API resource
conditions.[].message
Optional
string
A human readable message indicating details about the transition.
conditions.[].reason
Optional
string
The reason for the condition’s last transition.
conditions.[].status
Optional
string
Status of the condition, one of True, False, Unknown.
conditions.[].type
Optional
string
Type is the type of the Condition