aws-elixir

View Source AWS.Mq (aws-elixir v1.0.4)

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.

Link to this section Summary

Functions

create_broker(client, input, options \\ [])

Creates a broker.

create_configuration(client, input, options \\ [])

Creates a new configuration for the specified configuration name.

create_tags(client, resource_arn, input, options \\ [])

Add a tag to a resource.

create_user(client, broker_id, username, input, options \\ [])

Creates an ActiveMQ user.

delete_broker(client, broker_id, input, options \\ [])

Deletes a broker.

delete_tags(client, resource_arn, input, options \\ [])

Removes a tag from a resource.

delete_user(client, broker_id, username, input, options \\ [])

Deletes an ActiveMQ user.

describe_broker(client, broker_id, options \\ [])

Returns information about the specified broker.

describe_broker_engine_types(client, engine_type \\ nil, max_results \\ nil, next_token \\ nil, options \\ [])

Describe available engine types and versions.

describe_broker_instance_options(client, engine_type \\ nil, host_instance_type \\ nil, max_results \\ nil, next_token \\ nil, storage_type \\ nil, options \\ [])

Describe available broker instance options.

describe_configuration(client, configuration_id, options \\ [])

Returns information about the specified configuration.

describe_configuration_revision(client, configuration_id, configuration_revision, options \\ [])

Returns the specified configuration revision for the specified configuration.

describe_user(client, broker_id, username, options \\ [])

Returns information about an ActiveMQ user.

list_brokers(client, max_results \\ nil, next_token \\ nil, options \\ [])

Returns a list of all brokers.

list_configuration_revisions(client, configuration_id, max_results \\ nil, next_token \\ nil, options \\ [])

Returns a list of all revisions for the specified configuration.

list_configurations(client, max_results \\ nil, next_token \\ nil, options \\ [])

Returns a list of all configurations.

list_tags(client, resource_arn, options \\ [])

Lists tags for a resource.

list_users(client, broker_id, max_results \\ nil, next_token \\ nil, options \\ [])

Returns a list of all ActiveMQ users.

metadata()
promote(client, broker_id, input, options \\ [])

Promotes a data replication replica broker to the primary broker role.

reboot_broker(client, broker_id, input, options \\ [])

Reboots a broker.

update_broker(client, broker_id, input, options \\ [])

Adds a pending configuration change to a broker.

update_configuration(client, configuration_id, input, options \\ [])

Updates the specified configuration.

update_user(client, broker_id, username, input, options \\ [])

Updates the information for an ActiveMQ user.

Link to this section Functions

Link to this function

create_broker(client, input, options \\ [])

View Source

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 Amazon Web Services Credentials and Never Modify or Delete the Amazon MQ Elastic Network Interface in the Amazon MQ Developer Guide.

Link to this function

create_configuration(client, input, options \\ [])

View Source

Creates a new configuration for the specified configuration name.

Amazon MQ uses the default configuration (the engine type and version).

Link to this function

create_tags(client, resource_arn, input, options \\ [])

View Source

Add a tag to a resource.

Link to this function

create_user(client, broker_id, username, input, options \\ [])

View Source

Creates an ActiveMQ user.

Do not add personally identifiable information (PII) or other confidential or sensitive information in broker usernames. Broker usernames are accessible to other Amazon Web Services services, including CloudWatch Logs. Broker usernames are not intended to be used for private or sensitive data.

Link to this function

delete_broker(client, broker_id, input, options \\ [])

View Source

Deletes a broker.

Note: This API is asynchronous.

Link to this function

delete_tags(client, resource_arn, input, options \\ [])

View Source

Removes a tag from a resource.

Link to this function

delete_user(client, broker_id, username, input, options \\ [])

View Source

Deletes an ActiveMQ user.

Link to this function

describe_broker(client, broker_id, options \\ [])

View Source

Returns information about the specified broker.

Link to this function

describe_broker_engine_types(client, engine_type \\ nil, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Describe available engine types and versions.

Link to this function

describe_broker_instance_options(client, engine_type \\ nil, host_instance_type \\ nil, max_results \\ nil, next_token \\ nil, storage_type \\ nil, options \\ [])

View Source

Describe available broker instance options.

Link to this function

describe_configuration(client, configuration_id, options \\ [])

View Source

Returns information about the specified configuration.

Link to this function

describe_configuration_revision(client, configuration_id, configuration_revision, options \\ [])

View Source

Returns the specified configuration revision for the specified configuration.

Link to this function

describe_user(client, broker_id, username, options \\ [])

View Source

Returns information about an ActiveMQ user.

Link to this function

list_brokers(client, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Returns a list of all brokers.

Link to this function

list_configuration_revisions(client, configuration_id, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Returns a list of all revisions for the specified configuration.

Link to this function

list_configurations(client, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Returns a list of all configurations.

Link to this function

list_tags(client, resource_arn, options \\ [])

View Source

Lists tags for a resource.

Link to this function

list_users(client, broker_id, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Returns a list of all ActiveMQ users.

Link to this function

metadata()

View Source
Link to this function

promote(client, broker_id, input, options \\ [])

View Source

Promotes a data replication replica broker to the primary broker role.

Link to this function

reboot_broker(client, broker_id, input, options \\ [])

View Source

Reboots a broker.

Note: This API is asynchronous.

Link to this function

update_broker(client, broker_id, input, options \\ [])

View Source

Adds a pending configuration change to a broker.

Link to this function

update_configuration(client, configuration_id, input, options \\ [])

View Source

Updates the specified configuration.

Link to this function

update_user(client, broker_id, username, input, options \\ [])

View Source

Updates the information for an ActiveMQ user.