You are viewing the documentation for an older major version of the AWS SDK for JavaScript.
The modular AWS SDK for JavaScript (v3), the latest major version of AWS SDK for JavaScript, is now stable and recommended for general use. For more information, see the Migration Guide and API Reference.

Class: AWS.MQ

Inherits:
AWS.Service show all
Identifier:
mq
API Version:
2017-11-27
Defined in:
(unknown)

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();

Version:

  • 2017-11-27

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

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.

Examples:

Constructing a MQ object

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

Options Hash (options):

  • params (map)

    An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.

  • endpoint (String|AWS.Endpoint)

    The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com' or an Endpoint object.

  • accessKeyId (String)

    your AWS access key ID.

  • secretAccessKey (String)

    your AWS secret access key.

  • sessionToken (AWS.Credentials)

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials)

    the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.

  • credentialProvider (AWS.CredentialProviderChain)

    the provider chain used to resolve credentials if no static credentials property is set.

  • region (String)

    the region to send service requests to. See AWS.MQ.region for more information.

  • maxRetries (Integer)

    the maximum amount of retries to attempt with a request. See AWS.MQ.maxRetries for more information.

  • maxRedirects (Integer)

    the maximum amount of redirects to follow with a request. See AWS.MQ.maxRedirects for more information.

  • sslEnabled (Boolean)

    whether to enable SSL for requests.

  • paramValidation (Boolean|map)

    whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:

    • min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
    • max [Boolean] — Validates that a value meets the max constraint.
    • pattern [Boolean] — Validates that a string value matches a regular expression.
    • enum [Boolean] — Validates that a string value matches one of the allowable enum values.
  • computeChecksums (Boolean)

    whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)

  • convertResponseTypes (Boolean)

    whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.

  • correctClockSkew (Boolean)

    whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.

  • s3ForcePathStyle (Boolean)

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean)

    whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.

  • s3DisableBodySigning (Boolean)

    whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.

  • s3UsEast1RegionalEndpoint ('legacy'|'regional')

    when region is set to 'us-east-1', whether to send s3 request to global endpoints or 'us-east-1' regional endpoints. This config is only applicable to S3 client. Defaults to legacy

  • s3UseArnRegion (Boolean)

    whether to override the request region with the region inferred from requested resource's ARN. Only available for S3 buckets Defaults to true

  • retryDelayOptions (map)

    A set of options to configure the retry delay on retryable errors. Currently supported options are:

    • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
    • customBackoff [function] — A custom function that accepts a retry count and error and returns the amount of time to delay in milliseconds. If the result is a non-zero negative value, no further retry attempts will be made. The base option will be ignored if this option is supplied. The function is only called for retryable errors.
  • httpOptions (map)

    A set of options to pass to the low-level HTTP request. Currently supported options are:

    • proxy [String] — the URL to proxy requests through
    • agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
    • connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
    • timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
    • xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
    • xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
  • apiVersion (String, Date)

    a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.

  • apiVersions (map<String, String|Date>)

    a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.

  • logger (#write, #log)

    an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests

  • systemClockOffset (Number)

    an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.

  • signatureVersion (String)

    the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.

  • signatureCache (Boolean)

    whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.

  • dynamoDbCrc32 (Boolean)

    whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.

  • useAccelerateEndpoint (Boolean)

    Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.

  • clientSideMonitoring (Boolean)

    whether to collect and publish this client's performance metrics of all its API requests.

  • endpointDiscoveryEnabled (Boolean|undefined)

    whether to call operations with endpoints given by service dynamically. Setting this

  • endpointCacheSize (Number)

    the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000

  • hostPrefixEnabled (Boolean)

    whether to marshal request parameters to the prefix of hostname. Defaults to true.

  • stsRegionalEndpoints ('legacy'|'regional')

    whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.

  • useFipsEndpoint (Boolean)

    Enables FIPS compatible endpoints. Defaults to false.

  • useDualstackEndpoint (Boolean)

    Enables IPv6 dualstack endpoint. Defaults to false.

Property Details

endpointAWS.Endpoint (readwrite)

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

Returns:

  • (AWS.Endpoint)

    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.

  • 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

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

Service Reference:

Examples:

Calling the createBroker operation

var params = {
  AutoMinorVersionUpgrade: true || false, /* required */
  BrokerName: 'STRING_VALUE', /* required */
  DeploymentMode: SINGLE_INSTANCE | ACTIVE_STANDBY_MULTI_AZ | CLUSTER_MULTI_AZ, /* required */
  EngineType: ACTIVEMQ | RABBITMQ, /* required */
  EngineVersion: 'STRING_VALUE', /* required */
  HostInstanceType: 'STRING_VALUE', /* required */
  PubliclyAccessible: true || false, /* required */
  Users: [ /* required */
    {
      Password: 'STRING_VALUE', /* required */
      Username: 'STRING_VALUE', /* required */
      ConsoleAccess: true || false,
      Groups: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  AuthenticationStrategy: SIMPLE | LDAP,
  Configuration: {
    Id: 'STRING_VALUE', /* required */
    Revision: 'NUMBER_VALUE'
  },
  CreatorRequestId: 'STRING_VALUE',
  EncryptionOptions: {
    UseAwsOwnedKey: true || false, /* required */
    KmsKeyId: 'STRING_VALUE'
  },
  LdapServerMetadata: {
    Hosts: [ /* required */
      'STRING_VALUE',
      /* more items */
    ],
    RoleBase: 'STRING_VALUE', /* required */
    RoleSearchMatching: 'STRING_VALUE', /* required */
    ServiceAccountPassword: 'STRING_VALUE', /* required */
    ServiceAccountUsername: 'STRING_VALUE', /* required */
    UserBase: 'STRING_VALUE', /* required */
    UserSearchMatching: 'STRING_VALUE', /* required */
    RoleName: 'STRING_VALUE',
    RoleSearchSubtree: true || false,
    UserRoleName: 'STRING_VALUE',
    UserSearchSubtree: true || false
  },
  Logs: {
    Audit: true || false,
    General: true || false
  },
  MaintenanceWindowStartTime: {
    DayOfWeek: MONDAY | TUESDAY | WEDNESDAY | THURSDAY | FRIDAY | SATURDAY | SUNDAY, /* required */
    TimeOfDay: 'STRING_VALUE', /* required */
    TimeZone: 'STRING_VALUE'
  },
  SecurityGroups: [
    'STRING_VALUE',
    /* more items */
  ],
  StorageType: EBS | EFS,
  SubnetIds: [
    'STRING_VALUE',
    /* more items */
  ],
  Tags: {
    '<__string>': 'STRING_VALUE',
    /* '<__string>': ... */
  }
};
mq.createBroker(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • AuthenticationStrategy — (String)

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

      Possible values include:
      • "SIMPLE"
      • "LDAP"
    • AutoMinorVersionUpgrade — (Boolean)

      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.

    • BrokerName — (String)

      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.

    • Configuration — (map)

      A list of information about the configuration.

      • Idrequired — (String)

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

      • Revision — (Integer)

        The revision number of the configuration.

    • CreatorRequestId — (String)

      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.

      If a token is not provided, the SDK will use a version 4 UUID.
    • DeploymentMode — (String)

      Required. The broker's deployment mode.

      Possible values include:
      • "SINGLE_INSTANCE"
      • "ACTIVE_STANDBY_MULTI_AZ"
      • "CLUSTER_MULTI_AZ"
    • EncryptionOptions — (map)

      Encryption options for the broker. Does not apply to RabbitMQ brokers.

      • KmsKeyId — (String)

        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.

      • UseAwsOwnedKeyrequired — (Boolean)

        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.

    • EngineType — (String)

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

      Possible values include:
      • "ACTIVEMQ"
      • "RABBITMQ"
    • EngineVersion — (String)

      Required. The broker engine's version. For a list of supported engine versions, see Supported engines.

    • HostInstanceType — (String)

      Required. The broker's instance type.

    • LdapServerMetadata — (map)

      Optional. The metadata of the LDAP server used to authenticate and authorize connections to the broker. Does not apply to RabbitMQ brokers.

      • Hostsrequired — (Array<String>)

        Specifies the location of the LDAP server such as AWS Directory Service for Microsoft Active Directory . Optional failover server.

      • RoleBaserequired — (String)

        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.

      • RoleName — (String)

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

      • RoleSearchMatchingrequired — (String)

        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.

      • RoleSearchSubtree — (Boolean)

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

      • ServiceAccountPasswordrequired — (String)

        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.

      • ServiceAccountUsernamerequired — (String)

        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.

      • UserBaserequired — (String)

        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.

      • UserRoleName — (String)

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

      • UserSearchMatchingrequired — (String)

        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.

      • UserSearchSubtree — (Boolean)

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

    • Logs — (map)

      Enables Amazon CloudWatch logging for brokers.

      • Audit — (Boolean)

        Enables audit logging. Every user management action made using JMX or the ActiveMQ Web Console is logged. Does not apply to RabbitMQ brokers.

      • General — (Boolean)

        Enables general logging.

    • MaintenanceWindowStartTime — (map)

      The parameters that determine the WeeklyStartTime.

      • DayOfWeekrequired — (String)

        Required. The day of the week.

        Possible values include:
        • "MONDAY"
        • "TUESDAY"
        • "WEDNESDAY"
        • "THURSDAY"
        • "FRIDAY"
        • "SATURDAY"
        • "SUNDAY"
      • TimeOfDayrequired — (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.

    • PubliclyAccessible — (Boolean)

      Enables connections from applications outside of the VPC that hosts the broker's subnets. Set to false by default, if no value is provided.

    • SecurityGroups — (Array<String>)

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

    • StorageType — (String)

      The broker's storage type.

      Possible values include:
      • "EBS"
      • "EFS"
    • SubnetIds — (Array<String>)

      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.

    • Tags — (map<String>)

      Create tags when creating the broker.

    • Users — (Array<map>)

      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.

      Amazon MQ for RabbitMQ

      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.

      • ConsoleAccess — (Boolean)

        Enables access to the ActiveMQ Web Console for the ActiveMQ user. Does not apply to RabbitMQ brokers.

      • Groups — (Array<String>)

        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.

      • Passwordrequired — (String)

        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 (,:=).

      • Usernamerequired — (String)

        important>Amazon MQ for ActiveMQ For ActiveMQ brokers, this value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.

        /important> Amazon MQ for RabbitMQ

        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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • BrokerArn — (String)

        The broker's Amazon Resource Name (ARN).

      • BrokerId — (String)

        The unique ID that Amazon MQ generates for the broker.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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).

Service Reference:

Examples:

Calling the createConfiguration operation

var params = {
  EngineType: ACTIVEMQ | RABBITMQ, /* required */
  EngineVersion: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE', /* required */
  AuthenticationStrategy: SIMPLE | LDAP,
  Tags: {
    '<__string>': 'STRING_VALUE',
    /* '<__string>': ... */
  }
};
mq.createConfiguration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • AuthenticationStrategy — (String)

      Optional. The authentication strategy associated with the configuration. The default is SIMPLE.

      Possible values include:
      • "SIMPLE"
      • "LDAP"
    • EngineType — (String)

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

      Possible values include:
      • "ACTIVEMQ"
      • "RABBITMQ"
    • EngineVersion — (String)

      Required. The broker engine's version. For a list of supported engine versions, see Supported engines.

    • Name — (String)

      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.

    • Tags — (map<String>)

      Create tags when creating the configuration.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Arn — (String)

        Required. The Amazon Resource Name (ARN) of the configuration.

      • AuthenticationStrategy — (String)

        Optional. The authentication strategy associated with the configuration. The default is SIMPLE.

        Possible values include:
        • "SIMPLE"
        • "LDAP"
      • Created — (Date)

        Required. The date and time of the configuration.

      • Id — (String)

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

      • LatestRevision — (map)

        The latest revision of the configuration.

        • Createdrequired — (Date)

          Required. The date and time of the configuration revision.

        • Description — (String)

          The description of the configuration revision.

        • Revisionrequired — (Integer)

          Required. The revision number of the configuration.

      • Name — (String)

        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.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Add a tag to a resource.

Service Reference:

Examples:

Calling the createTags operation

var params = {
  ResourceArn: 'STRING_VALUE', /* required */
  Tags: {
    '<__string>': 'STRING_VALUE',
    /* '<__string>': ... */
  }
};
mq.createTags(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ResourceArn — (String)

      The Amazon Resource Name (ARN) of the resource tag.

    • Tags — (map<String>)

      The key-value pair for the resource tag.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Creates an ActiveMQ user.

Service Reference:

Examples:

Calling the createUser operation

var params = {
  BrokerId: 'STRING_VALUE', /* required */
  Password: 'STRING_VALUE', /* required */
  Username: 'STRING_VALUE', /* required */
  ConsoleAccess: true || false,
  Groups: [
    'STRING_VALUE',
    /* more items */
  ]
};
mq.createUser(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • BrokerId — (String)

      The unique ID that Amazon MQ generates for the broker.

    • ConsoleAccess — (Boolean)

      Enables access to the ActiveMQ Web Console for the ActiveMQ user.

    • Groups — (Array<String>)

      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.

    • Password — (String)

      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 (,:=).

    • Username — (String)

      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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Deletes a broker. Note: This API is asynchronous.

Service Reference:

Examples:

Calling the deleteBroker operation

var params = {
  BrokerId: 'STRING_VALUE' /* required */
};
mq.deleteBroker(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • BrokerId — (String)

      The unique ID that Amazon MQ generates for the broker.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • BrokerId — (String)

        The unique ID that Amazon MQ generates for the broker.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Removes a tag from a resource.

Service Reference:

Examples:

Calling the deleteTags operation

var params = {
  ResourceArn: 'STRING_VALUE', /* required */
  TagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
mq.deleteTags(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ResourceArn — (String)

      The Amazon Resource Name (ARN) of the resource tag.

    • TagKeys — (Array<String>)

      An array of tag keys to delete

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Deletes an ActiveMQ user.

Service Reference:

Examples:

Calling the deleteUser operation

var params = {
  BrokerId: 'STRING_VALUE', /* required */
  Username: 'STRING_VALUE' /* required */
};
mq.deleteUser(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • BrokerId — (String)

      The unique ID that Amazon MQ generates for the broker.

    • Username — (String)

      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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Returns information about the specified broker.

Service Reference:

Examples:

Calling the describeBroker operation

var params = {
  BrokerId: 'STRING_VALUE' /* required */
};
mq.describeBroker(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • BrokerId — (String)

      The unique ID that Amazon MQ generates for the broker.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • AuthenticationStrategy — (String)

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

        Possible values include:
        • "SIMPLE"
        • "LDAP"
      • AutoMinorVersionUpgrade — (Boolean)

        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.

      • BrokerArn — (String)

        The broker's Amazon Resource Name (ARN).

      • BrokerId — (String)

        The unique ID that Amazon MQ generates for the broker.

      • BrokerInstances — (Array<map>)

        A list of information about allocated brokers.

        • ConsoleURL — (String)

          The brokers web console URL.

        • Endpoints — (Array<String>)

          The broker's wire-level protocol endpoints.

        • IpAddress — (String)

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

      • BrokerName — (String)

        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.

      • BrokerState — (String)

        The broker's status.

        Possible values include:
        • "CREATION_IN_PROGRESS"
        • "CREATION_FAILED"
        • "DELETION_IN_PROGRESS"
        • "RUNNING"
        • "REBOOT_IN_PROGRESS"
      • Configurations — (map)

        The list of all revisions for the specified configuration.

        • Current — (map)

          The broker's current configuration.

          • Idrequired — (String)

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

          • Revision — (Integer)

            The revision number of the configuration.

        • History — (Array<map>)

          The history of configurations applied to the broker.

          • Idrequired — (String)

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

          • Revision — (Integer)

            The revision number of the configuration.

        • Pending — (map)

          The broker's pending configuration.

          • Idrequired — (String)

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

          • Revision — (Integer)

            The revision number of the configuration.

      • Created — (Date)

        The time when the broker was created.

      • DeploymentMode — (String)

        The broker's deployment mode.

        Possible values include:
        • "SINGLE_INSTANCE"
        • "ACTIVE_STANDBY_MULTI_AZ"
        • "CLUSTER_MULTI_AZ"
      • EncryptionOptions — (map)

        Encryption options for the broker. Does not apply to RabbitMQ brokers.

        • KmsKeyId — (String)

          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.

        • UseAwsOwnedKeyrequired — (Boolean)

          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.

      • EngineType — (String)

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

        Possible values include:
        • "ACTIVEMQ"
        • "RABBITMQ"
      • EngineVersion — (String)

        The broker engine's version. For a list of supported engine versions, see Supported engines.

      • HostInstanceType — (String)

        The broker's instance type.

      • LdapServerMetadata — (map)

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

        • Hostsrequired — (Array<String>)

          Specifies the location of the LDAP server such as AWS Directory Service for Microsoft Active Directory . Optional failover server.

        • RoleBaserequired — (String)

          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.

        • RoleName — (String)

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

        • RoleSearchMatchingrequired — (String)

          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.

        • RoleSearchSubtree — (Boolean)

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

        • ServiceAccountUsernamerequired — (String)

          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.

        • UserBaserequired — (String)

          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.

        • UserRoleName — (String)

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

        • UserSearchMatchingrequired — (String)

          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.

        • UserSearchSubtree — (Boolean)

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

      • Logs — (map)

        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.

        • Generalrequired — (Boolean)

          Enables general logging.

        • GeneralLogGrouprequired — (String)

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

        • Pending — (map)

          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 — (map)

        The parameters that determine the WeeklyStartTime.

        • DayOfWeekrequired — (String)

          Required. The day of the week.

          Possible values include:
          • "MONDAY"
          • "TUESDAY"
          • "WEDNESDAY"
          • "THURSDAY"
          • "FRIDAY"
          • "SATURDAY"
          • "SUNDAY"
        • TimeOfDayrequired — (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. The default is SIMPLE.

        Possible values include:
        • "SIMPLE"
        • "LDAP"
      • PendingEngineVersion — (String)

        The broker engine version to upgrade to. For a list of supported engine versions, see Supported engines.

      • PendingHostInstanceType — (String)

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

      • PendingLdapServerMetadata — (map)

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

        • Hostsrequired — (Array<String>)

          Specifies the location of the LDAP server such as AWS Directory Service for Microsoft Active Directory . Optional failover server.

        • RoleBaserequired — (String)

          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.

        • RoleName — (String)

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

        • RoleSearchMatchingrequired — (String)

          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.

        • RoleSearchSubtree — (Boolean)

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

        • ServiceAccountUsernamerequired — (String)

          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.

        • UserBaserequired — (String)

          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.

        • UserRoleName — (String)

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

        • UserSearchMatchingrequired — (String)

          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.

        • UserSearchSubtree — (Boolean)

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

      • PendingSecurityGroups — (Array<String>)

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

      • PubliclyAccessible — (Boolean)

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

      • SecurityGroups — (Array<String>)

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

      • StorageType — (String)

        The broker's storage type.

        Possible values include:
        • "EBS"
        • "EFS"
      • SubnetIds — (Array<String>)

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

      • Tags — (map<String>)

        The list of all tags associated with this broker.

      • Users — (Array<map>)

        The list of all broker usernames for the specified broker.

        • PendingChange — (String)

          The type of change pending for the broker user.

          Possible values include:
          • "CREATE"
          • "UPDATE"
          • "DELETE"
        • Usernamerequired — (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.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Describe available engine types and versions.

Service Reference:

Examples:

Calling the describeBrokerEngineTypes operation

var params = {
  EngineType: 'STRING_VALUE',
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
mq.describeBrokerEngineTypes(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • EngineType — (String)

      Filter response by engine type.

    • MaxResults — (Integer)

      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.

    • NextToken — (String)

      The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • BrokerEngineTypes — (Array<map>)

        List of available engine types and versions.

        • EngineType — (String)

          The broker's engine type.

          Possible values include:
          • "ACTIVEMQ"
          • "RABBITMQ"
        • EngineVersions — (Array<map>)

          The list of engine versions.

          • Name — (String)

            Id for the version.

      • MaxResults — (Integer)

        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.

      • NextToken — (String)

        The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Describe available broker instance options.

Service Reference:

Examples:

Calling the describeBrokerInstanceOptions operation

var params = {
  EngineType: 'STRING_VALUE',
  HostInstanceType: 'STRING_VALUE',
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  StorageType: 'STRING_VALUE'
};
mq.describeBrokerInstanceOptions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • EngineType — (String)

      Filter response by engine type.

    • HostInstanceType — (String)

      Filter response by host instance type.

    • MaxResults — (Integer)

      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.

    • NextToken — (String)

      The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.

    • StorageType — (String)

      Filter response by storage type.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • BrokerInstanceOptions — (Array<map>)

        List of available broker instance options.

        • AvailabilityZones — (Array<map>)

          The list of available az.

          • Name — (String)

            Id for the availability zone.

        • EngineType — (String)

          The broker's engine type.

          Possible values include:
          • "ACTIVEMQ"
          • "RABBITMQ"
        • HostInstanceType — (String)

          The broker's instance type.

        • StorageType — (String)

          The broker's storage type.

          Possible values include:
          • "EBS"
          • "EFS"
        • SupportedDeploymentModes — (Array<String>)

          The list of supported deployment modes.

        • SupportedEngineVersions — (Array<String>)

          The list of supported engine versions.

      • MaxResults — (Integer)

        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.

      • NextToken — (String)

        The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Returns information about the specified configuration.

Service Reference:

Examples:

Calling the describeConfiguration operation

var params = {
  ConfigurationId: 'STRING_VALUE' /* required */
};
mq.describeConfiguration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ConfigurationId — (String)

      The unique ID that Amazon MQ generates for the configuration.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Arn — (String)

        Required. The ARN of the configuration.

      • AuthenticationStrategy — (String)

        Optional. The authentication strategy associated with the configuration. The default is SIMPLE.

        Possible values include:
        • "SIMPLE"
        • "LDAP"
      • Created — (Date)

        Required. The date and time of the configuration revision.

      • Description — (String)

        Required. The description of the configuration.

      • EngineType — (String)

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

        Possible values include:
        • "ACTIVEMQ"
        • "RABBITMQ"
      • EngineVersion — (String)

        Required. The broker engine's version. For a list of supported engine versions, see, Supported engines.

      • Id — (String)

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

      • LatestRevision — (map)

        Required. The latest revision of the configuration.

        • Createdrequired — (Date)

          Required. The date and time of the configuration revision.

        • Description — (String)

          The description of the configuration revision.

        • Revisionrequired — (Integer)

          Required. The revision number of the configuration.

      • Name — (String)

        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.

      • Tags — (map<String>)

        The list of all tags associated with this configuration.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Returns the specified configuration revision for the specified configuration.

Service Reference:

Examples:

Calling the describeConfigurationRevision operation

var params = {
  ConfigurationId: 'STRING_VALUE', /* required */
  ConfigurationRevision: 'STRING_VALUE' /* required */
};
mq.describeConfigurationRevision(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ConfigurationId — (String)

      The unique ID that Amazon MQ generates for the configuration.

    • ConfigurationRevision — (String)

      The revision of the configuration.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ConfigurationId — (String)

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

      • Created — (Date)

        Required. The date and time of the configuration.

      • Data — (String)

        Required. The base64-encoded XML configuration.

      • Description — (String)

        The description of the configuration.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Returns information about an ActiveMQ user.

Service Reference:

Examples:

Calling the describeUser operation

var params = {
  BrokerId: 'STRING_VALUE', /* required */
  Username: 'STRING_VALUE' /* required */
};
mq.describeUser(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • BrokerId — (String)

      The unique ID that Amazon MQ generates for the broker.

    • Username — (String)

      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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • BrokerId — (String)

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

      • ConsoleAccess — (Boolean)

        Enables access to the the ActiveMQ Web Console for the ActiveMQ user.

      • Groups — (Array<String>)

        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.

      • Pending — (map)

        The status of the changes pending for the ActiveMQ user.

        • ConsoleAccess — (Boolean)

          Enables access to the the ActiveMQ Web Console for the ActiveMQ user.

        • Groups — (Array<String>)

          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.

        • PendingChangerequired — (String)

          Required. The type of change pending for the ActiveMQ user.

          Possible values include:
          • "CREATE"
          • "UPDATE"
          • "DELETE"
      • Username — (String)

        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.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Returns a list of all brokers.

Service Reference:

Examples:

Calling the listBrokers operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
mq.listBrokers(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • MaxResults — (Integer)

      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.

    • NextToken — (String)

      The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • BrokerSummaries — (Array<map>)

        A list of information about all brokers.

        • BrokerArn — (String)

          The broker's Amazon Resource Name (ARN).

        • BrokerId — (String)

          The unique ID that Amazon MQ generates for the broker.

        • BrokerName — (String)

          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.

        • BrokerState — (String)

          The broker's status.

          Possible values include:
          • "CREATION_IN_PROGRESS"
          • "CREATION_FAILED"
          • "DELETION_IN_PROGRESS"
          • "RUNNING"
          • "REBOOT_IN_PROGRESS"
        • Created — (Date)

          The time when the broker was created.

        • DeploymentModerequired — (String)

          The broker's deployment mode.

          Possible values include:
          • "SINGLE_INSTANCE"
          • "ACTIVE_STANDBY_MULTI_AZ"
          • "CLUSTER_MULTI_AZ"
        • EngineTyperequired — (String)

          The type of broker engine.

          Possible values include:
          • "ACTIVEMQ"
          • "RABBITMQ"
        • HostInstanceType — (String)

          The broker's instance type.

      • NextToken — (String)

        The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Returns a list of all revisions for the specified configuration.

Service Reference:

Examples:

Calling the listConfigurationRevisions operation

var params = {
  ConfigurationId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
mq.listConfigurationRevisions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ConfigurationId — (String)

      The unique ID that Amazon MQ generates for the configuration.

    • MaxResults — (Integer)

      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.

    • NextToken — (String)

      The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ConfigurationId — (String)

        The unique ID that Amazon MQ generates for the configuration.

      • MaxResults — (Integer)

        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.

      • NextToken — (String)

        The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.

      • Revisions — (Array<map>)

        The list of all revisions for the specified configuration.

        • Createdrequired — (Date)

          Required. The date and time of the configuration revision.

        • Description — (String)

          The description of the configuration revision.

        • Revisionrequired — (Integer)

          Required. The revision number of the configuration.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Returns a list of all configurations.

Service Reference:

Examples:

Calling the listConfigurations operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
mq.listConfigurations(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • MaxResults — (Integer)

      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.

    • NextToken — (String)

      The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Configurations — (Array<map>)

        The list of all revisions for the specified configuration.

        • Arnrequired — (String)

          Required. The ARN of the configuration.

        • AuthenticationStrategyrequired — (String)

          Optional. The authentication strategy associated with the configuration. The default is SIMPLE.

          Possible values include:
          • "SIMPLE"
          • "LDAP"
        • Createdrequired — (Date)

          Required. The date and time of the configuration revision.

        • Descriptionrequired — (String)

          Required. The description of the configuration.

        • EngineTyperequired — (String)

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

          Possible values include:
          • "ACTIVEMQ"
          • "RABBITMQ"
        • EngineVersionrequired — (String)

          Required. The broker engine's version. For a list of supported engine versions, see, Supported engines.

        • Idrequired — (String)

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

        • LatestRevisionrequired — (map)

          Required. The latest revision of the configuration.

          • Createdrequired — (Date)

            Required. The date and time of the configuration revision.

          • Description — (String)

            The description of the configuration revision.

          • Revisionrequired — (Integer)

            Required. The revision number of the configuration.

        • Namerequired — (String)

          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.

        • Tags — (map<String>)

          The list of all tags associated with this configuration.

      • MaxResults — (Integer)

        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.

      • NextToken — (String)

        The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Lists tags for a resource.

Service Reference:

Examples:

Calling the listTags operation

var params = {
  ResourceArn: 'STRING_VALUE' /* required */
};
mq.listTags(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ResourceArn — (String)

      The Amazon Resource Name (ARN) of the resource tag.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Tags — (map<String>)

        The key-value pair for the resource tag.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Returns a list of all ActiveMQ users.

Service Reference:

Examples:

Calling the listUsers operation

var params = {
  BrokerId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
mq.listUsers(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • BrokerId — (String)

      The unique ID that Amazon MQ generates for the broker.

    • MaxResults — (Integer)

      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.

    • NextToken — (String)

      The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • BrokerId — (String)

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

      • MaxResults — (Integer)

        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.

      • NextToken — (String)

        The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.

      • Users — (Array<map>)

        Required. The list of all ActiveMQ usernames for the specified broker. Does not apply to RabbitMQ brokers.

        • PendingChange — (String)

          The type of change pending for the broker user.

          Possible values include:
          • "CREATE"
          • "UPDATE"
          • "DELETE"
        • Usernamerequired — (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.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Reboots a broker. Note: This API is asynchronous.

Service Reference:

Examples:

Calling the rebootBroker operation

var params = {
  BrokerId: 'STRING_VALUE' /* required */
};
mq.rebootBroker(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • BrokerId — (String)

      The unique ID that Amazon MQ generates for the broker.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Adds a pending configuration change to a broker.

Service Reference:

Examples:

Calling the updateBroker operation

var params = {
  BrokerId: 'STRING_VALUE', /* required */
  AuthenticationStrategy: SIMPLE | LDAP,
  AutoMinorVersionUpgrade: true || false,
  Configuration: {
    Id: 'STRING_VALUE', /* required */
    Revision: 'NUMBER_VALUE'
  },
  EngineVersion: 'STRING_VALUE',
  HostInstanceType: 'STRING_VALUE',
  LdapServerMetadata: {
    Hosts: [ /* required */
      'STRING_VALUE',
      /* more items */
    ],
    RoleBase: 'STRING_VALUE', /* required */
    RoleSearchMatching: 'STRING_VALUE', /* required */
    ServiceAccountPassword: 'STRING_VALUE', /* required */
    ServiceAccountUsername: 'STRING_VALUE', /* required */
    UserBase: 'STRING_VALUE', /* required */
    UserSearchMatching: 'STRING_VALUE', /* required */
    RoleName: 'STRING_VALUE',
    RoleSearchSubtree: true || false,
    UserRoleName: 'STRING_VALUE',
    UserSearchSubtree: true || false
  },
  Logs: {
    Audit: true || false,
    General: true || false
  },
  MaintenanceWindowStartTime: {
    DayOfWeek: MONDAY | TUESDAY | WEDNESDAY | THURSDAY | FRIDAY | SATURDAY | SUNDAY, /* required */
    TimeOfDay: 'STRING_VALUE', /* required */
    TimeZone: 'STRING_VALUE'
  },
  SecurityGroups: [
    'STRING_VALUE',
    /* more items */
  ]
};
mq.updateBroker(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • AuthenticationStrategy — (String)

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

      Possible values include:
      • "SIMPLE"
      • "LDAP"
    • AutoMinorVersionUpgrade — (Boolean)

      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.

    • BrokerId — (String)

      The unique ID that Amazon MQ generates for the broker.

    • Configuration — (map)

      A list of information about the configuration.

      • Idrequired — (String)

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

      • Revision — (Integer)

        The revision number of the configuration.

    • EngineVersion — (String)

      The broker engine version. For a list of supported engine versions, see Supported engines.

    • HostInstanceType — (String)

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

    • LdapServerMetadata — (map)

      Optional. The metadata of the LDAP server used to authenticate and authorize connections to the broker. Does not apply to RabbitMQ brokers.

      • Hostsrequired — (Array<String>)

        Specifies the location of the LDAP server such as AWS Directory Service for Microsoft Active Directory . Optional failover server.

      • RoleBaserequired — (String)

        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.

      • RoleName — (String)

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

      • RoleSearchMatchingrequired — (String)

        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.

      • RoleSearchSubtree — (Boolean)

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

      • ServiceAccountPasswordrequired — (String)

        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.

      • ServiceAccountUsernamerequired — (String)

        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.

      • UserBaserequired — (String)

        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.

      • UserRoleName — (String)

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

      • UserSearchMatchingrequired — (String)

        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.

      • UserSearchSubtree — (Boolean)

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

    • Logs — (map)

      Enables Amazon CloudWatch logging for brokers.

      • Audit — (Boolean)

        Enables audit logging. Every user management action made using JMX or the ActiveMQ Web Console is logged. Does not apply to RabbitMQ brokers.

      • General — (Boolean)

        Enables general logging.

    • MaintenanceWindowStartTime — (map)

      The parameters that determine the WeeklyStartTime.

      • DayOfWeekrequired — (String)

        Required. The day of the week.

        Possible values include:
        • "MONDAY"
        • "TUESDAY"
        • "WEDNESDAY"
        • "THURSDAY"
        • "FRIDAY"
        • "SATURDAY"
        • "SUNDAY"
      • TimeOfDayrequired — (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.

    • SecurityGroups — (Array<String>)

      The list of security groups (1 minimum, 5 maximum) that authorizes connections to brokers.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • AuthenticationStrategy — (String)

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

        Possible values include:
        • "SIMPLE"
        • "LDAP"
      • AutoMinorVersionUpgrade — (Boolean)

        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.

      • BrokerId — (String)

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

      • Configuration — (map)

        The ID of the updated configuration.

        • Idrequired — (String)

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

        • Revision — (Integer)

          The revision number of the configuration.

      • EngineVersion — (String)

        The broker engine version to upgrade to. For a list of supported engine versions, see Supported engines.

      • HostInstanceType — (String)

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

      • LdapServerMetadata — (map)

        Optional. The metadata of the LDAP server used to authenticate and authorize connections to the broker. Does not apply to RabbitMQ brokers.

        • Hostsrequired — (Array<String>)

          Specifies the location of the LDAP server such as AWS Directory Service for Microsoft Active Directory . Optional failover server.

        • RoleBaserequired — (String)

          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.

        • RoleName — (String)

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

        • RoleSearchMatchingrequired — (String)

          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.

        • RoleSearchSubtree — (Boolean)

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

        • ServiceAccountUsernamerequired — (String)

          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.

        • UserBaserequired — (String)

          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.

        • UserRoleName — (String)

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

        • UserSearchMatchingrequired — (String)

          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.

        • UserSearchSubtree — (Boolean)

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

      • Logs — (map)

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

        • Audit — (Boolean)

          Enables audit logging. Every user management action made using JMX or the ActiveMQ Web Console is logged. Does not apply to RabbitMQ brokers.

        • General — (Boolean)

          Enables general logging.

      • MaintenanceWindowStartTime — (map)

        The parameters that determine the WeeklyStartTime.

        • DayOfWeekrequired — (String)

          Required. The day of the week.

          Possible values include:
          • "MONDAY"
          • "TUESDAY"
          • "WEDNESDAY"
          • "THURSDAY"
          • "FRIDAY"
          • "SATURDAY"
          • "SUNDAY"
        • TimeOfDayrequired — (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.

      • SecurityGroups — (Array<String>)

        The list of security groups (1 minimum, 5 maximum) that authorizes connections to brokers.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Updates the specified configuration.

Service Reference:

Examples:

Calling the updateConfiguration operation

var params = {
  ConfigurationId: 'STRING_VALUE', /* required */
  Data: 'STRING_VALUE', /* required */
  Description: 'STRING_VALUE'
};
mq.updateConfiguration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ConfigurationId — (String)

      The unique ID that Amazon MQ generates for the configuration.

    • Data — (String)

      Required. The base64-encoded XML configuration.

    • Description — (String)

      The description of the configuration.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Arn — (String)

        Required. The Amazon Resource Name (ARN) of the configuration.

      • Created — (Date)

        Required. The date and time of the configuration.

      • Id — (String)

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

      • LatestRevision — (map)

        The latest revision of the configuration.

        • Createdrequired — (Date)

          Required. The date and time of the configuration revision.

        • Description — (String)

          The description of the configuration revision.

        • Revisionrequired — (Integer)

          Required. The revision number of the configuration.

      • Name — (String)

        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.

      • Warnings — (Array<map>)

        The list of the first 20 warnings about the configuration XML elements or attributes that were sanitized.

        • AttributeName — (String)

          The name of the XML attribute that has been sanitized.

        • ElementName — (String)

          The name of the XML element that has been sanitized.

        • Reasonrequired — (String)

          Required. The reason for which the XML elements or attributes were sanitized.

          Possible values include:
          • "DISALLOWED_ELEMENT_REMOVED"
          • "DISALLOWED_ATTRIBUTE_REMOVED"
          • "INVALID_ATTRIBUTE_VALUE_REMOVED"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Updates the information for an ActiveMQ user.

Service Reference:

Examples:

Calling the updateUser operation

var params = {
  BrokerId: 'STRING_VALUE', /* required */
  Username: 'STRING_VALUE', /* required */
  ConsoleAccess: true || false,
  Groups: [
    'STRING_VALUE',
    /* more items */
  ],
  Password: 'STRING_VALUE'
};
mq.updateUser(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • BrokerId — (String)

      The unique ID that Amazon MQ generates for the broker.

    • ConsoleAccess — (Boolean)

      Enables access to the the ActiveMQ Web Console for the ActiveMQ user.

    • Groups — (Array<String>)

      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.

    • Password — (String)

      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 (,:=).

    • Username — (String)

      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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.