A list of information about the configuration.
Important
Does not apply to RabbitMQ brokers.
id
Required. The unique ID that Amazon MQ generates for the configuration.
Type: string Required: True
revision
The revision number of the configuration.
Type: integer Required: False
CreateBrokerInput
Creates a broker.
engineVersion
Required. The broker engine's version. For a list of supported engine versions, see Supported engines.
Type: string Required: True
deploymentMode
Required. The broker's deployment mode.
Properties
Type: DeploymentMode (p. 46) Required: True
maintenanceWindowStartTime
The parameters that determine the WeeklyStartTime.
Type: WeeklyStartTime (p. 50) Required: False
configuration
A list of information about the configuration.
Type: ConfigurationId (p. 42) Required: False
authenticationStrategy
Optional. The authentication strategy used to secure the broker. The default is SIMPLE.
Type: AuthenticationStrategy (p. 40) Required: False
engineType
Required. The type of broker engine. Currently, Amazon MQ supports ACTIVEMQ and RABBITMQ.
Type: EngineType (p. 46) Required: True
hostInstanceType
Required. The broker's instance type.
Type: string Required: True
users
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.
Type: Array of type User (p. 49) Required: True
tags
Create tags when creating the broker.
Type: object
Required: False
creatorRequestId
The unique ID that the requester receives for the created broker. Amazon MQ passes your ID with the API action.
Note
We recommend using a Universally Unique Identifier (UUID) for the creatorRequestId. You may omit the creatorRequestId if your application doesn't require idempotency.
Type: string Required: False
publiclyAccessible
Enables connections from applications outside of the VPC that hosts the broker's subnets. Set to false by default, if no value is provided.
Type: boolean Required: True
encryptionOptions
Encryption options for the broker. Does not apply to RabbitMQ brokers.
Type: EncryptionOptions (p. 46) Required: False
storageType
The broker's storage type.
Type: BrokerStorageType (p. 41) Required: False
securityGroups
The list of rules (1 minimum, 125 maximum) that authorize connections to brokers.
Type: Array of type string Required: False
brokerName
Required. The broker's name. This value must be unique in your AWS account, 1-50 characters long, must contain only letters, numbers, dashes, and underscores, and must not contain white spaces, brackets, wildcard characters, or special characters.
Important
Do not add personally identifiable information (PII) or other confidential or sensitive information in broker names. Broker names are accessible to other AWS services, including CloudWatch Logs. Broker names are not intended to be used for private or sensitive data.
Type: string Required: True
Properties
logs
Enables Amazon CloudWatch logging for brokers.
Type: Logs (p. 49) Required: False
ldapServerMetadata
Optional. The metadata of the LDAP server used to authenticate and authorize connections to the broker. Does not apply to RabbitMQ brokers.
Type: LdapServerMetadataInput (p. 47) Required: False
autoMinorVersionUpgrade
Enables automatic upgrades to new minor versions for brokers, as new versions are released and supported by Amazon MQ. Automatic upgrades occur during the scheduled maintenance window of the broker or after a manual broker reboot. Set to true by default, if no value is specified.
Type: boolean Required: True
subnetIds
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.
Important
If you specify subnets in a shared VPC for a RabbitMQ broker, the associated VPC to which the specified subnets belong must be owned by your AWS account. Amazon MQ will not be able to create VPC endpoints in VPCs that are not owned by your AWS account.
Type: Array of type string Required: False
CreateBrokerOutput
Returns information about the created broker.
brokerArn
The broker's Amazon Resource Name (ARN).
Type: string Required: False
brokerId
The unique ID that Amazon MQ generates for the broker.
Type: string Required: False
DeploymentMode
The broker's deployment mode.
SINGLE_INSTANCE
ACTIVE_STANDBY_MULTI_AZ CLUSTER_MULTI_AZ
EncryptionOptions
Important
Does not apply to RabbitMQ brokers.
Encryption options for the broker.
useAwsOwnedKey
Enables the use of an AWS owned CMK using AWS KMS (KMS). Set to true by default, if no value is provided, for example, for RabbitMQ brokers.
Type: boolean Required: True
kmsKeyId
The customer master key (CMK) to use for the A AWS KMS (KMS). This key is used to encrypt your data at rest. If not provided, Amazon MQ will use a default CMK to encrypt your data.
Type: string Required: False
EngineType
The type of broker engine. Amazon MQ supports ActiveMQ and RabbitMQ.
ACTIVEMQ RABBITMQ
Error
Returns information about an error.
errorAttribute
The attribute which caused the error.
Type: string Required: False
message
The explanation of the error.
Properties
Type: string Required: False
LdapServerMetadataInput
Optional. The metadata of the LDAP server used to authenticate and authorize connections to the broker.
Important
Does not apply to RabbitMQ brokers.
roleSearchMatching
The LDAP search filter used to find roles within the roleBase. The distinguished name of the user matched by userSearchMatching is substituted into the {0} placeholder in the search filter.
The client's username is substituted into the {1} placeholder. For example, if you set this option to (member=uid={1})for the user janedoe, the search filter becomes (member=uid=janedoe) after string substitution. It matches all role entries that have a member attribute equal to uid=janedoe under the subtree selected by the roleBase.
Type: string Required: True
serviceAccountPassword
Service account password. A service account is an account in your LDAP server that has access to initiate a connection. For example, cn=admin,dc=corp, dc=example, dc=com.
Type: string Required: True
roleBase
The distinguished name of the node in the directory information tree (DIT) to search for roles or groups.
For example, ou=group, ou=corp, dc=corp, dc=example, dc=com.
Type: string Required: True
hosts
Specifies the location of the LDAP server such as AWS Directory Service for Microsoft Active Directory.
Optional failover server.
Type: Array of type string Required: True
roleName
Specifies the LDAP attribute that identifies the group name attribute in the object returned from the group membership query.
Type: string Required: False
userBase
Select a particular subtree of the directory information tree (DIT) to search for user entries. The subtree is specified by a DN, which specifies the base node of the subtree. For example, by setting this option to ou=Users,ou=corp, dc=corp, dc=example, dc=com, the search for user entries is restricted to the subtree beneath ou=Users, ou=corp, dc=corp, dc=example, dc=com.
Type: string Required: True
roleSearchSubtree
The directory search scope for the role. If set to true, scope is to search the entire subtree.
Type: boolean Required: False
serviceAccountUsername
Service account username. A service account is an account in your LDAP server that has access to initiate a connection. For example, cn=admin,dc=corp, dc=example, dc=com.
Type: string Required: True
userRoleName
Specifies the name of the LDAP attribute for the user group membership.
Type: string Required: False
userSearchMatching
The LDAP search filter used to find users within the userBase. The client's username is substituted into the {0} placeholder in the search filter. For example, if this option is set to (uid={0}) and the received username is janedoe, the search filter becomes (uid=janedoe) after string substitution. It will result in matching an entry like uid=janedoe, ou=Users,ou=corp, dc=corp, dc=example, dc=com.
Type: string Required: True
userSearchSubtree
The directory search scope for the user. If set to true, scope is to search the entire subtree.
Type: boolean Required: False
ListBrokersOutput
brokerSummaries
A list of information about all brokers.
Properties
Type: Array of type BrokerSummary (p. 41) Required: False
nextToken
The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.
Type: string Required: False
Logs
The list of information about logs to be enabled for the specified broker.
general
Enables general logging.
Type: boolean Required: False
audit
Enables audit logging. Every user management action made using JMX or the ActiveMQ Web Console is logged. Does not apply to RabbitMQ brokers.
Type: boolean Required: False
User
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.
password
Required. The password of the user. This value must be at least 12 characters long, must contain at least 4 unique characters, and must not contain commas, colons, or equal signs (,:=).
Type: string Required: True Format: password
groups
The list of groups (20 maximum) to which the ActiveMQ user belongs. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long. Does not apply to RabbitMQ brokers.
Type: Array of type string Required: False
consoleAccess
Enables access to the ActiveMQ Web Console for the ActiveMQ user. Does not apply to RabbitMQ brokers.
Type: boolean Required: False
username
The username of the broker user. The following restrictions apply to broker usernames:
• For Amazon MQ for ActiveMQ brokers, this value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.
• For Amazon MQ for RabbitMQ brokers, this value can contain only alphanumeric characters, dashes, periods, underscores (- . _). This value must not contain a tilde (~) character. Amazon MQ prohibts using guest as a valid usename. This value must be 2-100 characters long.
Important
Do not add personally identifiable information (PII) or other confidential or sensitive information in broker usernames. Broker usernames are accessible to other AWS services, including CloudWatch Logs. Broker usernames are not intended to be used for private or sensitive data.
Type: string Required: True
WeeklyStartTime
The scheduled time period relative to UTC during which Amazon MQ begins to apply pending updates or patches to the broker.
dayOfWeek
Required. The day of the week.
Type: string Required: True
Values: MONDAY | TUESDAY | WEDNESDAY | THURSDAY | FRIDAY | SATURDAY | SUNDAY
timeZone
The time zone, UTC by default, in either the Country/City format, or the UTC offset format.
Type: string Required: False
timeOfDay
Required. The time, in 24-hour format.
Type: string Required: True
See also
See also
For more information about using this API in one of the language-specific AWS SDKs and references, see the following:
ListBrokers
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
CreateBroker
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3