Amazon MQ is a managed message broker service for Apache ActiveMQ and RabbitMQ that makes it easy to set up and operate message brokers in the cloud. A message broker allows software applications and components to communicate using various programming languages, operating systems, and formal messaging protocols.

Installation

NPM
npm install @aws-sdk/client-mq
Yarn
yarn add @aws-sdk/client-mq
pnpm
pnpm add @aws-sdk/client-mq

MqClient Operations

Command
Summary
CreateBrokerCommand

Creates a broker. Note: This API is asynchronous.

To create a broker, you must either use the AmazonMQFullAccess IAM policy or include the following EC2 permissions in your IAM policy.

  • ec2:CreateNetworkInterface

    This permission is required to allow Amazon MQ to create an elastic network interface (ENI) on behalf of your account.

  • ec2:CreateNetworkInterfacePermission

    This permission is required to attach the ENI to the broker instance.

  • ec2:DeleteNetworkInterface

  • ec2:DeleteNetworkInterfacePermission

  • ec2:DetachNetworkInterface

  • ec2:DescribeInternetGateways

  • ec2:DescribeNetworkInterfaces

  • ec2:DescribeNetworkInterfacePermissions

  • ec2:DescribeRouteTables

  • ec2:DescribeSecurityGroups

  • ec2:DescribeSubnets

  • ec2:DescribeVpcs

CreateConfigurationCommand

Creates a new configuration for the specified configuration name. Amazon MQ uses the default configuration (the engine type and version).

CreateTagsCommand

Add a tag to a resource.

CreateUserCommand

Creates an ActiveMQ user.

Do not add personally identifiable information (PII) or other confidential or sensitive information in broker usernames. Broker usernames are accessible to other Amazon Web Services services, including CloudWatch Logs. Broker usernames are not intended to be used for private or sensitive data.

DeleteBrokerCommand

Deletes a broker. Note: This API is asynchronous.

DeleteTagsCommand

Removes a tag from a resource.

DeleteUserCommand

Deletes an ActiveMQ user.

DescribeBrokerCommand

Returns information about the specified broker.

DescribeBrokerEngineTypesCommand

Describe available engine types and versions.

DescribeBrokerInstanceOptionsCommand

Describe available broker instance options.

DescribeConfigurationCommand

Returns information about the specified configuration.

DescribeConfigurationRevisionCommand

Returns the specified configuration revision for the specified configuration.

DescribeUserCommand

Returns information about an ActiveMQ user.

ListBrokersCommand

Returns a list of all brokers.

ListConfigurationRevisionsCommand

Returns a list of all revisions for the specified configuration.

ListConfigurationsCommand

Returns a list of all configurations.

ListTagsCommand

Lists tags for a resource.

ListUsersCommand

Returns a list of all ActiveMQ users.

PromoteCommand

Promotes a data replication replica broker to the primary broker role.

RebootBrokerCommand

Reboots a broker. Note: This API is asynchronous.

UpdateBrokerCommand

Adds a pending configuration change to a broker.

UpdateConfigurationCommand

Updates the specified configuration.

UpdateUserCommand

Updates the information for an ActiveMQ user.

MqClient Configuration

Parameter
Type
Description
defaultsMode
Optional
DefaultsMode | Provider<DefaultsMode>
The @smithy/smithy-client#DefaultsMode that will be used to determine how certain default configuration options are resolved in the SDK.
disableHostPrefix
Optional
boolean
Disable dynamically changing the endpoint of the client based on the hostPrefix trait of an operation.
extensions
Optional
RuntimeExtension[]
Optional extensions
logger
Optional
Logger
Optional logger for logging debug/info/warn/error.
maxAttempts
Optional
number | Provider<number>
Value for how many times a request will be made at most in case of retry.
profile
Optional
string
Setting a client profile is similar to setting a value for the AWS_PROFILE environment variable. Setting a profile on a client in code only affects the single client instance, unlike AWS_PROFILE.When set, and only for environments where an AWS configuration file exists, fields configurable by this file will be retrieved from the specified profile within that file. Conflicting code configuration and environment variables will still have higher priority.For client credential resolution that involves checking the AWS configuration file, the client's profile (this value) will be used unless a different profile is set in the credential provider options.
region
Optional
string | Provider<string>
The AWS region to which this client will send requests
requestHandler
Optional
__HttpHandlerUserInput
The HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs.
retryMode
Optional
string | Provider<string>
Specifies which retry algorithm to use.
useDualstackEndpoint
Optional
boolean | Provider<boolean>
Enables IPv6/IPv4 dualstack endpoint.
useFipsEndpoint
Optional
boolean | Provider<boolean>
Enables FIPS compatible endpoints.
Additional config fields are described in the full configuration type: MqClientConfig