mq

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-aws repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-aws repo.

class pulumi_aws.mq.AwaitableGetBrokerResult(arn=None, auto_minor_version_upgrade=None, broker_id=None, broker_name=None, configuration=None, deployment_mode=None, engine_type=None, engine_version=None, host_instance_type=None, instances=None, logs=None, maintenance_window_start_time=None, publicly_accessible=None, security_groups=None, subnet_ids=None, tags=None, users=None, id=None)
class pulumi_aws.mq.Broker(resource_name, opts=None, apply_immediately=None, auto_minor_version_upgrade=None, broker_name=None, configuration=None, deployment_mode=None, engine_type=None, engine_version=None, host_instance_type=None, logs=None, maintenance_window_start_time=None, publicly_accessible=None, security_groups=None, subnet_ids=None, tags=None, users=None, __props__=None, __name__=None, __opts__=None)

Provides an MQ Broker Resource. This resources also manages users for the broker.

For more information on Amazon MQ, see Amazon MQ documentation.

Changes to an MQ Broker can occur when you change a parameter, such as configuration or user, and are reflected in the next maintenance window. Because of this, this provider may report a difference in its planning phase because a modification has not yet taken place. You can use the apply_immediately flag to instruct the service to apply the change immediately (see documentation below).

Note: using apply_immediately can result in a brief downtime as the broker reboots.

Note: All arguments including the username and password will be stored in the raw state as plain-text. Read more about sensitive data in state.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • apply_immediately (pulumi.Input[bool]) – Specifies whether any broker modifications are applied immediately, or during the next maintenance window. Default is false.

  • auto_minor_version_upgrade (pulumi.Input[bool]) – Enables automatic upgrades to new minor versions for brokers, as Apache releases the versions.

  • broker_name (pulumi.Input[str]) – The name of the broker.

  • configuration (pulumi.Input[dict]) – Configuration of the broker. See below.

  • deployment_mode (pulumi.Input[str]) – The deployment mode of the broker. Supported: SINGLE_INSTANCE and ACTIVE_STANDBY_MULTI_AZ. Defaults to SINGLE_INSTANCE.

  • engine_type (pulumi.Input[str]) – The type of broker engine. Currently, Amazon MQ supports only ActiveMQ.

  • engine_version (pulumi.Input[str]) – The version of the broker engine. Currently, See the AmazonMQ Broker Engine docs for supported versions.

  • host_instance_type (pulumi.Input[str]) – The broker’s instance type. e.g. mq.t2.micro or mq.m4.large

  • logs (pulumi.Input[dict]) – Logging configuration of the broker. See below.

  • maintenance_window_start_time (pulumi.Input[dict]) – Maintenance window start time. See below.

  • publicly_accessible (pulumi.Input[bool]) – Whether to enable connections from applications outside of the VPC that hosts the broker’s subnets.

  • security_groups (pulumi.Input[list]) – The list of security group IDs assigned to the broker.

  • subnet_ids (pulumi.Input[list]) – The list of subnet IDs in which to launch the broker. A SINGLE_INSTANCE deployment requires one subnet. An ACTIVE_STANDBY_MULTI_AZ deployment requires two subnets.

  • tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.

  • users (pulumi.Input[list]) – The list of all ActiveMQ usernames for the specified broker. See below.

The configuration object supports the following:

  • id (pulumi.Input[str]) - The Configuration ID.

  • revision (pulumi.Input[float]) - Revision of the Configuration.

The logs object supports the following:

  • audit (pulumi.Input[bool]) - Enables audit logging. User management action made using JMX or the ActiveMQ Web Console is logged. Defaults to false.

  • general (pulumi.Input[bool]) - Enables general logging via CloudWatch. Defaults to false.

The maintenance_window_start_time object supports the following:

  • dayOfWeek (pulumi.Input[str]) - The day of the week. e.g. MONDAY, TUESDAY, or WEDNESDAY

  • timeOfDay (pulumi.Input[str]) - The time, in 24-hour format. e.g. 02:00

  • timeZone (pulumi.Input[str]) - The time zone, UTC by default, in either the Country/City format, or the UTC offset format. e.g. CET

The users object supports the following:

  • consoleAccess (pulumi.Input[bool]) - Whether to enable access to the ActiveMQ Web Console for the user.

  • groups (pulumi.Input[list]) - The list of groups (20 maximum) to which the ActiveMQ user belongs.

  • password (pulumi.Input[str]) - The password of the user. It must be 12 to 250 characters long, at least 4 unique characters, and must not contain commas.

  • username (pulumi.Input[str]) - The username of the user.

apply_immediately = None

Specifies whether any broker modifications are applied immediately, or during the next maintenance window. Default is false.

arn = None

The ARN of the broker.

auto_minor_version_upgrade = None

Enables automatic upgrades to new minor versions for brokers, as Apache releases the versions.

broker_name = None

The name of the broker.

configuration = None

Configuration of the broker. See below.

  • id (str) - The Configuration ID.

  • revision (float) - Revision of the Configuration.

deployment_mode = None

The deployment mode of the broker. Supported: SINGLE_INSTANCE and ACTIVE_STANDBY_MULTI_AZ. Defaults to SINGLE_INSTANCE.

engine_type = None

The type of broker engine. Currently, Amazon MQ supports only ActiveMQ.

engine_version = None

The version of the broker engine. Currently, See the AmazonMQ Broker Engine docs for supported versions.

host_instance_type = None

The broker’s instance type. e.g. mq.t2.micro or mq.m4.large

instances = None

A list of information about allocated brokers (both active & standby).

  • instances.0.console_url - The URL of the broker’s ActiveMQ Web Console.

  • instances.0.ip_address - The IP Address of the broker.

  • instances.0.endpoints - The broker’s wire-level protocol endpoints in the following order & format referenceable e.g. as instances.0.endpoints.0 (SSL):

  • ssl://broker-id.mq.us-west-2.amazonaws.com:61617

  • amqp+ssl://broker-id.mq.us-west-2.amazonaws.com:5671

  • stomp+ssl://broker-id.mq.us-west-2.amazonaws.com:61614

  • mqtt+ssl://broker-id.mq.us-west-2.amazonaws.com:8883

  • wss://broker-id.mq.us-west-2.amazonaws.com:61619

    • consoleUrl (str)

    • endpoints (list)

    • ip_address (str)

logs = None

Logging configuration of the broker. See below.

  • audit (bool) - Enables audit logging. User management action made using JMX or the ActiveMQ Web Console is logged. Defaults to false.

  • general (bool) - Enables general logging via CloudWatch. Defaults to false.

maintenance_window_start_time = None

Maintenance window start time. See below.

  • dayOfWeek (str) - The day of the week. e.g. MONDAY, TUESDAY, or WEDNESDAY

  • timeOfDay (str) - The time, in 24-hour format. e.g. 02:00

  • timeZone (str) - The time zone, UTC by default, in either the Country/City format, or the UTC offset format. e.g. CET

publicly_accessible = None

Whether to enable connections from applications outside of the VPC that hosts the broker’s subnets.

security_groups = None

The list of security group IDs assigned to the broker.

subnet_ids = None

The list of subnet IDs in which to launch the broker. A SINGLE_INSTANCE deployment requires one subnet. An ACTIVE_STANDBY_MULTI_AZ deployment requires two subnets.

tags = None

A mapping of tags to assign to the resource.

users = None

The list of all ActiveMQ usernames for the specified broker. See below.

  • consoleAccess (bool) - Whether to enable access to the ActiveMQ Web Console for the user.

  • groups (list) - The list of groups (20 maximum) to which the ActiveMQ user belongs.

  • password (str) - The password of the user. It must be 12 to 250 characters long, at least 4 unique characters, and must not contain commas.

  • username (str) - The username of the user.

static get(resource_name, id, opts=None, apply_immediately=None, arn=None, auto_minor_version_upgrade=None, broker_name=None, configuration=None, deployment_mode=None, engine_type=None, engine_version=None, host_instance_type=None, instances=None, logs=None, maintenance_window_start_time=None, publicly_accessible=None, security_groups=None, subnet_ids=None, tags=None, users=None)

Get an existing Broker resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • apply_immediately (pulumi.Input[bool]) – Specifies whether any broker modifications are applied immediately, or during the next maintenance window. Default is false.

  • arn (pulumi.Input[str]) – The ARN of the broker.

  • auto_minor_version_upgrade (pulumi.Input[bool]) – Enables automatic upgrades to new minor versions for brokers, as Apache releases the versions.

  • broker_name (pulumi.Input[str]) – The name of the broker.

  • configuration (pulumi.Input[dict]) – Configuration of the broker. See below.

  • deployment_mode (pulumi.Input[str]) – The deployment mode of the broker. Supported: SINGLE_INSTANCE and ACTIVE_STANDBY_MULTI_AZ. Defaults to SINGLE_INSTANCE.

  • engine_type (pulumi.Input[str]) – The type of broker engine. Currently, Amazon MQ supports only ActiveMQ.

  • engine_version (pulumi.Input[str]) –

    The version of the broker engine. Currently, See the AmazonMQ Broker Engine docs for supported versions.

  • host_instance_type (pulumi.Input[str]) – The broker’s instance type. e.g. mq.t2.micro or mq.m4.large

  • instances (pulumi.Input[list]) – A list of information about allocated brokers (both active & standby).

* `instances.0.console_url` - The URL of the broker's [ActiveMQ Web Console](http://activemq.apache.org/web-console.html).
* `instances.0.ip_address` - The IP Address of the broker.
* `instances.0.endpoints` - The broker's wire-level protocol endpoints in the following order & format referenceable e.g. as `instances.0.endpoints.0` (SSL):
* `ssl://broker-id.mq.us-west-2.amazonaws.com:61617`
* `amqp+ssl://broker-id.mq.us-west-2.amazonaws.com:5671`
* `stomp+ssl://broker-id.mq.us-west-2.amazonaws.com:61614`
* `mqtt+ssl://broker-id.mq.us-west-2.amazonaws.com:8883`
* `wss://broker-id.mq.us-west-2.amazonaws.com:61619`
Parameters
  • logs (pulumi.Input[dict]) – Logging configuration of the broker. See below.

  • maintenance_window_start_time (pulumi.Input[dict]) – Maintenance window start time. See below.

  • publicly_accessible (pulumi.Input[bool]) – Whether to enable connections from applications outside of the VPC that hosts the broker’s subnets.

  • security_groups (pulumi.Input[list]) – The list of security group IDs assigned to the broker.

  • subnet_ids (pulumi.Input[list]) – The list of subnet IDs in which to launch the broker. A SINGLE_INSTANCE deployment requires one subnet. An ACTIVE_STANDBY_MULTI_AZ deployment requires two subnets.

  • tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.

  • users (pulumi.Input[list]) – The list of all ActiveMQ usernames for the specified broker. See below.

The configuration object supports the following:

  • id (pulumi.Input[str]) - The Configuration ID.

  • revision (pulumi.Input[float]) - Revision of the Configuration.

The instances object supports the following:

  • consoleUrl (pulumi.Input[str])

  • endpoints (pulumi.Input[list])

  • ip_address (pulumi.Input[str])

The logs object supports the following:

  • audit (pulumi.Input[bool]) - Enables audit logging. User management action made using JMX or the ActiveMQ Web Console is logged. Defaults to false.

  • general (pulumi.Input[bool]) - Enables general logging via CloudWatch. Defaults to false.

The maintenance_window_start_time object supports the following:

  • dayOfWeek (pulumi.Input[str]) - The day of the week. e.g. MONDAY, TUESDAY, or WEDNESDAY

  • timeOfDay (pulumi.Input[str]) - The time, in 24-hour format. e.g. 02:00

  • timeZone (pulumi.Input[str]) - The time zone, UTC by default, in either the Country/City format, or the UTC offset format. e.g. CET

The users object supports the following:

  • consoleAccess (pulumi.Input[bool]) - Whether to enable access to the ActiveMQ Web Console for the user.

  • groups (pulumi.Input[list]) - The list of groups (20 maximum) to which the ActiveMQ user belongs.

  • password (pulumi.Input[str]) - The password of the user. It must be 12 to 250 characters long, at least 4 unique characters, and must not contain commas.

  • username (pulumi.Input[str]) - The username of the user.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_aws.mq.Configuration(resource_name, opts=None, data=None, description=None, engine_type=None, engine_version=None, name=None, tags=None, __props__=None, __name__=None, __opts__=None)

Provides an MQ Configuration Resource.

For more information on Amazon MQ, see Amazon MQ documentation.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • data (pulumi.Input[str]) – The broker configuration in XML format. See official docs for supported parameters and format of the XML.

  • description (pulumi.Input[str]) – The description of the configuration.

  • engine_type (pulumi.Input[str]) – The type of broker engine.

  • engine_version (pulumi.Input[str]) – The version of the broker engine.

  • name (pulumi.Input[str]) – The name of the configuration

  • tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.

arn = None

The ARN of the configuration.

data = None

The broker configuration in XML format. See official docs for supported parameters and format of the XML.

description = None

The description of the configuration.

engine_type = None

The type of broker engine.

engine_version = None

The version of the broker engine.

latest_revision = None

The latest revision of the configuration.

name = None

The name of the configuration

tags = None

A mapping of tags to assign to the resource.

static get(resource_name, id, opts=None, arn=None, data=None, description=None, engine_type=None, engine_version=None, latest_revision=None, name=None, tags=None)

Get an existing Configuration resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • arn (pulumi.Input[str]) – The ARN of the configuration.

  • data (pulumi.Input[str]) –

    The broker configuration in XML format. See official docs for supported parameters and format of the XML.

  • description (pulumi.Input[str]) – The description of the configuration.

  • engine_type (pulumi.Input[str]) – The type of broker engine.

  • engine_version (pulumi.Input[str]) – The version of the broker engine.

  • latest_revision (pulumi.Input[float]) – The latest revision of the configuration.

  • name (pulumi.Input[str]) – The name of the configuration

  • tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_aws.mq.GetBrokerResult(arn=None, auto_minor_version_upgrade=None, broker_id=None, broker_name=None, configuration=None, deployment_mode=None, engine_type=None, engine_version=None, host_instance_type=None, instances=None, logs=None, maintenance_window_start_time=None, publicly_accessible=None, security_groups=None, subnet_ids=None, tags=None, users=None, id=None)

A collection of values returned by getBroker.

id = None

id is the provider-assigned unique ID for this managed resource.

pulumi_aws.mq.get_broker(broker_id=None, broker_name=None, logs=None, tags=None, opts=None)

Provides information about a MQ Broker.

Parameters
  • broker_id (str) – The unique id of the mq broker.

  • broker_name (str) – The unique name of the mq broker.

The logs object supports the following:

  • audit (bool)

  • general (bool)