String actionRequiredCode
The code you can use to resolve your broker issue when the broker is in a CRITICAL_ACTION_REQUIRED state. You can find instructions by choosing the link for your code from the list of action required codes in Amazon MQ action required codes. Each code references a topic with detailed information, instructions, and recommendations for how to resolve the issue and prevent future occurrences.
String actionRequiredInfo
Information about the action required to resolve your broker issue when the broker is in a CRITICAL_ACTION_REQUIRED state.
String name
Id for the availability zone.
String errorAttribute
The attribute which caused the error.
List<E> availabilityZones
The list of available az.
String engineType
The broker's engine type.
String hostInstanceType
The broker's instance type.
String storageType
The broker's storage type.
List<E> supportedDeploymentModes
The list of supported deployment modes.
List<E> supportedEngineVersions
The list of supported engine versions.
String brokerArn
The broker's Amazon Resource Name (ARN).
String brokerId
The unique ID that Amazon MQ generates for the broker.
String brokerName
The broker's name. This value is unique in your AWS account, 1-50 characters long, and containing only letters, numbers, dashes, and underscores, and must not contain white spaces, brackets, wildcard characters, or special characters.
String brokerState
The broker's status.
Date created
The time when the broker was created.
String deploymentMode
The broker's deployment mode.
String engineType
The type of broker engine.
String hostInstanceType
The broker's instance type.
String arn
Required. The ARN of the configuration.
String authenticationStrategy
Optional. The authentication strategy associated with the configuration. The default is SIMPLE.
Date created
Required. The date and time of the configuration revision.
String description
Required. The description of the configuration.
String engineType
Required. The type of broker engine. Currently, Amazon MQ supports ACTIVEMQ and RABBITMQ.
String engineVersion
Required. The broker engine's version. For a list of supported engine versions, see, Supported engines.
String id
Required. The unique ID that Amazon MQ generates for the configuration.
ConfigurationRevision latestRevision
Required. The latest revision of the configuration.
String name
Required. The name of the configuration. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 1-150 characters long.
Map<K,V> tags
The list of all tags associated with this configuration.
ConfigurationId current
The broker's current configuration.
List<E> history
The history of configurations applied to the broker.
ConfigurationId pending
The broker's pending configuration.
String errorAttribute
The attribute which caused the error.
String authenticationStrategy
Optional. The authentication strategy used to secure the broker. The default is SIMPLE.
Boolean 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.
String 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.
ConfigurationId configuration
A list of information about the configuration.
String 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.
String deploymentMode
Required. The broker's deployment mode.
EncryptionOptions encryptionOptions
Encryption options for the broker. Does not apply to RabbitMQ brokers.
String engineType
Required. The type of broker engine. Currently, Amazon MQ supports ACTIVEMQ and RABBITMQ.
String engineVersion
Required. The broker engine's version. For a list of supported engine versions, see Supported engines.
String hostInstanceType
Required. The broker's instance type.
LdapServerMetadataInput ldapServerMetadata
Optional. The metadata of the LDAP server used to authenticate and authorize connections to the broker. Does not apply to RabbitMQ brokers.
Logs logs
Enables Amazon CloudWatch logging for brokers.
WeeklyStartTime maintenanceWindowStartTime
The parameters that determine the WeeklyStartTime.
Boolean 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.
List<E> securityGroups
The list of rules (1 minimum, 125 maximum) that authorize connections to brokers.
String storageType
The broker's storage type.
List<E> 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.
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.
Map<K,V> tags
Create tags when creating the broker.
List<E> users
Required. The list of broker users (persons or applications) who can access queues and topics. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.
When you create an Amazon MQ for RabbitMQ broker, 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.
String authenticationStrategy
Optional. The authentication strategy associated with the configuration. The default is SIMPLE.
String engineType
Required. The type of broker engine. Currently, Amazon MQ supports ACTIVEMQ and RABBITMQ.
String engineVersion
Required. The broker engine's version. For a list of supported engine versions, see Supported engines.
String name
Required. The name of the configuration. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 1-150 characters long.
Map<K,V> tags
Create tags when creating the configuration.
String arn
Required. The Amazon Resource Name (ARN) of the configuration.
String authenticationStrategy
Optional. The authentication strategy associated with the configuration. The default is SIMPLE.
Date created
Required. The date and time of the configuration.
String id
Required. The unique ID that Amazon MQ generates for the configuration.
ConfigurationRevision latestRevision
The latest revision of the configuration.
String name
Required. The name of the configuration. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 1-150 characters long.
String brokerId
The unique ID that Amazon MQ generates for the broker.
Boolean consoleAccess
Enables access to the ActiveMQ Web Console for the ActiveMQ user.
List<E> 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.
String 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 (,:=).
String username
The username of the ActiveMQ user. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.
String brokerId
The unique ID that Amazon MQ generates for the broker.
String brokerId
The unique ID that Amazon MQ generates for the broker.
String engineType
Filter response by engine type.
Integer maxResults
The maximum number of brokers that Amazon MQ can return per page (20 by default). This value must be an integer from 5 to 100.
String nextToken
The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.
List<E> brokerEngineTypes
List of available engine types and versions.
Integer maxResults
Required. The maximum number of engine types that can be returned per page (20 by default). This value must be an integer from 5 to 100.
String nextToken
The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.
String engineType
Filter response by engine type.
String hostInstanceType
Filter response by host instance type.
Integer maxResults
The maximum number of brokers that Amazon MQ can return per page (20 by default). This value must be an integer from 5 to 100.
String nextToken
The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.
String storageType
Filter response by storage type.
List<E> brokerInstanceOptions
List of available broker instance options.
Integer maxResults
Required. The maximum number of instance options that can be returned per page (20 by default). This value must be an integer from 5 to 100.
String nextToken
The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.
String brokerId
The unique ID that Amazon MQ generates for the broker.
List<E> actionsRequired
A list of actions required for a broker.
String authenticationStrategy
The authentication strategy used to secure the broker. The default is SIMPLE.
Boolean 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.
String brokerArn
The broker's Amazon Resource Name (ARN).
String brokerId
The unique ID that Amazon MQ generates for the broker.
List<E> brokerInstances
A list of information about allocated brokers.
String brokerName
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.
String brokerState
The broker's status.
Configurations configurations
The list of all revisions for the specified configuration.
Date created
The time when the broker was created.
String deploymentMode
The broker's deployment mode.
EncryptionOptions encryptionOptions
Encryption options for the broker. Does not apply to RabbitMQ brokers.
String engineType
The type of broker engine. Currently, Amazon MQ supports ACTIVEMQ and RABBITMQ.
String engineVersion
The broker engine's version. For a list of supported engine versions, see Supported engines.
String hostInstanceType
The broker's instance type.
LdapServerMetadataOutput ldapServerMetadata
The metadata of the LDAP server used to authenticate and authorize connections to the broker.
LogsSummary logs
The list of information about logs currently enabled and pending to be deployed for the specified broker.
WeeklyStartTime maintenanceWindowStartTime
The parameters that determine the WeeklyStartTime.
String pendingAuthenticationStrategy
The authentication strategy that will be applied when the broker is rebooted. The default is SIMPLE.
String pendingEngineVersion
The broker engine version to upgrade to. For a list of supported engine versions, see Supported engines.
String pendingHostInstanceType
The broker's host instance type to upgrade to. For a list of supported instance types, see Broker instance types.
LdapServerMetadataOutput pendingLdapServerMetadata
The metadata of the LDAP server that will be used to authenticate and authorize connections to the broker after it is rebooted.
List<E> pendingSecurityGroups
The list of pending security groups to authorize connections to brokers.
Boolean publiclyAccessible
Enables connections from applications outside of the VPC that hosts the broker's subnets.
List<E> securityGroups
The list of rules (1 minimum, 125 maximum) that authorize connections to brokers.
String storageType
The broker's storage type.
List<E> subnetIds
The list of groups that define which subnets and IP ranges the broker can use from different Availability Zones.
Map<K,V> tags
The list of all tags associated with this broker.
List<E> users
The list of all broker usernames for the specified broker.
String configurationId
The unique ID that Amazon MQ generates for the configuration.
String arn
Required. The ARN of the configuration.
String authenticationStrategy
Optional. The authentication strategy associated with the configuration. The default is SIMPLE.
Date created
Required. The date and time of the configuration revision.
String description
Required. The description of the configuration.
String engineType
Required. The type of broker engine. Currently, Amazon MQ supports ACTIVEMQ and RABBITMQ.
String engineVersion
Required. The broker engine's version. For a list of supported engine versions, see, Supported engines.
String id
Required. The unique ID that Amazon MQ generates for the configuration.
ConfigurationRevision latestRevision
Required. The latest revision of the configuration.
String name
Required. The name of the configuration. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 1-150 characters long.
Map<K,V> tags
The list of all tags associated with this configuration.
String configurationId
Required. The unique ID that Amazon MQ generates for the configuration.
Date created
Required. The date and time of the configuration.
String data
Required. The base64-encoded XML configuration.
String description
The description of the configuration.
String brokerId
Required. The unique ID that Amazon MQ generates for the broker.
Boolean consoleAccess
Enables access to the the ActiveMQ Web Console for the ActiveMQ user.
List<E> 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.
UserPendingChanges pending
The status of the changes pending for the ActiveMQ user.
String username
Required. The username of the ActiveMQ user. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.
String kmsKeyId
The customer master key (CMK) to use for the AWS Key Management Service (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.
Boolean useAwsOwnedKey
Enables the use of an AWS owned CMK using AWS Key Management Service (KMS). Set to true by default, if no value is provided, for example, for RabbitMQ brokers.
String name
Id for the version.
String errorAttribute
The attribute which caused the error.
String errorAttribute
The attribute which caused the error.
List<E> hosts
Specifies the location of the LDAP server such as AWS Directory Service for Microsoft Active Directory . Optional failover server.
String 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.
String roleName
Specifies the LDAP attribute that identifies the group name attribute in the object returned from the group membership query.
String 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.
Boolean roleSearchSubtree
The directory search scope for the role. If set to true, scope is to search the entire subtree.
String 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.
String 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.
String 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.
String userRoleName
Specifies the name of the LDAP attribute for the user group membership.
String 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.
Boolean userSearchSubtree
The directory search scope for the user. If set to true, scope is to search the entire subtree.
List<E> hosts
Specifies the location of the LDAP server such as AWS Directory Service for Microsoft Active Directory . Optional failover server.
String 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.
String roleName
Specifies the LDAP attribute that identifies the group name attribute in the object returned from the group membership query.
String 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.
Boolean roleSearchSubtree
The directory search scope for the role. If set to true, scope is to search the entire subtree.
String 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.
String 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.
String userRoleName
Specifies the name of the LDAP attribute for the user group membership.
String 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.
Boolean userSearchSubtree
The directory search scope for the user. If set to true, scope is to search the entire subtree.
Integer maxResults
The maximum number of brokers that Amazon MQ can return per page (20 by default). This value must be an integer from 5 to 100.
String nextToken
The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.
String configurationId
The unique ID that Amazon MQ generates for the configuration.
Integer maxResults
The maximum number of brokers that Amazon MQ can return per page (20 by default). This value must be an integer from 5 to 100.
String nextToken
The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.
String configurationId
The unique ID that Amazon MQ generates for the configuration.
Integer maxResults
The maximum number of configuration revisions that can be returned per page (20 by default). This value must be an integer from 5 to 100.
String nextToken
The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.
List<E> revisions
The list of all revisions for the specified configuration.
Integer maxResults
The maximum number of brokers that Amazon MQ can return per page (20 by default). This value must be an integer from 5 to 100.
String nextToken
The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.
List<E> configurations
The list of all revisions for the specified configuration.
Integer maxResults
The maximum number of configurations that Amazon MQ can return per page (20 by default). This value must be an integer from 5 to 100.
String nextToken
The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.
String resourceArn
The Amazon Resource Name (ARN) of the resource tag.
String brokerId
The unique ID that Amazon MQ generates for the broker.
Integer maxResults
The maximum number of brokers that Amazon MQ can return per page (20 by default). This value must be an integer from 5 to 100.
String nextToken
The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.
String brokerId
Required. The unique ID that Amazon MQ generates for the broker.
Integer maxResults
Required. The maximum number of ActiveMQ users that can be returned per page (20 by default). This value must be an integer from 5 to 100.
String nextToken
The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.
List<E> users
Required. The list of all ActiveMQ usernames for the specified broker. Does not apply to RabbitMQ brokers.
Boolean audit
Enables audit logging. Every user management action made using JMX or the ActiveMQ Web Console is logged.
String auditLogGroup
The location of the CloudWatch Logs log group where audit logs are sent.
Boolean general
Enables general logging.
String generalLogGroup
The location of the CloudWatch Logs log group where general logs are sent.
PendingLogs pending
The list of information about logs pending to be deployed for the specified broker.
String errorAttribute
The attribute which caused the error.
String brokerId
The unique ID that Amazon MQ generates for the broker.
String errorAttribute
The attribute which caused the error.
String authenticationStrategy
Optional. The authentication strategy used to secure the broker. The default is SIMPLE.
Boolean 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.
String brokerId
The unique ID that Amazon MQ generates for the broker.
ConfigurationId configuration
A list of information about the configuration.
String engineVersion
The broker engine version. For a list of supported engine versions, see Supported engines.
String hostInstanceType
The broker's host instance type to upgrade to. For a list of supported instance types, see Broker instance types.
LdapServerMetadataInput ldapServerMetadata
Optional. The metadata of the LDAP server used to authenticate and authorize connections to the broker. Does not apply to RabbitMQ brokers.
Logs logs
Enables Amazon CloudWatch logging for brokers.
WeeklyStartTime maintenanceWindowStartTime
The parameters that determine the WeeklyStartTime.
List<E> securityGroups
The list of security groups (1 minimum, 5 maximum) that authorizes connections to brokers.
String authenticationStrategy
Optional. The authentication strategy used to secure the broker. The default is SIMPLE.
Boolean autoMinorVersionUpgrade
The new boolean value that specifies whether broker engines automatically upgrade to new minor versions as new versions are released and supported by Amazon MQ.
String brokerId
Required. The unique ID that Amazon MQ generates for the broker.
ConfigurationId configuration
The ID of the updated configuration.
String engineVersion
The broker engine version to upgrade to. For a list of supported engine versions, see Supported engines.
String hostInstanceType
The broker's host instance type to upgrade to. For a list of supported instance types, see Broker instance types.
LdapServerMetadataOutput ldapServerMetadata
Optional. The metadata of the LDAP server used to authenticate and authorize connections to the broker. Does not apply to RabbitMQ brokers.
Logs logs
The list of information about logs to be enabled for the specified broker.
WeeklyStartTime maintenanceWindowStartTime
The parameters that determine the WeeklyStartTime.
List<E> securityGroups
The list of security groups (1 minimum, 5 maximum) that authorizes connections to brokers.
String arn
Required. The Amazon Resource Name (ARN) of the configuration.
Date created
Required. The date and time of the configuration.
String id
Required. The unique ID that Amazon MQ generates for the configuration.
ConfigurationRevision latestRevision
The latest revision of the configuration.
String name
Required. The name of the configuration. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 1-150 characters long.
List<E> warnings
The list of the first 20 warnings about the configuration XML elements or attributes that were sanitized.
String brokerId
The unique ID that Amazon MQ generates for the broker.
Boolean consoleAccess
Enables access to the the ActiveMQ Web Console for the ActiveMQ user.
List<E> 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.
String password
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 (,:=).
String username
The username of the ActiveMQ user. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.
Boolean consoleAccess
Enables access to the ActiveMQ Web Console for the ActiveMQ user. Does not apply to RabbitMQ brokers.
List<E> 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.
String 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 (,:=).
String username
important>
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.
Boolean consoleAccess
Enables access to the the ActiveMQ Web Console for the ActiveMQ user.
List<E> 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.
String pendingChange
Required. The type of change pending for the ActiveMQ user.
Copyright © 2022. All rights reserved.