mq: AmazonMQ

Description Usage Arguments Value Service syntax Operations Examples

View source: R/mq_service.R

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.

Usage

1
mq(config = list())

Arguments

config

Optional configuration of credentials, endpoint, and/or region.

Value

A client for the service. You can call the service's operations using syntax like svc$operation(...), where svc is the name you've assigned to the client. The available operations are listed in the Operations section.

Service syntax

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
svc <- mq(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string"
    ),
    endpoint = "string",
    region = "string"
  )
)

Operations

create_broker Creates a broker
create_configuration Creates a new configuration for the specified configuration name
create_tags Add a tag to a resource
create_user Creates an ActiveMQ user
delete_broker Deletes a broker
delete_tags Removes a tag from a resource
delete_user Deletes an ActiveMQ user
describe_broker Returns information about the specified broker
describe_broker_engine_types Describe available engine types and versions
describe_broker_instance_options Describe available broker instance options
describe_configuration Returns information about the specified configuration
describe_configuration_revision Returns the specified configuration revision for the specified configuration
describe_user Returns information about an ActiveMQ user
list_brokers Returns a list of all brokers
list_configuration_revisions Returns a list of all revisions for the specified configuration
list_configurations Returns a list of all configurations
list_tags Lists tags for a resource
list_users Returns a list of all ActiveMQ users
reboot_broker Reboots a broker
update_broker Adds a pending configuration change to a broker
update_configuration Updates the specified configuration
update_user Updates the information for an ActiveMQ user

Examples

1
2
3
4
5
6
7
## Not run: 
svc <- mq()
svc$create_broker(
  Foo = 123
)

## End(Not run)

paws.application.integration documentation built on Aug. 23, 2021, 9:20 a.m.