Broker class

Manages an AWS MQ broker. Use to create and manage message brokers for ActiveMQ and RabbitMQ engines.

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

> Note: For RabbitMQ brokers, only one administrative user can be created during provisioning. Additional users must be created via the RabbitMQ Management API or the Amazon MQ console after the broker is provisioned. Terraform cannot update or manage users after broker creation. Any changes to the user block will trigger full broker recreation. Amazon MQ does not return RabbitMQ user information via APIs, meaning drift of the user attribute can not be detected.

> Warning: Amazon MQ currently places limits on RabbitMQ brokers. For example, a RabbitMQ broker cannot have: instances with an associated IP address of an ENI attached to the broker, an associated LDAP server to authenticate and authorize broker connections, storage type EFS, or audit logging. Although this resource allows you to create RabbitMQ users, RabbitMQ users cannot have console access or groups.

> Warning: All arguments including the username and password will be stored in the raw state as plain-text. > Note: 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, Terraform 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). Using applyImmediately can result in a brief downtime as the broker reboots.

Example Usage

Basic Example

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

const example = new aws.mq.Broker("example", {
    configuration: {
        id: test.id,
        revision: Number(test.latestRevision),
    },
    users: [{
        username: "example_user",
        password: "<password>",
    }],
    brokerName: "example",
    engineType: "ActiveMQ",
    engineVersion: "5.17.6",
    hostInstanceType: "mq.t2.micro",
    securityGroups: [testAwsSecurityGroup.id],
});
import pulumi
import pulumi_aws as aws

example = aws.mq.Broker("example",
    configuration={
        "id": test["id"],
        "revision": int(test["latestRevision"]),
    },
    users=[{
        "username": "example_user",
        "password": "<password>",
    }],
    broker_name="example",
    engine_type="ActiveMQ",
    engine_version="5.17.6",
    host_instance_type="mq.t2.micro",
    security_groups=[test_aws_security_group["id"]])
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var example = new Aws.Mq.Broker("example", new()
    {
        Configuration = new Aws.Mq.Inputs.BrokerConfigurationArgs
        {
            Id = test.Id,
            Revision = test.LatestRevision,
        },
        Users = new[]
        {
            new Aws.Mq.Inputs.BrokerUserArgs
            {
                Username = "example_user",
                Password = "<password>",
            },
        },
        BrokerName = "example",
        EngineType = "ActiveMQ",
        EngineVersion = "5.17.6",
        HostInstanceType = "mq.t2.micro",
        SecurityGroups = new[]
        {
            testAwsSecurityGroup.Id,
        },
    });

});
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := mq.NewBroker(ctx, "example", &mq.BrokerArgs{
			Configuration: &mq.BrokerConfigurationArgs{
				Id:       pulumi.Any(test.Id),
				Revision: pulumi.Any(test.LatestRevision),
			},
			Users: mq.BrokerUserArray{
				&mq.BrokerUserArgs{
					Username: pulumi.String("example_user"),
					Password: pulumi.String("<password>"),
				},
			},
			BrokerName:       pulumi.String("example"),
			EngineType:       pulumi.String("ActiveMQ"),
			EngineVersion:    pulumi.String("5.17.6"),
			HostInstanceType: pulumi.String("mq.t2.micro"),
			SecurityGroups: pulumi.StringArray{
				testAwsSecurityGroup.Id,
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_mq_broker" "example" {
  configuration = {
    id       = test.id
    revision = test.latestRevision
  }
  users {
    username = "example_user"
    password = "<password>"
  }
  broker_name        = "example"
  engine_type        = "ActiveMQ"
  engine_version     = "5.17.6"
  host_instance_type = "mq.t2.micro"
  security_groups    = [testAwsSecurityGroup.id]
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.mq.Broker;
import com.pulumi.aws.mq.BrokerArgs;
import com.pulumi.aws.mq.inputs.BrokerConfigurationArgs;
import com.pulumi.aws.mq.inputs.BrokerUserArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new Broker("example", BrokerArgs.builder()
            .configuration(BrokerConfigurationArgs.builder()
                .id(test.id())
                .revision(test.latestRevision())
                .build())
            .users(BrokerUserArgs.builder()
                .username("example_user")
                .password("<password>")
                .build())
            .brokerName("example")
            .engineType("ActiveMQ")
            .engineVersion("5.17.6")
            .hostInstanceType("mq.t2.micro")
            .securityGroups(testAwsSecurityGroup.id())
            .build());

    }
}
resources:
  example:
    type: aws:mq:Broker
    properties:
      configuration:
        id: ${test.id}
        revision: ${test.latestRevision}
      users:
        - username: example_user
          password: <password>
      brokerName: example
      engineType: ActiveMQ
      engineVersion: 5.17.6
      hostInstanceType: mq.t2.micro
      securityGroups:
        - ${testAwsSecurityGroup.id}

High-throughput Optimized Example

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

const example = new aws.mq.Broker("example", {
    configuration: {
        id: test.id,
        revision: Number(test.latestRevision),
    },
    users: [{
        username: "example_user",
        password: "<password>",
    }],
    brokerName: "example",
    engineType: "ActiveMQ",
    engineVersion: "5.17.6",
    storageType: "ebs",
    hostInstanceType: "mq.m5.large",
    securityGroups: [testAwsSecurityGroup.id],
});
import pulumi
import pulumi_aws as aws

example = aws.mq.Broker("example",
    configuration={
        "id": test["id"],
        "revision": int(test["latestRevision"]),
    },
    users=[{
        "username": "example_user",
        "password": "<password>",
    }],
    broker_name="example",
    engine_type="ActiveMQ",
    engine_version="5.17.6",
    storage_type="ebs",
    host_instance_type="mq.m5.large",
    security_groups=[test_aws_security_group["id"]])
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var example = new Aws.Mq.Broker("example", new()
    {
        Configuration = new Aws.Mq.Inputs.BrokerConfigurationArgs
        {
            Id = test.Id,
            Revision = test.LatestRevision,
        },
        Users = new[]
        {
            new Aws.Mq.Inputs.BrokerUserArgs
            {
                Username = "example_user",
                Password = "<password>",
            },
        },
        BrokerName = "example",
        EngineType = "ActiveMQ",
        EngineVersion = "5.17.6",
        StorageType = "ebs",
        HostInstanceType = "mq.m5.large",
        SecurityGroups = new[]
        {
            testAwsSecurityGroup.Id,
        },
    });

});
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := mq.NewBroker(ctx, "example", &mq.BrokerArgs{
			Configuration: &mq.BrokerConfigurationArgs{
				Id:       pulumi.Any(test.Id),
				Revision: pulumi.Any(test.LatestRevision),
			},
			Users: mq.BrokerUserArray{
				&mq.BrokerUserArgs{
					Username: pulumi.String("example_user"),
					Password: pulumi.String("<password>"),
				},
			},
			BrokerName:       pulumi.String("example"),
			EngineType:       pulumi.String("ActiveMQ"),
			EngineVersion:    pulumi.String("5.17.6"),
			StorageType:      pulumi.String("ebs"),
			HostInstanceType: pulumi.String("mq.m5.large"),
			SecurityGroups: pulumi.StringArray{
				testAwsSecurityGroup.Id,
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_mq_broker" "example" {
  configuration = {
    id       = test.id
    revision = test.latestRevision
  }
  users {
    username = "example_user"
    password = "<password>"
  }
  broker_name        = "example"
  engine_type        = "ActiveMQ"
  engine_version     = "5.17.6"
  storage_type       = "ebs"
  host_instance_type = "mq.m5.large"
  security_groups    = [testAwsSecurityGroup.id]
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.mq.Broker;
import com.pulumi.aws.mq.BrokerArgs;
import com.pulumi.aws.mq.inputs.BrokerConfigurationArgs;
import com.pulumi.aws.mq.inputs.BrokerUserArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new Broker("example", BrokerArgs.builder()
            .configuration(BrokerConfigurationArgs.builder()
                .id(test.id())
                .revision(test.latestRevision())
                .build())
            .users(BrokerUserArgs.builder()
                .username("example_user")
                .password("<password>")
                .build())
            .brokerName("example")
            .engineType("ActiveMQ")
            .engineVersion("5.17.6")
            .storageType("ebs")
            .hostInstanceType("mq.m5.large")
            .securityGroups(testAwsSecurityGroup.id())
            .build());

    }
}
resources:
  example:
    type: aws:mq:Broker
    properties:
      configuration:
        id: ${test.id}
        revision: ${test.latestRevision}
      users:
        - username: example_user
          password: <password>
      brokerName: example
      engineType: ActiveMQ
      engineVersion: 5.17.6
      storageType: ebs
      hostInstanceType: mq.m5.large
      securityGroups:
        - ${testAwsSecurityGroup.id}

Cross-Region Data Replication

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

const examplePrimary = new aws.mq.Broker("example_primary", {
    users: [
        {
            username: "example_user",
            password: "<password>",
        },
        {
            username: "example_replication_user",
            password: "<password>",
            replicationUser: true,
        },
    ],
    applyImmediately: true,
    brokerName: "example_primary",
    engineType: "ActiveMQ",
    engineVersion: "5.17.6",
    hostInstanceType: "mq.m5.large",
    securityGroups: [examplePrimaryAwsSecurityGroup.id],
    deploymentMode: "ACTIVE_STANDBY_MULTI_AZ",
});
const example = new aws.mq.Broker("example", {
    users: [
        {
            username: "example_user",
            password: "<password>",
        },
        {
            username: "example_replication_user",
            password: "<password>",
            replicationUser: true,
        },
    ],
    applyImmediately: true,
    brokerName: "example",
    engineType: "ActiveMQ",
    engineVersion: "5.17.6",
    hostInstanceType: "mq.m5.large",
    securityGroups: [exampleAwsSecurityGroup.id],
    deploymentMode: "ACTIVE_STANDBY_MULTI_AZ",
    dataReplicationMode: "CRDR",
    dataReplicationPrimaryBrokerArn: primary.arn,
});
import pulumi
import pulumi_aws as aws

example_primary = aws.mq.Broker("example_primary",
    users=[
        {
            "username": "example_user",
            "password": "<password>",
        },
        {
            "username": "example_replication_user",
            "password": "<password>",
            "replication_user": True,
        },
    ],
    apply_immediately=True,
    broker_name="example_primary",
    engine_type="ActiveMQ",
    engine_version="5.17.6",
    host_instance_type="mq.m5.large",
    security_groups=[example_primary_aws_security_group["id"]],
    deployment_mode="ACTIVE_STANDBY_MULTI_AZ")
example = aws.mq.Broker("example",
    users=[
        {
            "username": "example_user",
            "password": "<password>",
        },
        {
            "username": "example_replication_user",
            "password": "<password>",
            "replication_user": True,
        },
    ],
    apply_immediately=True,
    broker_name="example",
    engine_type="ActiveMQ",
    engine_version="5.17.6",
    host_instance_type="mq.m5.large",
    security_groups=[example_aws_security_group["id"]],
    deployment_mode="ACTIVE_STANDBY_MULTI_AZ",
    data_replication_mode="CRDR",
    data_replication_primary_broker_arn=primary["arn"])
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var examplePrimary = new Aws.Mq.Broker("example_primary", new()
    {
        Users = new[]
        {
            new Aws.Mq.Inputs.BrokerUserArgs
            {
                Username = "example_user",
                Password = "<password>",
            },
            new Aws.Mq.Inputs.BrokerUserArgs
            {
                Username = "example_replication_user",
                Password = "<password>",
                ReplicationUser = true,
            },
        },
        ApplyImmediately = true,
        BrokerName = "example_primary",
        EngineType = "ActiveMQ",
        EngineVersion = "5.17.6",
        HostInstanceType = "mq.m5.large",
        SecurityGroups = new[]
        {
            examplePrimaryAwsSecurityGroup.Id,
        },
        DeploymentMode = "ACTIVE_STANDBY_MULTI_AZ",
    });

    var example = new Aws.Mq.Broker("example", new()
    {
        Users = new[]
        {
            new Aws.Mq.Inputs.BrokerUserArgs
            {
                Username = "example_user",
                Password = "<password>",
            },
            new Aws.Mq.Inputs.BrokerUserArgs
            {
                Username = "example_replication_user",
                Password = "<password>",
                ReplicationUser = true,
            },
        },
        ApplyImmediately = true,
        BrokerName = "example",
        EngineType = "ActiveMQ",
        EngineVersion = "5.17.6",
        HostInstanceType = "mq.m5.large",
        SecurityGroups = new[]
        {
            exampleAwsSecurityGroup.Id,
        },
        DeploymentMode = "ACTIVE_STANDBY_MULTI_AZ",
        DataReplicationMode = "CRDR",
        DataReplicationPrimaryBrokerArn = primary.Arn,
    });

});
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := mq.NewBroker(ctx, "example_primary", &mq.BrokerArgs{
			Users: mq.BrokerUserArray{
				&mq.BrokerUserArgs{
					Username: pulumi.String("example_user"),
					Password: pulumi.String("<password>"),
				},
				&mq.BrokerUserArgs{
					Username:        pulumi.String("example_replication_user"),
					Password:        pulumi.String("<password>"),
					ReplicationUser: pulumi.Bool(true),
				},
			},
			ApplyImmediately: pulumi.Bool(true),
			BrokerName:       pulumi.String("example_primary"),
			EngineType:       pulumi.String("ActiveMQ"),
			EngineVersion:    pulumi.String("5.17.6"),
			HostInstanceType: pulumi.String("mq.m5.large"),
			SecurityGroups: pulumi.StringArray{
				examplePrimaryAwsSecurityGroup.Id,
			},
			DeploymentMode: pulumi.String("ACTIVE_STANDBY_MULTI_AZ"),
		})
		if err != nil {
			return err
		}
		_, err = mq.NewBroker(ctx, "example", &mq.BrokerArgs{
			Users: mq.BrokerUserArray{
				&mq.BrokerUserArgs{
					Username: pulumi.String("example_user"),
					Password: pulumi.String("<password>"),
				},
				&mq.BrokerUserArgs{
					Username:        pulumi.String("example_replication_user"),
					Password:        pulumi.String("<password>"),
					ReplicationUser: pulumi.Bool(true),
				},
			},
			ApplyImmediately: pulumi.Bool(true),
			BrokerName:       pulumi.String("example"),
			EngineType:       pulumi.String("ActiveMQ"),
			EngineVersion:    pulumi.String("5.17.6"),
			HostInstanceType: pulumi.String("mq.m5.large"),
			SecurityGroups: pulumi.StringArray{
				exampleAwsSecurityGroup.Id,
			},
			DeploymentMode:                  pulumi.String("ACTIVE_STANDBY_MULTI_AZ"),
			DataReplicationMode:             pulumi.String("CRDR"),
			DataReplicationPrimaryBrokerArn: pulumi.Any(primary.Arn),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_mq_broker" "example_primary" {
  users {
    username = "example_user"
    password = "<password>"
  }
  users {
    username         = "example_replication_user"
    password         = "<password>"
    replication_user = true
  }
  apply_immediately  = true
  broker_name        = "example_primary"
  engine_type        = "ActiveMQ"
  engine_version     = "5.17.6"
  host_instance_type = "mq.m5.large"
  security_groups    = [examplePrimaryAwsSecurityGroup.id]
  deployment_mode    = "ACTIVE_STANDBY_MULTI_AZ"
}
resource "aws_mq_broker" "example" {
  users {
    username = "example_user"
    password = "<password>"
  }
  users {
    username         = "example_replication_user"
    password         = "<password>"
    replication_user = true
  }
  apply_immediately                   = true
  broker_name                         = "example"
  engine_type                         = "ActiveMQ"
  engine_version                      = "5.17.6"
  host_instance_type                  = "mq.m5.large"
  security_groups                     = [exampleAwsSecurityGroup.id]
  deployment_mode                     = "ACTIVE_STANDBY_MULTI_AZ"
  data_replication_mode               = "CRDR"
  data_replication_primary_broker_arn = primary.arn
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.mq.Broker;
import com.pulumi.aws.mq.BrokerArgs;
import com.pulumi.aws.mq.inputs.BrokerUserArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var examplePrimary = new Broker("examplePrimary", BrokerArgs.builder()
            .users(
                BrokerUserArgs.builder()
                    .username("example_user")
                    .password("<password>")
                    .build(),
                BrokerUserArgs.builder()
                    .username("example_replication_user")
                    .password("<password>")
                    .replicationUser(true)
                    .build())
            .applyImmediately(true)
            .brokerName("example_primary")
            .engineType("ActiveMQ")
            .engineVersion("5.17.6")
            .hostInstanceType("mq.m5.large")
            .securityGroups(examplePrimaryAwsSecurityGroup.id())
            .deploymentMode("ACTIVE_STANDBY_MULTI_AZ")
            .build());

        var example = new Broker("example", BrokerArgs.builder()
            .users(
                BrokerUserArgs.builder()
                    .username("example_user")
                    .password("<password>")
                    .build(),
                BrokerUserArgs.builder()
                    .username("example_replication_user")
                    .password("<password>")
                    .replicationUser(true)
                    .build())
            .applyImmediately(true)
            .brokerName("example")
            .engineType("ActiveMQ")
            .engineVersion("5.17.6")
            .hostInstanceType("mq.m5.large")
            .securityGroups(exampleAwsSecurityGroup.id())
            .deploymentMode("ACTIVE_STANDBY_MULTI_AZ")
            .dataReplicationMode("CRDR")
            .dataReplicationPrimaryBrokerArn(primary.arn())
            .build());

    }
}
resources:
  examplePrimary:
    type: aws:mq:Broker
    name: example_primary
    properties:
      users:
        - username: example_user
          password: <password>
        - username: example_replication_user
          password: <password>
          replicationUser: true
      applyImmediately: true
      brokerName: example_primary
      engineType: ActiveMQ
      engineVersion: 5.17.6
      hostInstanceType: mq.m5.large
      securityGroups:
        - ${examplePrimaryAwsSecurityGroup.id}
      deploymentMode: ACTIVE_STANDBY_MULTI_AZ
  example:
    type: aws:mq:Broker
    properties:
      users:
        - username: example_user
          password: <password>
        - username: example_replication_user
          password: <password>
          replicationUser: true
      applyImmediately: true
      brokerName: example
      engineType: ActiveMQ
      engineVersion: 5.17.6
      hostInstanceType: mq.m5.large
      securityGroups:
        - ${exampleAwsSecurityGroup.id}
      deploymentMode: ACTIVE_STANDBY_MULTI_AZ
      dataReplicationMode: CRDR
      dataReplicationPrimaryBrokerArn: ${primary.arn}

See the AWS MQ documentation on cross-region data replication for additional details.

Import

Using pulumi import, import MQ Brokers using their broker id. For example:

$ pulumi import aws:mq/broker:Broker example a1b2c3d4-d5f6-7777-8888-9999aaaabbbbcccc

Constructors

Broker(String name, {BrokerArgs? args, CustomResourceOptions? options})
Creates a new Broker. name The Pulumi resource name. args Arguments used to configure this Broker. The set of arguments for Broker. options Resource options controlling this resource's behavior.
Broker.reference(String urn)
Creates a typed reference to an existing Broker resource.

Properties

applyImmediately ↔ Output<bool?>
Whether to apply broker modifications immediately. Default is false.
latefinal
arn ↔ Output<String>
ARN of the broker.
latefinal
authenticationStrategy ↔ Output<String>
Authentication strategy used to secure the broker. Valid values are simple and ldap. ldap is not supported for engineType RabbitMQ.
latefinal
autoMinorVersionUpgrade ↔ Output<bool?>
Whether to automatically upgrade to new minor versions of brokers as Amazon MQ makes releases available.
latefinal
brokerName ↔ Output<String>
Name of the broker.
latefinal
childResources → Set<Resource>
finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
configuration ↔ Output<BrokerConfiguration>
Configuration block for broker configuration. Applies to engineType of ActiveMQ and RabbitMQ only. Detailed below.
latefinal
dataReplicationMode ↔ Output<String>
Whether this broker is part of a data replication pair. Valid values are CRDR and NONE.
latefinal
dataReplicationPrimaryBrokerArn ↔ Output<String?>
ARN of the primary broker used to replicate data in a data replication pair. Required when dataReplicationMode is CRDR.
latefinal
deploymentMode ↔ Output<String?>
Deployment mode of the broker. Valid values are SINGLE_INSTANCE, ACTIVE_STANDBY_MULTI_AZ, and CLUSTER_MULTI_AZ. Default is SINGLE_INSTANCE.
latefinal
encryptionOptions ↔ Output<BrokerEncryptionOptions?>
Configuration block containing encryption options. Detailed below.
latefinal
engineType ↔ Output<String>
Type of broker engine. Valid values are ActiveMQ and RabbitMQ.
latefinal
engineVersion ↔ Output<String>
Version of the broker engine.
latefinal
hashCode → int
The hash code for this object.
no setterinherited
hostInstanceType ↔ Output<String>
Broker's instance type. For example, mq.t3.micro, mq.m5.large.
latefinal
id ↔ Output<String>
getter/setter pairinherited
instances ↔ Output<List<BrokerInstance>>
List of information about allocated brokers (both active & standby).
latefinal
isCustom → bool
Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool
Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool
Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool
Whether this instance represents a resource value returned over RPC.
finalinherited
ldapServerMetadata ↔ Output<BrokerLdapServerMetadata?>
Configuration block for the LDAP server used to authenticate and authorize connections. Not supported for engineType RabbitMQ. Detailed below.
latefinal
logs ↔ Output<BrokerLogs?>
Configuration block for the logging configuration. Detailed below.
latefinal
maintenanceWindowStartTime ↔ Output<BrokerMaintenanceWindowStartTime>
Configuration block for the maintenance window start time. Detailed below.
latefinal
pendingDataReplicationMode ↔ Output<String>
Data replication mode that will be applied after reboot.
latefinal
publiclyAccessible ↔ Output<bool?>
Whether to enable connections from applications outside of the VPC that hosts the broker's subnets.
latefinal
region ↔ Output<String>
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
resourceShareArns ↔ Output<List<String>?>
Set of AWS RAM resource share ARNs that grant the broker access to shared resources for private networking. Applies to engineType of RabbitMQ only. Because Amazon MQ applies resource shares during a reboot, set applyImmediately to true for changes to take effect without waiting for the next maintenance window.
latefinal
resourceTransforms → List<ResourceTransform>
Inherited/explicit async transforms.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
securityGroups ↔ Output<List<String>?>
List of security group IDs assigned to the broker.
latefinal
sharedResources ↔ Output<List<BrokerSharedResource>>
List of resources shared with the broker via resourceShareArns. Only populated for engineType of RabbitMQ.
latefinal
storageType ↔ Output<String>
Storage type of the broker. For engineType ActiveMQ, valid values are efs and ebs (AWS-default is efs). For engineType RabbitMQ, only ebs is supported. When using ebs, only the mq.m5 broker instance type family is supported.
latefinal
subnetIds ↔ Output<List<String>>
List of subnet IDs in which to launch the broker. A SINGLE_INSTANCE deployment requires one subnet. An ACTIVE_STANDBY_MULTI_AZ deployment requires multiple subnets.
latefinal
tags ↔ Output<Map<String, String>?>
Map of tags to assign to the broker. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
latefinal
tagsAll ↔ Output<Map<String, String>>
Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
latefinal
transformations → List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
urn ↔ Output<String>
latefinalinherited
users ↔ Output<List<BrokerUser>?>
Configuration block for broker users. For engineType of RabbitMQ, Amazon MQ does not return broker users preventing this resource from making user updates and drift detection. Detailed below.
latefinal

Methods

failId(Object error) → void
Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void
Completes all output properties with error.
inherited
failUrn(Object error) → void
Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?
Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String
Returns this resource's logical name.
inherited
getResourceType() → String
Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>
Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void
Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void
Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void
Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>
Serializes resource properties for RPC transmission.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {BrokerState? state, CustomResourceOptions? options}) → Broker
Gets an existing Broker resource's state with the given name and id.