AWS.MQ — AWS SDK for JavaScript (original) (raw)

We recommend that you migrate to AWS SDK for JavaScript v3. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

Class: AWS.MQ

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

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.

Sending a Request Using MQ

var mq = new AWS.MQ();
mq.createBroker(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the MQ object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var mq = new AWS.MQ({apiVersion: '2017-11-27'});

You can also set the API version globally in AWS.config.apiVersions using the mq service identifier:

AWS.config.apiVersions = {
  mq: '2017-11-27',
  // other service API versions
};

var mq = new AWS.MQ();

Constructor Summarycollapse

Property Summarycollapse

Properties inherited from AWS.Service

apiVersions

Method Summarycollapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.MQ(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Property Details

endpoint ⇒ AWS.Endpoint

Returns an Endpoint object representing the endpoint URL for service requests.

Method Details

createBroker(params = {}, callback) ⇒ AWS.Request

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.

For more information, see Create an IAM User and Get Your Amazon Web Services Credentials and Never Modify or Delete the Amazon MQ Elastic Network Interface in the Amazon MQ Developer Guide.

createConfiguration(params = {}, callback) ⇒ AWS.Request

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

createUser(params = {}, callback) ⇒ AWS.Request

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.

deleteBroker(params = {}, callback) ⇒ AWS.Request

Deletes a broker. Note: This API is asynchronous.

deleteTags(params = {}, callback) ⇒ AWS.Request

Removes a tag from a resource.

deleteUser(params = {}, callback) ⇒ AWS.Request

Deletes an ActiveMQ user.

describeBroker(params = {}, callback) ⇒ AWS.Request

Returns information about the specified broker.

describeBrokerEngineTypes(params = {}, callback) ⇒ AWS.Request

Describe available engine types and versions.

describeBrokerInstanceOptions(params = {}, callback) ⇒ AWS.Request

Describe available broker instance options.

describeConfiguration(params = {}, callback) ⇒ AWS.Request

Returns information about the specified configuration.

describeConfigurationRevision(params = {}, callback) ⇒ AWS.Request

Returns the specified configuration revision for the specified configuration.

describeUser(params = {}, callback) ⇒ AWS.Request

Returns information about an ActiveMQ user.

listBrokers(params = {}, callback) ⇒ AWS.Request

Returns a list of all brokers.

listConfigurationRevisions(params = {}, callback) ⇒ AWS.Request

Returns a list of all revisions for the specified configuration.

listConfigurations(params = {}, callback) ⇒ AWS.Request

Returns a list of all configurations.

listTags(params = {}, callback) ⇒ AWS.Request

Lists tags for a resource.

listUsers(params = {}, callback) ⇒ AWS.Request

Returns a list of all ActiveMQ users.

promote(params = {}, callback) ⇒ AWS.Request

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

rebootBroker(params = {}, callback) ⇒ AWS.Request

Reboots a broker. Note: This API is asynchronous.

updateBroker(params = {}, callback) ⇒ AWS.Request

Adds a pending configuration change to a broker.

updateConfiguration(params = {}, callback) ⇒ AWS.Request

Updates the specified configuration.

updateUser(params = {}, callback) ⇒ AWS.Request

Updates the information for an ActiveMQ user.