describe-broker¶
Description¶
Returns information about the specified broker.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
Synopsis¶
describe-broker
--broker-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
Options¶
--broker-id (string)
The name of the broker. 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 whitespaces, brackets, wildcard characters, or special characters.
--cli-input-json | --cli-input-yaml (string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.
--generate-cli-skeleton (string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.
See ‘aws help’ for descriptions of global parameters.
Output¶
AuthenticationStrategy -> (string)
The authentication strategy used to secure the broker.
AutoMinorVersionUpgrade -> (boolean)
Required. Enables automatic upgrades to new minor versions for brokers, as Apache releases the versions. The automatic upgrades occur during the maintenance window of the broker or after a manual broker reboot.
BrokerArn -> (string)
The Amazon Resource Name (ARN) of the broker.
BrokerId -> (string)
The unique ID that Amazon MQ generates for the broker.
BrokerInstances -> (list)
A list of information about allocated brokers.
(structure)
Returns information about all brokers.
ConsoleURL -> (string)
The URL of the broker’s Web Console.
Endpoints -> (list)
The broker’s wire-level protocol endpoints.
(string)
IpAddress -> (string)
The IP address of the Elastic Network Interface (ENI) attached to the broker. Does not apply to RabbitMQ brokers
BrokerName -> (string)
The name of the broker. 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 whitespaces, brackets, wildcard characters, or special characters.
BrokerState -> (string)
The status of the broker.
Configurations -> (structure)
The list of all revisions for the specified configuration.
Current -> (structure)
The current configuration of the broker.
Id -> (string)
Required. The unique ID that Amazon MQ generates for the configuration.
Revision -> (integer)
The revision number of the configuration.
History -> (list)
The history of configurations applied to the broker.
(structure)
A list of information about the configuration.
Warning
Does not apply to RabbitMQ brokers.
Id -> (string)
Required. The unique ID that Amazon MQ generates for the configuration.
Revision -> (integer)
The revision number of the configuration.
Pending -> (structure)
The pending configuration of the broker.
Id -> (string)
Required. The unique ID that Amazon MQ generates for the configuration.
Revision -> (integer)
The revision number of the configuration.
Created -> (timestamp)
The time when the broker was created.
DeploymentMode -> (string)
Required. The deployment mode of the broker.
EncryptionOptions -> (structure)
Encryption options for the broker.
KmsKeyId -> (string)
The symmetric 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.
UseAwsOwnedKey -> (boolean)
Enables the use of an AWS owned CMK using AWS Key Management Service (KMS).
EngineType -> (string)
Required. The type of broker engine. Note: Currently, Amazon MQ supports ACTIVEMQ and RABBITMQ.
EngineVersion -> (string)
The version of the broker engine. For a list of supported engine versions, see https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.html
HostInstanceType -> (string)
The broker’s instance type.
LdapServerMetadata -> (structure)
The metadata of the LDAP server used to authenticate and authorize connections to the broker.
Hosts -> (list)
Fully qualified domain name of the LDAP server. Optional failover server.
(string)
RoleBase -> (string)
Fully qualified name of the directory to search for a user’s groups.
RoleName -> (string)
Specifies the LDAP attribute that identifies the group name attribute in the object returned from the group membership query.
RoleSearchMatching -> (string)
The search criteria for groups.
RoleSearchSubtree -> (boolean)
The directory search scope for the role. If set to true, scope is to search the entire sub-tree.
ServiceAccountUsername -> (string)
Service account username.
UserBase -> (string)
Fully qualified name of the directory where you want to search for users.
UserRoleName -> (string)
Specifies the name of the LDAP attribute for the user group membership.
UserSearchMatching -> (string)
The search criteria for users.
UserSearchSubtree -> (boolean)
The directory search scope for the user. If set to true, scope is to search the entire sub-tree.
Logs -> (structure)
The list of information about logs currently enabled and pending to be deployed for the specified broker.
Audit -> (boolean)
Enables audit logging. Every user management action made using JMX or the ActiveMQ Web Console is logged.
AuditLogGroup -> (string)
The location of the CloudWatch Logs log group where audit logs are sent.
General -> (boolean)
Enables general logging.
GeneralLogGroup -> (string)
The location of the CloudWatch Logs log group where general logs are sent.
Pending -> (structure)
The list of information about logs pending to be deployed for the specified broker.
Audit -> (boolean)
Enables audit logging. Every user management action made using JMX or the ActiveMQ Web Console is logged.
General -> (boolean)
Enables general logging.
MaintenanceWindowStartTime -> (structure)
The parameters that determine the WeeklyStartTime.
DayOfWeek -> (string)
Required. The day of the week.
TimeOfDay -> (string)
Required. The time, in 24-hour format.
TimeZone -> (string)
The time zone, UTC by default, in either the Country/City format, or the UTC offset format.
PendingAuthenticationStrategy -> (string)
The authentication strategy that will be applied when the broker is rebooted.
PendingEngineVersion -> (string)
The version of the broker engine to upgrade to. For a list of supported engine versions, see https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.html
PendingHostInstanceType -> (string)
The host instance type of the broker to upgrade to. For a list of supported instance types, see https://docs.aws.amazon.com/amazon-mq/latest/developer-guide//broker.html#broker-instance-types
PendingLdapServerMetadata -> (structure)
The metadata of the LDAP server that will be used to authenticate and authorize connections to the broker once it is rebooted.
Hosts -> (list)
Fully qualified domain name of the LDAP server. Optional failover server.
(string)
RoleBase -> (string)
Fully qualified name of the directory to search for a user’s groups.
RoleName -> (string)
Specifies the LDAP attribute that identifies the group name attribute in the object returned from the group membership query.
RoleSearchMatching -> (string)
The search criteria for groups.
RoleSearchSubtree -> (boolean)
The directory search scope for the role. If set to true, scope is to search the entire sub-tree.
ServiceAccountUsername -> (string)
Service account username.
UserBase -> (string)
Fully qualified name of the directory where you want to search for users.
UserRoleName -> (string)
Specifies the name of the LDAP attribute for the user group membership.
UserSearchMatching -> (string)
The search criteria for users.
UserSearchSubtree -> (boolean)
The directory search scope for the user. If set to true, scope is to search the entire sub-tree.
PendingSecurityGroups -> (list)
The list of pending security groups to authorize connections to brokers.
(string)
PubliclyAccessible -> (boolean)
Required. Enables connections from applications outside of the VPC that hosts the broker’s subnets.
SecurityGroups -> (list)
The list of security groups (1 minimum, 5 maximum) that authorizes connections to brokers.
(string)
StorageType -> (string)
The broker’s storage type.
SubnetIds -> (list)
The list of groups that define which subnets and IP ranges the broker can use from different Availability Zones. A SINGLE_INSTANCE deployment requires one subnet (for example, the default subnet). An ACTIVE_STANDBY_MULTI_AZ deployment (ACTIVEMQ) requires two subnets. A CLUSTER_MULTI_AZ deployment (RABBITMQ) has no subnet requirements when deployed with public accessibility, deployment without public accessibility requires at least one subnet.
(string)
Tags -> (map)
The list of all tags associated with this broker.
key -> (string)
value -> (string)
Users -> (list)
The list of all broker usernames for the specified broker.
(structure)
Returns a list of all broker users.
PendingChange -> (string)
The type of change pending for the broker user.
Username -> (string)
Required. The username of the broker user. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.