1. Docs
2. Reference
3. API
4. @pulumi/aws
5. mq

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

Resources

• Broker
• Configuration

Functions

• getBroker

Others

• BrokerArgs
• BrokerState
• ConfigurationArgs
• ConfigurationState
• GetBrokerArgs
• GetBrokerResult

Resources

Resource Broker

class Broker extends CustomResource

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 applyImmediately flag to instruct the service to apply the change immediately (see documentation below).

Note: using applyImmediately 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.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.mq.Broker("example", {
    brokerName: "example",
    configuration: {
        id: aws_mq_configuration_test.id,
        revision: aws_mq_configuration_test.latestRevision,
    },
    engineType: "ActiveMQ",
    engineVersion: "5.15.0",
    hostInstanceType: "mq.t2.micro",
    securityGroups: [aws_security_group_test.id],
    users: [{
        password: "MindTheGap",
        username: "ExampleUser",
    }],
});

constructor

new Broker(name: string, args: BrokerArgs, opts?: pulumi.CustomResourceOptions)

Create a Broker resource with the given unique name, arguments, and options.

• name The unique name of the resource.
• args The arguments to use to populate this resource's properties.
• opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: BrokerState, opts?: pulumi.CustomResourceOptions): Broker

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Broker

Returns true if the given object is an instance of Broker. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property applyImmediately

public applyImmediately: pulumi.Output<boolean | undefined>;

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

property arn

public arn: pulumi.Output<string>;

The ARN of the broker.

property autoMinorVersionUpgrade

public autoMinorVersionUpgrade: pulumi.Output<boolean | undefined>;

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

property brokerName

public brokerName: pulumi.Output<string>;

The name of the broker.

property configuration

public configuration: pulumi.Output<BrokerConfiguration>;

Configuration of the broker. See below.

property deploymentMode

public deploymentMode: pulumi.Output<string | undefined>;

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

property encryptionOptions

public encryptionOptions: pulumi.Output<BrokerEncryptionOptions | undefined>;

Configuration block containing encryption options. See below.

property engineType

public engineType: pulumi.Output<string>;

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

property engineVersion

public engineVersion: pulumi.Output<string>;

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

property hostInstanceType

public hostInstanceType: pulumi.Output<string>;

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

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property instances

public instances: pulumi.Output<BrokerInstance[]>;

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

property logs

public logs: pulumi.Output<BrokerLogs | undefined>;

Logging configuration of the broker. See below.

property maintenanceWindowStartTime

public maintenanceWindowStartTime: pulumi.Output<BrokerMaintenanceWindowStartTime>;

Maintenance window start time. See below.

property publiclyAccessible

public publiclyAccessible: pulumi.Output<boolean | undefined>;

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

property securityGroups

public securityGroups: pulumi.Output<string[]>;

The list of security group IDs assigned to the broker.

property subnetIds

public subnetIds: pulumi.Output<string[]>;

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.

property tags

public tags: pulumi.Output<{[key: string]: any} | undefined>;

A map of tags to assign to the resource.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property users

public users: pulumi.Output<BrokerUser[]>;

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

Resource Configuration

class Configuration extends CustomResource

Provides an MQ Configuration Resource.

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

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.mq.Configuration("example", {
    data: `<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<broker xmlns="http://activemq.apache.org/schema/core">
  <plugins>
    <forcePersistencyModeBrokerPlugin persistenceFlag="true"/>
    <statisticsBrokerPlugin/>
    <timeStampingBrokerPlugin ttlCeiling="86400000" zeroExpirationOverride="86400000"/>
  </plugins>
</broker>
`,
    description: "Example Configuration",
    engineType: "ActiveMQ",
    engineVersion: "5.15.0",
});

constructor

new Configuration(name: string, args: ConfigurationArgs, opts?: pulumi.CustomResourceOptions)

Create a Configuration resource with the given unique name, arguments, and options.

• name The unique name of the resource.
• args The arguments to use to populate this resource's properties.
• opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ConfigurationState, opts?: pulumi.CustomResourceOptions): Configuration

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Configuration

Returns true if the given object is an instance of Configuration. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property arn

public arn: pulumi.Output<string>;

The ARN of the configuration.

property data

public data: pulumi.Output<string>;

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

property description

public description: pulumi.Output<string | undefined>;

The description of the configuration.

property engineType

public engineType: pulumi.Output<string>;

The type of broker engine.

property engineVersion

public engineVersion: pulumi.Output<string>;

The version of the broker engine.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property latestRevision

public latestRevision: pulumi.Output<number>;

The latest revision of the configuration.

property name

public name: pulumi.Output<string>;

The name of the configuration

property tags

public tags: pulumi.Output<{[key: string]: any} | undefined>;

A map of tags to assign to the resource.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Functions

Function getBroker

getBroker(args?: GetBrokerArgs, opts?: pulumi.InvokeOptions): Promise<GetBrokerResult>

Provides information about a MQ Broker.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const config = new pulumi.Config();
const brokerId = config.get("brokerId") || "";
const brokerName = config.get("brokerName") || "";

const byId = pulumi.output(aws.mq.getBroker({
    brokerId: brokerId,
}, { async: true }));
const byName = pulumi.output(aws.mq.getBroker({
    brokerName: brokerName,
}, { async: true }));

Others

interface BrokerArgs

interface BrokerArgs

The set of arguments for constructing a Broker resource.

property applyImmediately

applyImmediately?: pulumi.Input<boolean>;

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

property autoMinorVersionUpgrade

autoMinorVersionUpgrade?: pulumi.Input<boolean>;

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

property brokerName

brokerName: pulumi.Input<string>;

The name of the broker.

property configuration

configuration?: pulumi.Input<BrokerConfiguration>;

Configuration of the broker. See below.

property deploymentMode

deploymentMode?: pulumi.Input<string>;

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

property encryptionOptions

encryptionOptions?: pulumi.Input<BrokerEncryptionOptions>;

Configuration block containing encryption options. See below.

property engineType

engineType: pulumi.Input<string>;

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

property engineVersion

engineVersion: pulumi.Input<string>;

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

property hostInstanceType

hostInstanceType: pulumi.Input<string>;

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

property logs

logs?: pulumi.Input<BrokerLogs>;

Logging configuration of the broker. See below.

property maintenanceWindowStartTime

maintenanceWindowStartTime?: pulumi.Input<BrokerMaintenanceWindowStartTime>;

Maintenance window start time. See below.

property publiclyAccessible

publiclyAccessible?: pulumi.Input<boolean>;

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

property securityGroups

securityGroups: pulumi.Input<pulumi.Input<string>[]>;

The list of security group IDs assigned to the broker.

property subnetIds

subnetIds?: pulumi.Input<pulumi.Input<string>[]>;

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.

property tags

tags?: pulumi.Input<{[key: string]: any}>;

A map of tags to assign to the resource.

property users

users: pulumi.Input<pulumi.Input<BrokerUser>[]>;

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

interface BrokerState

interface BrokerState

Input properties used for looking up and filtering Broker resources.

property applyImmediately

applyImmediately?: pulumi.Input<boolean>;

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

property arn

arn?: pulumi.Input<string>;

The ARN of the broker.

property autoMinorVersionUpgrade

autoMinorVersionUpgrade?: pulumi.Input<boolean>;

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

property brokerName

brokerName?: pulumi.Input<string>;

The name of the broker.

property configuration

configuration?: pulumi.Input<BrokerConfiguration>;

Configuration of the broker. See below.

property deploymentMode

deploymentMode?: pulumi.Input<string>;

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

property encryptionOptions

encryptionOptions?: pulumi.Input<BrokerEncryptionOptions>;

Configuration block containing encryption options. See below.

property engineType

engineType?: pulumi.Input<string>;

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

property engineVersion

engineVersion?: pulumi.Input<string>;

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

property hostInstanceType

hostInstanceType?: pulumi.Input<string>;

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

property instances

instances?: pulumi.Input<pulumi.Input<BrokerInstance>[]>;

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

property logs

logs?: pulumi.Input<BrokerLogs>;

Logging configuration of the broker. See below.

property maintenanceWindowStartTime

maintenanceWindowStartTime?: pulumi.Input<BrokerMaintenanceWindowStartTime>;

Maintenance window start time. See below.

property publiclyAccessible

publiclyAccessible?: pulumi.Input<boolean>;

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

property securityGroups

securityGroups?: pulumi.Input<pulumi.Input<string>[]>;

The list of security group IDs assigned to the broker.

property subnetIds

subnetIds?: pulumi.Input<pulumi.Input<string>[]>;

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.

property tags

tags?: pulumi.Input<{[key: string]: any}>;

A map of tags to assign to the resource.

property users

users?: pulumi.Input<pulumi.Input<BrokerUser>[]>;

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

interface ConfigurationArgs

interface ConfigurationArgs

The set of arguments for constructing a Configuration resource.

property data

data: pulumi.Input<string>;

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

property description

description?: pulumi.Input<string>;

The description of the configuration.

property engineType

engineType: pulumi.Input<string>;

The type of broker engine.

property engineVersion

engineVersion: pulumi.Input<string>;

The version of the broker engine.

property name

name?: pulumi.Input<string>;

The name of the configuration

property tags

tags?: pulumi.Input<{[key: string]: any}>;

A map of tags to assign to the resource.

interface ConfigurationState

interface ConfigurationState

Input properties used for looking up and filtering Configuration resources.

property arn

arn?: pulumi.Input<string>;

The ARN of the configuration.

property data

data?: pulumi.Input<string>;

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

property description

description?: pulumi.Input<string>;

The description of the configuration.

property engineType

engineType?: pulumi.Input<string>;

The type of broker engine.

property engineVersion

engineVersion?: pulumi.Input<string>;

The version of the broker engine.

property latestRevision

latestRevision?: pulumi.Input<number>;

The latest revision of the configuration.

property name

name?: pulumi.Input<string>;

The name of the configuration

property tags

tags?: pulumi.Input<{[key: string]: any}>;

A map of tags to assign to the resource.

interface GetBrokerArgs

interface GetBrokerArgs

A collection of arguments for invoking getBroker.

property brokerId

brokerId?: undefined | string;

The unique id of the mq broker.

property brokerName

brokerName?: undefined | string;

The unique name of the mq broker.

property logs

logs?: inputs.mq.GetBrokerLogs;

property tags

tags?: undefined | {[key: string]: any};

interface GetBrokerResult

interface GetBrokerResult

A collection of values returned by getBroker.

property arn

arn: string;

property autoMinorVersionUpgrade

autoMinorVersionUpgrade: boolean;

property brokerId

brokerId: string;

property brokerName

brokerName: string;

property configuration

configuration: GetBrokerConfiguration;

property deploymentMode

deploymentMode: string;

property encryptionOptions

encryptionOptions: GetBrokerEncryptionOption[];

property engineType

engineType: string;

property engineVersion

engineVersion: string;

property hostInstanceType

hostInstanceType: string;

property id

id: string;

The provider-assigned unique ID for this managed resource.

property instances

instances: GetBrokerInstance[];

property logs

logs?: outputs.mq.GetBrokerLogs;

property maintenanceWindowStartTime

maintenanceWindowStartTime: GetBrokerMaintenanceWindowStartTime;

property publiclyAccessible

publiclyAccessible: boolean;

property securityGroups

securityGroups: string[];

property subnetIds

subnetIds: string[];

property tags

tags: {[key: string]: any};

property users

users: GetBrokerUser[];