1. Docs
  2. Reference
  3. API
  4. AWS
  5. mq
  6. Broker

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.

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",
                },
            },
        });
    }

}

package main

import (
    "github.com/pulumi/pulumi-aws/sdk/v2/go/aws/mq"
    "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        _, err := mq.NewBroker(ctx, "example", &mq.BrokerArgs{
            BrokerName: pulumi.String("example"),
            Configuration: &mq.BrokerConfigurationArgs{
                Id:       pulumi.String(aws_mq_configuration.Test.Id),
                Revision: pulumi.String(aws_mq_configuration.Test.Latest_revision),
            },
            EngineType:       pulumi.String("ActiveMQ"),
            EngineVersion:    pulumi.String("5.15.0"),
            HostInstanceType: pulumi.String("mq.t2.micro"),
            SecurityGroups: pulumi.StringArray{
                pulumi.String(aws_security_group.Test.Id),
            },
            Users: mq.BrokerUserArray{
                &mq.BrokerUserArgs{
                    Password: pulumi.String("MindTheGap"),
                    Username: pulumi.String("ExampleUser"),
                },
            },
        })
        if err != nil {
            return err
        }
        return nil
    })
}
import pulumi
import pulumi_aws as aws

example = aws.mq.Broker("example",
    broker_name="example",
    configuration={
        "id": aws_mq_configuration["test"]["id"],
        "revision": aws_mq_configuration["test"]["latest_revision"],
    },
    engine_type="ActiveMQ",
    engine_version="5.15.0",
    host_instance_type="mq.t2.micro",
    security_groups=[aws_security_group["test"]["id"]],
    users=[{
        "password": "MindTheGap",
        "username": "ExampleUser",
    }])
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",
    }],
});

Create a Broker Resource

new Broker(name: string, args: BrokerArgs, opts?: CustomResourceOptions);
def Broker(resource_name, opts=None, apply_immediately=None, auto_minor_version_upgrade=None, broker_name=None, configuration=None, deployment_mode=None, encryption_options=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);
func NewBroker(ctx *Context, name string, args BrokerArgs, opts ...ResourceOption) (*Broker, error)
public Broker(string name, BrokerArgs args, CustomResourceOptions? opts = null)
name string
The unique name of the resource.
args BrokerArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
opts ResourceOptions
A bag of options that control this resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args BrokerArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args BrokerArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

Broker Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The Broker resource accepts the following input properties:

BrokerName string

The name of the broker.

EngineType string

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

EngineVersion string

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

HostInstanceType string

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

SecurityGroups List<string>

The list of security group IDs assigned to the broker.

Users List<BrokerUserArgs>

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

ApplyImmediately bool

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

AutoMinorVersionUpgrade bool

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

Configuration BrokerConfigurationArgs

Configuration of the broker. See below.

DeploymentMode string

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

EncryptionOptions BrokerEncryptionOptionsArgs

Configuration block containing encryption options. See below.

Logs BrokerLogsArgs

Logging configuration of the broker. See below.

MaintenanceWindowStartTime BrokerMaintenanceWindowStartTimeArgs

Maintenance window start time. See below.

PubliclyAccessible bool

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

SubnetIds List<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.

Tags Dictionary<string, string>

A map of tags to assign to the resource.

BrokerName string

The name of the broker.

EngineType string

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

EngineVersion string

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

HostInstanceType string

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

SecurityGroups []string

The list of security group IDs assigned to the broker.

Users []BrokerUser

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

ApplyImmediately bool

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

AutoMinorVersionUpgrade bool

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

Configuration BrokerConfiguration

Configuration of the broker. See below.

DeploymentMode string

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

EncryptionOptions BrokerEncryptionOptions

Configuration block containing encryption options. See below.

Logs BrokerLogs

Logging configuration of the broker. See below.

MaintenanceWindowStartTime BrokerMaintenanceWindowStartTime

Maintenance window start time. See below.

PubliclyAccessible bool

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

SubnetIds []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.

Tags map[string]string

A map of tags to assign to the resource.

brokerName string

The name of the broker.

engineType string

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

engineVersion string

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

hostInstanceType string

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

securityGroups string[]

The list of security group IDs assigned to the broker.

users BrokerUser[]

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

applyImmediately boolean

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

autoMinorVersionUpgrade boolean

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

configuration BrokerConfiguration

Configuration of the broker. See below.

deploymentMode string

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

encryptionOptions BrokerEncryptionOptions

Configuration block containing encryption options. See below.

logs BrokerLogs

Logging configuration of the broker. See below.

maintenanceWindowStartTime BrokerMaintenanceWindowStartTime

Maintenance window start time. See below.

publiclyAccessible boolean

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

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

tags {[key: string]: string}

A map of tags to assign to the resource.

broker_name str

The name of the broker.

engine_type str

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

engine_version str

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

host_instance_type str

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

security_groups List[str]

The list of security group IDs assigned to the broker.

users List[BrokerUser]

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

apply_immediately bool

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

auto_minor_version_upgrade bool

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

configuration Dict[BrokerConfiguration]

Configuration of the broker. See below.

deployment_mode str

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

encryption_options Dict[BrokerEncryptionOptions]

Configuration block containing encryption options. See below.

logs Dict[BrokerLogs]

Logging configuration of the broker. See below.

maintenance_window_start_time Dict[BrokerMaintenanceWindowStartTime]

Maintenance window start time. See below.

publicly_accessible bool

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

subnet_ids List[str]

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 Dict[str, str]

A map of tags to assign to the resource.

Outputs

All input properties are implicitly available as output properties. Additionally, the Broker resource produces the following output properties:

Arn string

The ARN of the broker.

Id string
The provider-assigned unique ID for this managed resource.
Instances List<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

Arn string

The ARN of the broker.

Id string
The provider-assigned unique ID for this managed resource.
Instances []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

arn string

The ARN of the broker.

id string
The provider-assigned unique ID for this managed resource.
instances 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

arn str

The ARN of the broker.

id str
The provider-assigned unique ID for this managed resource.
instances List[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

Look up an Existing Broker Resource

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

public static get(name: string, id: Input<ID>, state?: BrokerState, opts?: CustomResourceOptions): Broker
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, encryption_options=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, __props__=None);
func GetBroker(ctx *Context, name string, id IDInput, state *BrokerState, opts ...ResourceOption) (*Broker, error)
public static Broker Get(string name, Input<string> id, BrokerState? state, CustomResourceOptions? opts = null)
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.

The following state arguments are supported:

ApplyImmediately bool

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

Arn string

The ARN of the broker.

AutoMinorVersionUpgrade bool

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

BrokerName string

The name of the broker.

Configuration BrokerConfigurationArgs

Configuration of the broker. See below.

DeploymentMode string

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

EncryptionOptions BrokerEncryptionOptionsArgs

Configuration block containing encryption options. See below.

EngineType string

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

EngineVersion string

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

HostInstanceType string

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

Instances List<BrokerInstanceArgs>

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

Logs BrokerLogsArgs

Logging configuration of the broker. See below.

MaintenanceWindowStartTime BrokerMaintenanceWindowStartTimeArgs

Maintenance window start time. See below.

PubliclyAccessible bool

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

SecurityGroups List<string>

The list of security group IDs assigned to the broker.

SubnetIds List<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.

Tags Dictionary<string, string>

A map of tags to assign to the resource.

Users List<BrokerUserArgs>

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

ApplyImmediately bool

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

Arn string

The ARN of the broker.

AutoMinorVersionUpgrade bool

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

BrokerName string

The name of the broker.

Configuration BrokerConfiguration

Configuration of the broker. See below.

DeploymentMode string

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

EncryptionOptions BrokerEncryptionOptions

Configuration block containing encryption options. See below.

EngineType string

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

EngineVersion string

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

HostInstanceType string

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

Instances []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

Logs BrokerLogs

Logging configuration of the broker. See below.

MaintenanceWindowStartTime BrokerMaintenanceWindowStartTime

Maintenance window start time. See below.

PubliclyAccessible bool

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

SecurityGroups []string

The list of security group IDs assigned to the broker.

SubnetIds []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.

Tags map[string]string

A map of tags to assign to the resource.

Users []BrokerUser

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

applyImmediately boolean

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

arn string

The ARN of the broker.

autoMinorVersionUpgrade boolean

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

brokerName string

The name of the broker.

configuration BrokerConfiguration

Configuration of the broker. See below.

deploymentMode string

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

encryptionOptions BrokerEncryptionOptions

Configuration block containing encryption options. See below.

engineType string

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

engineVersion string

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

hostInstanceType string

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

instances 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

logs BrokerLogs

Logging configuration of the broker. See below.

maintenanceWindowStartTime BrokerMaintenanceWindowStartTime

Maintenance window start time. See below.

publiclyAccessible boolean

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

securityGroups string[]

The list of security group IDs assigned to the broker.

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

tags {[key: string]: string}

A map of tags to assign to the resource.

users BrokerUser[]

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

apply_immediately bool

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

arn str

The ARN of the broker.

auto_minor_version_upgrade bool

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

broker_name str

The name of the broker.

configuration Dict[BrokerConfiguration]

Configuration of the broker. See below.

deployment_mode str

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

encryption_options Dict[BrokerEncryptionOptions]

Configuration block containing encryption options. See below.

engine_type str

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

engine_version str

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

host_instance_type str

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

instances List[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

logs Dict[BrokerLogs]

Logging configuration of the broker. See below.

maintenance_window_start_time Dict[BrokerMaintenanceWindowStartTime]

Maintenance window start time. See below.

publicly_accessible bool

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

security_groups List[str]

The list of security group IDs assigned to the broker.

subnet_ids List[str]

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 Dict[str, str]

A map of tags to assign to the resource.

users List[BrokerUser]

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

Supporting Types

BrokerConfiguration

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

Id string

The Configuration ID.

Revision int

Revision of the Configuration.

Id string

The Configuration ID.

Revision int

Revision of the Configuration.

id string

The Configuration ID.

revision number

Revision of the Configuration.

id str

The Configuration ID.

revision float

Revision of the Configuration.

BrokerEncryptionOptions

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

KmsKeyId string

Amazon Resource Name (ARN) of Key Management Service (KMS) Customer Master Key (CMK) to use for encryption at rest. Requires setting use_aws_owned_key to false. To perform drift detection when AWS managed CMKs or customer managed CMKs are in use, this value must be configured.

UseAwsOwnedKey bool

Boolean to enable an AWS owned Key Management Service (KMS) Customer Master Key (CMK) that is not in your account. Defaults to true. Setting to false without configuring kms_key_id will create an AWS managed Customer Master Key (CMK) aliased to aws/mq in your account.

KmsKeyId string

Amazon Resource Name (ARN) of Key Management Service (KMS) Customer Master Key (CMK) to use for encryption at rest. Requires setting use_aws_owned_key to false. To perform drift detection when AWS managed CMKs or customer managed CMKs are in use, this value must be configured.

UseAwsOwnedKey bool

Boolean to enable an AWS owned Key Management Service (KMS) Customer Master Key (CMK) that is not in your account. Defaults to true. Setting to false without configuring kms_key_id will create an AWS managed Customer Master Key (CMK) aliased to aws/mq in your account.

kmsKeyId string

Amazon Resource Name (ARN) of Key Management Service (KMS) Customer Master Key (CMK) to use for encryption at rest. Requires setting use_aws_owned_key to false. To perform drift detection when AWS managed CMKs or customer managed CMKs are in use, this value must be configured.

useAwsOwnedKey boolean

Boolean to enable an AWS owned Key Management Service (KMS) Customer Master Key (CMK) that is not in your account. Defaults to true. Setting to false without configuring kms_key_id will create an AWS managed Customer Master Key (CMK) aliased to aws/mq in your account.

kms_key_id str

Amazon Resource Name (ARN) of Key Management Service (KMS) Customer Master Key (CMK) to use for encryption at rest. Requires setting use_aws_owned_key to false. To perform drift detection when AWS managed CMKs or customer managed CMKs are in use, this value must be configured.

useAwsOwnedKey bool

Boolean to enable an AWS owned Key Management Service (KMS) Customer Master Key (CMK) that is not in your account. Defaults to true. Setting to false without configuring kms_key_id will create an AWS managed Customer Master Key (CMK) aliased to aws/mq in your account.

BrokerInstance

See the output API doc for this type.

See the output API doc for this type.

See the output API doc for this type.

ConsoleUrl string
Endpoints List<string>
IpAddress string
ConsoleUrl string
Endpoints []string
IpAddress string
consoleUrl string
endpoints string[]
ipAddress string
consoleUrl str
endpoints List[str]
ip_address str

BrokerLogs

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

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.

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.

audit boolean

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

general boolean

Enables general logging via CloudWatch. Defaults to false.

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.

BrokerMaintenanceWindowStartTime

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

DayOfWeek string

The day of the week. e.g. MONDAY, TUESDAY, or WEDNESDAY

TimeOfDay string

The time, in 24-hour format. e.g. 02:00

TimeZone string

The time zone, UTC by default, in either the Country/City format, or the UTC offset format. e.g. CET

DayOfWeek string

The day of the week. e.g. MONDAY, TUESDAY, or WEDNESDAY

TimeOfDay string

The time, in 24-hour format. e.g. 02:00

TimeZone string

The time zone, UTC by default, in either the Country/City format, or the UTC offset format. e.g. CET

dayOfWeek string

The day of the week. e.g. MONDAY, TUESDAY, or WEDNESDAY

timeOfDay string

The time, in 24-hour format. e.g. 02:00

timeZone string

The time zone, UTC by default, in either the Country/City format, or the UTC offset format. e.g. CET

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

BrokerUser

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

Password string

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

Username string

The username of the user.

ConsoleAccess bool

Whether to enable access to the ActiveMQ Web Console for the user.

Groups List<string>

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

Password string

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

Username string

The username of the user.

ConsoleAccess bool

Whether to enable access to the ActiveMQ Web Console for the user.

Groups []string

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

password string

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

username string

The username of the user.

consoleAccess boolean

Whether to enable access to the ActiveMQ Web Console for the user.

groups string[]

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.

consoleAccess bool

Whether to enable access to the ActiveMQ Web Console for the user.

groups List[str]

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

Package Details

Repository
https://github.com/pulumi/pulumi-aws
License
Apache-2.0
Notes
This Pulumi package is based on the aws Terraform Provider.