Mq

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

Index

Documentation

Main.Mq.create_broker — Method

create_broker()
create_broker(params::Dict{String,<:Any})

Creates a broker. Note: This API is asynchronous.

Optional Parameters

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

"authenticationStrategy": The authentication strategy used to secure the broker.
"autoMinorVersionUpgrade": Required. Enables automatic upgrades to new minor versions for brokers, as Apache releases the versions. The automatic upgrades occur during the maintenance window of the broker or after a manual broker reboot.
"brokerName": Required. The name of the broker. 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 whitespaces, brackets, wildcard characters, or special characters.
"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.
"deploymentMode": Required. The deployment mode of the broker.
"encryptionOptions": Encryption options for the broker.
"engineType": Required. The type of broker engine. Note: Currently, Amazon MQ supports ACTIVEMQ and RABBITMQ.
"engineVersion": Required. The version of the broker engine. For a list of supported engine versions, see https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.html
"hostInstanceType": Required. The broker's instance type.
"ldapServerMetadata": The metadata of the LDAP server used to authenticate and authorize connections to the broker.
"logs": Enables Amazon CloudWatch logging for brokers.
"maintenanceWindowStartTime": The parameters that determine the WeeklyStartTime.
"publiclyAccessible": Required. Enables connections from applications outside of the VPC that hosts the broker's subnets.
"securityGroups": The list of security groups (1 minimum, 5 maximum) that authorizes 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. A SINGLEINSTANCE deployment requires one subnet (for example, the default subnet). An ACTIVESTANDBYMULTIAZ deployment (ACTIVEMQ) requires two subnets. A CLUSTERMULTIAZ deployment (RABBITMQ) has no subnet requirements when deployed with public accessibility, deployment without public accessibility requires at least one subnet.
"tags": Create tags when creating the broker.
"users": Required. The list of broker users (persons or applications) who can access queues and topics. For RabbitMQ brokers, 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. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.

source

Main.Mq.create_configuration — Method

create_configuration()
create_configuration(params::Dict{String,<:Any})

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

Optional Parameters

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

"authenticationStrategy": The authentication strategy associated with the configuration.
"engineType": Required. The type of broker engine. Note: Currently, Amazon MQ supports ACTIVEMQ and RABBITMQ.
"engineVersion": Required. The version of the broker engine. For a list of supported engine versions, see https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.html
"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.
"tags": Create tags when creating the configuration.

source

Main.Mq.create_tags — Method

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.

source

Main.Mq.create_user — Method

create_user(broker-id, username)
create_user(broker-id, username, params::Dict{String,<:Any})

Creates 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": 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.

source

Main.Mq.delete_broker — Method

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.

source

Main.Mq.delete_tags — Method

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

source

Main.Mq.delete_user — Method

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.

source

Main.Mq.describe_broker — Method

describe_broker(broker-id)
describe_broker(broker-id, params::Dict{String,<:Any})

Returns information about the specified broker.

Arguments

broker-id: The name of the broker. 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 whitespaces, brackets, wildcard characters, or special characters.

source

Main.Mq.describe_broker_engine_types — Method

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 engine types 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.

source

Main.Mq.describe_broker_instance_options — Method

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 instance options 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.

source

Main.Mq.describe_configuration — Method

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.

source

Main.Mq.describe_configuration_revision — Method

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.

source

Main.Mq.describe_user — Method

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.

source

Main.Mq.list_brokers — Method

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.

source

Main.Mq.list_configuration_revisions — Method

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

source

Main.Mq.list_configurations — Method

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

source

Main.Mq.list_tags — Method

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.

source

Main.Mq.list_users — Method

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 ActiveMQ users that can be returned 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.

source

Main.Mq.reboot_broker — Method

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.

source

Main.Mq.update_broker — Method

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": The authentication strategy used to secure the broker.
"autoMinorVersionUpgrade": Enables automatic upgrades to new minor versions for brokers, as Apache releases the versions. The automatic upgrades occur during the maintenance window of the broker or after a manual broker reboot.
"configuration": A list of information about the configuration.
"engineVersion": The version of the broker engine. For a list of supported engine versions, see https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.html
"hostInstanceType": The host instance type of the broker to upgrade to. For a list of supported instance types, see https://docs.aws.amazon.com/amazon-mq/latest/developer-guide//broker.html#broker-instance-ty pes
"ldapServerMetadata": The metadata of the LDAP server used to authenticate and authorize connections to the broker.
"logs": Enables Amazon CloudWatch logging for brokers.
"securityGroups": The list of security groups (1 minimum, 5 maximum) that authorizes connections to brokers.

source

Main.Mq.update_configuration — Method

update_configuration(configuration-id)
update_configuration(configuration-id, params::Dict{String,<:Any})

Updates 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:

"data": Required. The base64-encoded XML configuration.
"description": The description of the configuration.

source

Main.Mq.update_user — Method

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

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.

source