Skip to content

aws.mq.describe_broker

Example SQL Queries

SELECT * FROM
aws.mq.describe_broker
WHERE
"broker_id" = 'VALUE';

Description

Returns information about the specified broker.

Table Definition

Column NameColumn Data Type
broker_id Required Input Column

The unique ID that Amazon MQ generates for the broker.

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
"type" VARCHAR,
"name" VARCHAR,
"account_id" VARCHAR,
"via_profile_name" VARCHAR,
"assumed_role_arn" VARCHAR,
"organization" STRUCT(
"account_name" VARCHAR,
"id" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[],
"master_account" STRUCT(
"id" VARCHAR,
"email" VARCHAR
),
"parents" STRUCT(
"type" VARCHAR,
"id" VARCHAR,
"name" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[]
)[]
)
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
actions_required

Actions required for a broker.

STRUCT(
"action_required_code" VARCHAR,
"action_required_info" VARCHAR
)[]
Show child fields
actions_required[]
Show child fields
actions_required[].action_required_code

The code you can use to find instructions on the action required to resolve your broker issue.

actions_required[].action_required_info

Information about the action required to resolve your broker issue.

authentication_strategy

The authentication strategy used to secure the broker. The default is SIMPLE.

VARCHAR
auto_minor_version_upgrade

Enables automatic upgrades to new patch versions for brokers as new versions are released and supported by Amazon MQ. Automatic upgrades occur during the scheduled maintenance window or after a manual broker reboot.

BOOLEAN
broker_arn

The broker's Amazon Resource Name (ARN).

VARCHAR
broker_instances

A list of information about allocated brokers.

STRUCT(
"console_url" VARCHAR,
"endpoints" VARCHAR[],
"ip_address" VARCHAR
)[]
Show child fields
broker_instances[]
Show child fields
broker_instances[].console_url

The brokers web console URL.

broker_instances[].endpoints[]
broker_instances[].ip_address

The IP address of the Elastic Network Interface (ENI) attached to the broker. Does not apply to RabbitMQ brokers.

broker_name

The broker's name. This value must be unique in your Amazon Web Services account 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.

VARCHAR
broker_state

The broker's status.

VARCHAR
configurations

The list of all revisions for the specified configuration.

STRUCT(
"current" STRUCT(
"id" VARCHAR,
"revision" BIGINT
),
"history" STRUCT(
"id" VARCHAR,
"revision" BIGINT
)[],
"pending" STRUCT(
"id" VARCHAR,
"revision" BIGINT
)
)
Show child fields
configurations.current

The broker's current configuration.

Show child fields
configurations.current.id

Required. The unique ID that Amazon MQ generates for the configuration.

configurations.current.revision

The revision number of the configuration.

configurations.history[]
Show child fields
configurations.history[].id

Required. The unique ID that Amazon MQ generates for the configuration.

configurations.history[].revision

The revision number of the configuration.

configurations.pending

The broker's pending configuration.

Show child fields
configurations.pending.id

Required. The unique ID that Amazon MQ generates for the configuration.

configurations.pending.revision

The revision number of the configuration.

created

The time when the broker was created.

TIMESTAMP_S
data_replication_metadata

The replication details of the data replication-enabled broker. Only returned if dataReplicationMode is set to CRDR.

STRUCT(
"data_replication_counterpart" STRUCT(
"broker_id" VARCHAR,
"region" VARCHAR
),
"data_replication_role" VARCHAR
)
Show child fields
data_replication_metadata.data_replication_counterpart

Describes the replica/primary broker. Only returned if this broker is currently set as a primary or replica in the broker's dataReplicationRole property.

Show child fields
data_replication_metadata.data_replication_counterpart.broker_id

Required. The unique broker id generated by Amazon MQ.

data_replication_metadata.data_replication_counterpart.region

Required. The region of the broker.

data_replication_metadata.data_replication_role

Defines the role of this broker in a data replication pair. When a replica broker is promoted to primary, this role is interchanged.

data_replication_mode

Describes whether this broker is a part of a data replication pair.

VARCHAR
deployment_mode

The broker's deployment mode.

VARCHAR
encryption_options

Encryption options for the broker.

STRUCT(
"kms_key_id" VARCHAR,
"use_aws_owned_key" BOOLEAN
)
Show child fields
encryption_options.kms_key_id

The customer master key (CMK) to use for the A 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.

encryption_options.use_aws_owned_key

Enables the use of an Amazon Web Services owned CMK using KMS (KMS). Set to true by default, if no value is provided, for example, for RabbitMQ brokers.

engine_type

The type of broker engine. Currently, Amazon MQ supports ACTIVEMQ and RABBITMQ.

VARCHAR
engine_version

The broker engine version. For more information, see the ActiveMQ version management and the RabbitMQ version management sections in the Amazon MQ Developer Guide.

VARCHAR
host_instance_type

The broker's instance type.

VARCHAR
ldap_server_metadata

The metadata of the LDAP server used to authenticate and authorize connections to the broker.

STRUCT(
"hosts" VARCHAR[],
"role_base" VARCHAR,
"role_name" VARCHAR,
"role_search_matching" VARCHAR,
"role_search_subtree" BOOLEAN,
"service_account_username" VARCHAR,
"user_base" VARCHAR,
"user_role_name" VARCHAR,
"user_search_matching" VARCHAR,
"user_search_subtree" BOOLEAN
)
Show child fields
ldap_server_metadata.hosts[]
ldap_server_metadata.role_base

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.

ldap_server_metadata.role_name

Specifies the LDAP attribute that identifies the group name attribute in the object returned from the group membership query.

ldap_server_metadata.role_search_matching

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.

ldap_server_metadata.role_search_subtree

The directory search scope for the role. If set to true, scope is to search the entire subtree.

ldap_server_metadata.service_account_username

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.

ldap_server_metadata.user_base

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.

ldap_server_metadata.user_role_name

Specifies the name of the LDAP attribute for the user group membership.

ldap_server_metadata.user_search_matching

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.

ldap_server_metadata.user_search_subtree

The directory search scope for the user. If set to true, scope is to search the entire subtree.

logs

The list of information about logs currently enabled and pending to be deployed for the specified broker.

STRUCT(
"audit" BOOLEAN,
"audit_log_group" VARCHAR,
"general" BOOLEAN,
"general_log_group" VARCHAR,
"pending" STRUCT(
"audit" BOOLEAN,
"general" BOOLEAN
)
)
Show child fields
logs.audit

Enables audit logging. Every user management action made using JMX or the ActiveMQ Web Console is logged.

logs.audit_log_group

The location of the CloudWatch Logs log group where audit logs are sent.

logs.general

Enables general logging.

logs.general_log_group

The location of the CloudWatch Logs log group where general logs are sent.

logs.pending

The list of information about logs pending to be deployed for the specified broker.

Show child fields
logs.pending.audit

Enables audit logging. Every user management action made using JMX or the ActiveMQ Web Console is logged.

logs.pending.general

Enables general logging.

maintenance_window_start_time

The parameters that determine the WeeklyStartTime.

STRUCT(
"day_of_week" VARCHAR,
"time_of_day" VARCHAR,
"time_zone" VARCHAR
)
Show child fields
maintenance_window_start_time.day_of_week

Required. The day of the week.

maintenance_window_start_time.time_of_day

Required. The time, in 24-hour format.

maintenance_window_start_time.time_zone

The time zone, UTC by default, in either the Country/City format, or the UTC offset format.

pending_authentication_strategy

The authentication strategy that will be applied when the broker is rebooted. The default is SIMPLE.

VARCHAR
pending_data_replication_metadata

The pending replication details of the data replication-enabled broker. Only returned if pendingDataReplicationMode is set to CRDR.

STRUCT(
"data_replication_counterpart" STRUCT(
"broker_id" VARCHAR,
"region" VARCHAR
),
"data_replication_role" VARCHAR
)
Show child fields
pending_data_replication_metadata.data_replication_counterpart

Describes the replica/primary broker. Only returned if this broker is currently set as a primary or replica in the broker's dataReplicationRole property.

Show child fields
pending_data_replication_metadata.data_replication_counterpart.broker_id

Required. The unique broker id generated by Amazon MQ.

pending_data_replication_metadata.data_replication_counterpart.region

Required. The region of the broker.

pending_data_replication_metadata.data_replication_role

Defines the role of this broker in a data replication pair. When a replica broker is promoted to primary, this role is interchanged.

pending_data_replication_mode

Describes whether this broker will be a part of a data replication pair after reboot.

VARCHAR
pending_engine_version

The broker engine version to upgrade to. For more information, see the ActiveMQ version management and the RabbitMQ version management sections in the Amazon MQ Developer Guide.

VARCHAR
pending_host_instance_type

The broker's host instance type to upgrade to. For a list of supported instance types, see Broker instance types.

VARCHAR
pending_ldap_server_metadata

The metadata of the LDAP server that will be used to authenticate and authorize connections to the broker after it is rebooted.

STRUCT(
"hosts" VARCHAR[],
"role_base" VARCHAR,
"role_name" VARCHAR,
"role_search_matching" VARCHAR,
"role_search_subtree" BOOLEAN,
"service_account_username" VARCHAR,
"user_base" VARCHAR,
"user_role_name" VARCHAR,
"user_search_matching" VARCHAR,
"user_search_subtree" BOOLEAN
)
Show child fields
pending_ldap_server_metadata.hosts[]
pending_ldap_server_metadata.role_base

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.

pending_ldap_server_metadata.role_name

Specifies the LDAP attribute that identifies the group name attribute in the object returned from the group membership query.

pending_ldap_server_metadata.role_search_matching

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.

pending_ldap_server_metadata.role_search_subtree

The directory search scope for the role. If set to true, scope is to search the entire subtree.

pending_ldap_server_metadata.service_account_username

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.

pending_ldap_server_metadata.user_base

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.

pending_ldap_server_metadata.user_role_name

Specifies the name of the LDAP attribute for the user group membership.

pending_ldap_server_metadata.user_search_matching

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.

pending_ldap_server_metadata.user_search_subtree

The directory search scope for the user. If set to true, scope is to search the entire subtree.

pending_security_groups

The list of pending security groups to authorize connections to brokers.

VARCHAR[]
Show child fields
pending_security_groups[]
publicly_accessible

Enables connections from applications outside of the VPC that hosts the broker's subnets.

BOOLEAN
security_groups

The list of rules (1 minimum, 125 maximum) that authorize connections to brokers.

VARCHAR[]
Show child fields
security_groups[]
storage_type

The broker's storage type.

VARCHAR
subnet_ids

The list of groups that define which subnets and IP ranges the broker can use from different Availability Zones.

VARCHAR[]
Show child fields
subnet_ids[]
tags

The list of all tags associated with this broker.

MAP(VARCHAR, VARCHAR)
users

The list of all broker usernames for the specified broker.

STRUCT(
"pending_change" VARCHAR,
"username" VARCHAR
)[]
Show child fields
users[]
Show child fields
users[].pending_change

The type of change pending for the broker user.

users[].username

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.