Class Broker

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.

Example Usage

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
public MyStack()
{
    var example = new Aws.Mq.Broker("example", new Aws.Mq.BrokerArgs
    {
        BrokerName = "example",
        Configuration = new Aws.Mq.Inputs.BrokerConfigurationArgs
        {
            Id = aws_mq_configuration.Test.Id,
            Revision = aws_mq_configuration.Test.Latest_revision,
        },
        EngineType = "ActiveMQ",
        EngineVersion = "5.15.0",
        HostInstanceType = "mq.t2.micro",
        SecurityGroups = 
        {
            aws_security_group.Test.Id,
        },
        Users = 
        {
            new Aws.Mq.Inputs.BrokerUserArgs
            {
                Password = "MindTheGap",
                Username = "ExampleUser",
            },
        },
    });
}

}
Inheritance
System.Object
Resource
CustomResource
Broker
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Pulumi.Aws.Mq
Assembly: Pulumi.Aws.dll
Syntax
public class Broker : CustomResource

Constructors

View Source

Broker(String, BrokerArgs, CustomResourceOptions)

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

Declaration
public Broker(string name, BrokerArgs args, CustomResourceOptions options = null)
Parameters
Type Name Description
System.String name

The unique name of the resource
BrokerArgs args

The arguments used to populate this resource's properties
CustomResourceOptions options

A bag of options that control this resource's behavior

Properties

View Source

ApplyImmediately

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

Declaration
public Output<bool?> ApplyImmediately { get; }
Property Value
Type Description
Output<System.Nullable<System.Boolean>>
View Source

Arn

The ARN of the broker.

Declaration
public Output<string> Arn { get; }
Property Value
Type Description
Output<System.String>
View Source

AutoMinorVersionUpgrade

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

Declaration
public Output<bool?> AutoMinorVersionUpgrade { get; }
Property Value
Type Description
Output<System.Nullable<System.Boolean>>
View Source

BrokerName

The name of the broker.

Declaration
public Output<string> BrokerName { get; }
Property Value
Type Description
Output<System.String>
View Source

Configuration

Configuration of the broker. See below.

Declaration
public Output<BrokerConfiguration> Configuration { get; }
Property Value
Type Description
Output<BrokerConfiguration>
View Source

DeploymentMode

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

Declaration
public Output<string> DeploymentMode { get; }
Property Value
Type Description
Output<System.String>
View Source

EncryptionOptions

Configuration block containing encryption options. See below.

Declaration
public Output<BrokerEncryptionOptions> EncryptionOptions { get; }
Property Value
Type Description
Output<BrokerEncryptionOptions>
View Source

EngineType

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

Declaration
public Output<string> EngineType { get; }
Property Value
Type Description
Output<System.String>
View Source

EngineVersion

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

Declaration
public Output<string> EngineVersion { get; }
Property Value
Type Description
Output<System.String>
View Source

HostInstanceType

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

Declaration
public Output<string> HostInstanceType { get; }
Property Value
Type Description
Output<System.String>
View Source

Instances

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
Declaration
public Output<ImmutableArray<BrokerInstance>> Instances { get; }
Property Value
Type Description
Output<System.Collections.Immutable.ImmutableArray<BrokerInstance>>
View Source

Logs

Logging configuration of the broker. See below.

Declaration
public Output<BrokerLogs> Logs { get; }
Property Value
Type Description
Output<BrokerLogs>
View Source

MaintenanceWindowStartTime

Maintenance window start time. See below.

Declaration
public Output<BrokerMaintenanceWindowStartTime> MaintenanceWindowStartTime { get; }
Property Value
Type Description
Output<BrokerMaintenanceWindowStartTime>
View Source

PubliclyAccessible

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

Declaration
public Output<bool?> PubliclyAccessible { get; }
Property Value
Type Description
Output<System.Nullable<System.Boolean>>
View Source

SecurityGroups

The list of security group IDs assigned to the broker.

Declaration
public Output<ImmutableArray<string>> SecurityGroups { get; }
Property Value
Type Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>
View Source

SubnetIds

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.

Declaration
public Output<ImmutableArray<string>> SubnetIds { get; }
Property Value
Type Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>
View Source

Tags

A map of tags to assign to the resource.

Declaration
public Output<ImmutableDictionary<string, object>> Tags { get; }
Property Value
Type Description
Output<System.Collections.Immutable.ImmutableDictionary<System.String, System.Object>>
View Source

Users

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

Declaration
public Output<ImmutableArray<BrokerUser>> Users { get; }
Property Value
Type Description
Output<System.Collections.Immutable.ImmutableArray<BrokerUser>>

Methods

View Source

Get(String, Input<String>, BrokerState, CustomResourceOptions)

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

Declaration
public static Broker Get(string name, Input<string> id, BrokerState state = null, CustomResourceOptions options = null)
Parameters
Type Name Description
System.String name

The unique name of the resulting resource.
Input<System.String> id

The unique provider ID of the resource to lookup.
BrokerState state

Any extra arguments used during the lookup.
CustomResourceOptions options

A bag of options that control this resource's behavior
Returns
Type Description
Broker