Client

mq	R Documentation

AmazonMQ¶

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¶

mq(config = list(), credentials = list(), endpoint = NULL, region = NULL)

Arguments¶

config

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

credentials:
- creds:
  - access_key_id: AWS access key ID
  - secret_access_key: AWS secret access key
  - session_token: AWS temporary session token
- profile: The name of a profile to use. If not given, then the default profile is used.
- anonymous: Set anonymous credentials.
endpoint: The complete URL to use for the constructed client.
region: The AWS Region used in instantiating the client.
close_connection: Immediately close all HTTP connections.
timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.
s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e. ⁠http://s3.amazonaws.com/BUCKET/KEY⁠.
sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html

credentials

Optional credentials shorthand for the config parameter

creds:
- access_key_id: AWS access key ID
- secret_access_key: AWS secret access key
- session_token: AWS temporary session token
profile: The name of a profile to use. If not given, then the default profile is used.
anonymous: Set anonymous credentials.

endpoint

Optional shorthand for complete URL to use for the constructed client.

region

Optional shorthand for AWS Region used in instantiating the client.

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¶

svc <- mq(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string",
      anonymous = "logical"
    ),
    endpoint = "string",
    region = "string",
    close_connection = "logical",
    timeout = "numeric",
    s3_force_path_style = "logical",
    sts_regional_endpoint = "string"
  ),
  credentials = list(
    creds = list(
      access_key_id = "string",
      secret_access_key = "string",
      session_token = "string"
    ),
    profile = "string",
    anonymous = "logical"
  ),
  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
promote: Promotes a data replication replica broker to the primary broker role
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¶

## Not run: 
svc <- mq()
svc$create_broker(
  Foo = 123
)

## End(Not run)