Mq

This page documents function available when using the Mq module, created with @service Mq.

Index

Documentation

Main.Mq.create_brokerMethod
create_broker(auto_minor_version_upgrade, broker_name, deployment_mode, engine_type, engine_version, host_instance_type, publicly_accessible, users)
create_broker(auto_minor_version_upgrade, broker_name, deployment_mode, engine_type, engine_version, host_instance_type, publicly_accessible, users, params::Dict{String,<:Any})

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.

Arguments

  • auto_minor_version_upgrade: 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.
  • broker_name: 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.
  • deployment_mode: Required. The broker's deployment mode.
  • engine_type: Required. The type of broker engine. Currently, Amazon MQ supports ACTIVEMQ and RABBITMQ.
  • engine_version: Required. The broker engine's version. For a list of supported engine versions, see Supported engines.
  • host_instance_type: Required. The broker's instance type.
  • publicly_accessible: Enables connections from applications outside of the VPC that hosts the broker's subnets. Set to false by default, if no value is provided.
  • users: 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.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "authenticationStrategy": Optional. The authentication strategy used to secure the broker. The default is SIMPLE.
  • "configuration": A list of information about the configuration.
  • "creatorRequestId": 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.
  • "encryptionOptions": Encryption options for the broker. Does not apply to RabbitMQ brokers.
  • "ldapServerMetadata": Optional. The metadata of the LDAP server used to authenticate and authorize connections to the broker. Does not apply to RabbitMQ brokers.
  • "logs": Enables Amazon CloudWatch logging for brokers.
  • "maintenanceWindowStartTime": The parameters that determine the WeeklyStartTime.
  • "securityGroups": The list of rules (1 minimum, 125 maximum) that authorize connections to brokers.
  • "storageType": The broker's storage type.
  • "subnetIds": 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 SINGLEINSTANCE deployment requires one subnet (for example, the default subnet). An ACTIVESTANDBYMULTIAZ Amazon MQ for ActiveMQ deployment requires two subnets. A CLUSTERMULTIAZ 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": Create tags when creating the broker.
Main.Mq.create_configurationMethod
create_configuration(engine_type, engine_version, name)
create_configuration(engine_type, engine_version, name, params::Dict{String,<:Any})

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

Arguments

  • engine_type: Required. The type of broker engine. Currently, Amazon MQ supports ACTIVEMQ and RABBITMQ.
  • engine_version: Required. The broker engine's version. For a list of supported engine versions, see Supported engines.
  • name: 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.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "authenticationStrategy": Optional. The authentication strategy associated with the configuration. The default is SIMPLE.
  • "tags": Create tags when creating the configuration.
Main.Mq.create_tagsMethod
create_tags(resource-arn)
create_tags(resource-arn, params::Dict{String,<:Any})

Add a tag to a resource.

Arguments

  • resource-arn: The Amazon Resource Name (ARN) of the resource tag.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "tags": The key-value pair for the resource tag.
Main.Mq.create_userMethod
create_user(broker-id, password, username)
create_user(broker-id, password, username, params::Dict{String,<:Any})

Creates an ActiveMQ user.

Arguments

  • broker-id: The unique ID that Amazon MQ generates for the broker.
  • password: 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: 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.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "consoleAccess": Enables access to the ActiveMQ Web Console for the ActiveMQ user.
  • "groups": 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.
Main.Mq.delete_brokerMethod
delete_broker(broker-id)
delete_broker(broker-id, params::Dict{String,<:Any})

Deletes a broker. Note: This API is asynchronous.

Arguments

  • broker-id: The unique ID that Amazon MQ generates for the broker.
Main.Mq.delete_tagsMethod
delete_tags(resource-arn, tag_keys)
delete_tags(resource-arn, tag_keys, params::Dict{String,<:Any})

Removes a tag from a resource.

Arguments

  • resource-arn: The Amazon Resource Name (ARN) of the resource tag.
  • tag_keys: An array of tag keys to delete
Main.Mq.delete_userMethod
delete_user(broker-id, username)
delete_user(broker-id, username, params::Dict{String,<:Any})

Deletes an ActiveMQ user.

Arguments

  • broker-id: The unique ID that Amazon MQ generates for the broker.
  • username: 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.
Main.Mq.describe_brokerMethod
describe_broker(broker-id)
describe_broker(broker-id, params::Dict{String,<:Any})

Returns information about the specified broker.

Arguments

  • broker-id: The unique ID that Amazon MQ generates for the broker.
Main.Mq.describe_broker_engine_typesMethod
describe_broker_engine_types()
describe_broker_engine_types(params::Dict{String,<:Any})

Describe available engine types and versions.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "engineType": Filter response by engine type.
  • "maxResults": 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": The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.
Main.Mq.describe_broker_instance_optionsMethod
describe_broker_instance_options()
describe_broker_instance_options(params::Dict{String,<:Any})

Describe available broker instance options.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "engineType": Filter response by engine type.
  • "hostInstanceType": Filter response by host instance type.
  • "maxResults": 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": The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.
  • "storageType": Filter response by storage type.
Main.Mq.describe_configurationMethod
describe_configuration(configuration-id)
describe_configuration(configuration-id, params::Dict{String,<:Any})

Returns information about the specified configuration.

Arguments

  • configuration-id: The unique ID that Amazon MQ generates for the configuration.
Main.Mq.describe_configuration_revisionMethod
describe_configuration_revision(configuration-id, configuration-revision)
describe_configuration_revision(configuration-id, configuration-revision, params::Dict{String,<:Any})

Returns the specified configuration revision for the specified configuration.

Arguments

  • configuration-id: The unique ID that Amazon MQ generates for the configuration.
  • configuration-revision: The revision of the configuration.
Main.Mq.describe_userMethod
describe_user(broker-id, username)
describe_user(broker-id, username, params::Dict{String,<:Any})

Returns information about an ActiveMQ user.

Arguments

  • broker-id: The unique ID that Amazon MQ generates for the broker.
  • username: 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.
Main.Mq.list_brokersMethod
list_brokers()
list_brokers(params::Dict{String,<:Any})

Returns a list of all brokers.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": 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": The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.
Main.Mq.list_configuration_revisionsMethod
list_configuration_revisions(configuration-id)
list_configuration_revisions(configuration-id, params::Dict{String,<:Any})

Returns a list of all revisions for the specified configuration.

Arguments

  • configuration-id: The unique ID that Amazon MQ generates for the configuration.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": 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": The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.
Main.Mq.list_configurationsMethod
list_configurations()
list_configurations(params::Dict{String,<:Any})

Returns a list of all configurations.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": 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": The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.
Main.Mq.list_tagsMethod
list_tags(resource-arn)
list_tags(resource-arn, params::Dict{String,<:Any})

Lists tags for a resource.

Arguments

  • resource-arn: The Amazon Resource Name (ARN) of the resource tag.
Main.Mq.list_usersMethod
list_users(broker-id)
list_users(broker-id, params::Dict{String,<:Any})

Returns a list of all ActiveMQ users.

Arguments

  • broker-id: The unique ID that Amazon MQ generates for the broker.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": 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": The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.
Main.Mq.reboot_brokerMethod
reboot_broker(broker-id)
reboot_broker(broker-id, params::Dict{String,<:Any})

Reboots a broker. Note: This API is asynchronous.

Arguments

  • broker-id: The unique ID that Amazon MQ generates for the broker.
Main.Mq.update_brokerMethod
update_broker(broker-id)
update_broker(broker-id, params::Dict{String,<:Any})

Adds a pending configuration change to a broker.

Arguments

  • broker-id: The unique ID that Amazon MQ generates for the broker.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "authenticationStrategy": Optional. The authentication strategy used to secure the broker. The default is SIMPLE.
  • "autoMinorVersionUpgrade": 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.
  • "configuration": A list of information about the configuration.
  • "engineVersion": The broker engine version. For a list of supported engine versions, see Supported engines.
  • "hostInstanceType": The broker's host instance type to upgrade to. For a list of supported instance types, see Broker instance types.
  • "ldapServerMetadata": Optional. The metadata of the LDAP server used to authenticate and authorize connections to the broker. Does not apply to RabbitMQ brokers.
  • "logs": Enables Amazon CloudWatch logging for brokers.
  • "maintenanceWindowStartTime": The parameters that determine the WeeklyStartTime.
  • "securityGroups": The list of security groups (1 minimum, 5 maximum) that authorizes connections to brokers.
Main.Mq.update_configurationMethod
update_configuration(configuration-id, data)
update_configuration(configuration-id, data, params::Dict{String,<:Any})

Updates the specified configuration.

Arguments

  • configuration-id: The unique ID that Amazon MQ generates for the configuration.
  • data: Required. The base64-encoded XML configuration.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "description": The description of the configuration.
Main.Mq.update_userMethod
update_user(broker-id, username)
update_user(broker-id, username, params::Dict{String,<:Any})

Updates the information for an ActiveMQ user.

Arguments

  • broker-id: The unique ID that Amazon MQ generates for the broker.
  • username: 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.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "consoleAccess": Enables access to the the ActiveMQ Web Console for the ActiveMQ user.
  • "groups": 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": 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 (,:=).