Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. mq
  5. Broker
AWS v6.80.0 published on Tuesday, May 6, 2025 by Pulumi
pulumi/pulumi-aws

aws.mq.Broker

Explore with Pulumi AI

aws logo
AWS v6.80.0 published on Tuesday, May 6, 2025 by Pulumi
pulumi/pulumi-aws

    Provides an Amazon MQ broker resource. This resources also manages users for the broker.

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

    NOTE: 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. Also, Amazon MQ does not return information about RabbitMQ users so drift detection is not possible.

    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, the 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). Using apply_immediately 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", {
    brokerName: "example",
    configuration: {
        id: test.id,
        revision: test.latestRevision,
    },
    engineType: "ActiveMQ",
    engineVersion: "5.17.6",
    hostInstanceType: "mq.t2.micro",
    securityGroups: [testAwsSecurityGroup.id],
    users: [{
        username: "ExampleUser",
        password: "MindTheGap",
    }],
});

    import pulumi
import pulumi_aws as aws

example = aws.mq.Broker("example",
    broker_name="example",
    configuration={
        "id": test["id"],
        "revision": test["latestRevision"],
    },
    engine_type="ActiveMQ",
    engine_version="5.17.6",
    host_instance_type="mq.t2.micro",
    security_groups=[test_aws_security_group["id"]],
    users=[{
        "username": "ExampleUser",
        "password": "MindTheGap",
    }])

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/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{
			BrokerName: pulumi.String("example"),
			Configuration: &mq.BrokerConfigurationArgs{
				Id:       pulumi.Any(test.Id),
				Revision: pulumi.Any(test.LatestRevision),
			},
			EngineType:       pulumi.String("ActiveMQ"),
			EngineVersion:    pulumi.String("5.17.6"),
			HostInstanceType: pulumi.String("mq.t2.micro"),
			SecurityGroups: pulumi.StringArray{
				testAwsSecurityGroup.Id,
			},
			Users: mq.BrokerUserArray{
				&mq.BrokerUserArgs{
					Username: pulumi.String("ExampleUser"),
					Password: pulumi.String("MindTheGap"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    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()
    {
        BrokerName = "example",
        Configuration = new Aws.Mq.Inputs.BrokerConfigurationArgs
        {
            Id = test.Id,
            Revision = test.LatestRevision,
        },
        EngineType = "ActiveMQ",
        EngineVersion = "5.17.6",
        HostInstanceType = "mq.t2.micro",
        SecurityGroups = new[]
        {
            testAwsSecurityGroup.Id,
        },
        Users = new[]
        {
            new Aws.Mq.Inputs.BrokerUserArgs
            {
                Username = "ExampleUser",
                Password = "MindTheGap",
            },
        },
    });

});

    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.List;
import java.util.ArrayList;
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()
            .brokerName("example")
            .configuration(BrokerConfigurationArgs.builder()
                .id(test.id())
                .revision(test.latestRevision())
                .build())
            .engineType("ActiveMQ")
            .engineVersion("5.17.6")
            .hostInstanceType("mq.t2.micro")
            .securityGroups(testAwsSecurityGroup.id())
            .users(BrokerUserArgs.builder()
                .username("ExampleUser")
                .password("MindTheGap")
                .build())
            .build());

    }
}

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

    High-throughput Optimized Example

    This example shows the use of EBS storage for high-throughput optimized performance.

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

const example = new aws.mq.Broker("example", {
    brokerName: "example",
    configuration: {
        id: test.id,
        revision: test.latestRevision,
    },
    engineType: "ActiveMQ",
    engineVersion: "5.17.6",
    storageType: "ebs",
    hostInstanceType: "mq.m5.large",
    securityGroups: [testAwsSecurityGroup.id],
    users: [{
        username: "ExampleUser",
        password: "MindTheGap",
    }],
});

    import pulumi
import pulumi_aws as aws

example = aws.mq.Broker("example",
    broker_name="example",
    configuration={
        "id": test["id"],
        "revision": test["latestRevision"],
    },
    engine_type="ActiveMQ",
    engine_version="5.17.6",
    storage_type="ebs",
    host_instance_type="mq.m5.large",
    security_groups=[test_aws_security_group["id"]],
    users=[{
        "username": "ExampleUser",
        "password": "MindTheGap",
    }])

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/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{
			BrokerName: pulumi.String("example"),
			Configuration: &mq.BrokerConfigurationArgs{
				Id:       pulumi.Any(test.Id),
				Revision: pulumi.Any(test.LatestRevision),
			},
			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,
			},
			Users: mq.BrokerUserArray{
				&mq.BrokerUserArgs{
					Username: pulumi.String("ExampleUser"),
					Password: pulumi.String("MindTheGap"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    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()
    {
        BrokerName = "example",
        Configuration = new Aws.Mq.Inputs.BrokerConfigurationArgs
        {
            Id = test.Id,
            Revision = test.LatestRevision,
        },
        EngineType = "ActiveMQ",
        EngineVersion = "5.17.6",
        StorageType = "ebs",
        HostInstanceType = "mq.m5.large",
        SecurityGroups = new[]
        {
            testAwsSecurityGroup.Id,
        },
        Users = new[]
        {
            new Aws.Mq.Inputs.BrokerUserArgs
            {
                Username = "ExampleUser",
                Password = "MindTheGap",
            },
        },
    });

});

    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.List;
import java.util.ArrayList;
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()
            .brokerName("example")
            .configuration(BrokerConfigurationArgs.builder()
                .id(test.id())
                .revision(test.latestRevision())
                .build())
            .engineType("ActiveMQ")
            .engineVersion("5.17.6")
            .storageType("ebs")
            .hostInstanceType("mq.m5.large")
            .securityGroups(testAwsSecurityGroup.id())
            .users(BrokerUserArgs.builder()
                .username("ExampleUser")
                .password("MindTheGap")
                .build())
            .build());

    }
}

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

    Cross-Region Data Replication

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

const examplePrimary = new aws.mq.Broker("example_primary", {
    applyImmediately: true,
    brokerName: "example_primary",
    engineType: "ActiveMQ",
    engineVersion: "5.17.6",
    hostInstanceType: "mq.m5.large",
    securityGroups: [examplePrimaryAwsSecurityGroup.id],
    deploymentMode: "ACTIVE_STANDBY_MULTI_AZ",
    users: [
        {
            username: "ExampleUser",
            password: "MindTheGap",
        },
        {
            username: "ExampleReplicationUser",
            password: "Example12345",
            replicationUser: true,
        },
    ],
});
const example = new aws.mq.Broker("example", {
    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,
    users: [
        {
            username: "ExampleUser",
            password: "MindTheGap",
        },
        {
            username: "ExampleReplicationUser",
            password: "Example12345",
            replicationUser: true,
        },
    ],
});

    import pulumi
import pulumi_aws as aws

example_primary = aws.mq.Broker("example_primary",
    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",
    users=[
        {
            "username": "ExampleUser",
            "password": "MindTheGap",
        },
        {
            "username": "ExampleReplicationUser",
            "password": "Example12345",
            "replication_user": True,
        },
    ])
example = aws.mq.Broker("example",
    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"],
    users=[
        {
            "username": "ExampleUser",
            "password": "MindTheGap",
        },
        {
            "username": "ExampleReplicationUser",
            "password": "Example12345",
            "replication_user": True,
        },
    ])

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/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{
			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"),
			Users: mq.BrokerUserArray{
				&mq.BrokerUserArgs{
					Username: pulumi.String("ExampleUser"),
					Password: pulumi.String("MindTheGap"),
				},
				&mq.BrokerUserArgs{
					Username:        pulumi.String("ExampleReplicationUser"),
					Password:        pulumi.String("Example12345"),
					ReplicationUser: pulumi.Bool(true),
				},
			},
		})
		if err != nil {
			return err
		}
		_, err = mq.NewBroker(ctx, "example", &mq.BrokerArgs{
			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),
			Users: mq.BrokerUserArray{
				&mq.BrokerUserArgs{
					Username: pulumi.String("ExampleUser"),
					Password: pulumi.String("MindTheGap"),
				},
				&mq.BrokerUserArgs{
					Username:        pulumi.String("ExampleReplicationUser"),
					Password:        pulumi.String("Example12345"),
					ReplicationUser: pulumi.Bool(true),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    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()
    {
        ApplyImmediately = true,
        BrokerName = "example_primary",
        EngineType = "ActiveMQ",
        EngineVersion = "5.17.6",
        HostInstanceType = "mq.m5.large",
        SecurityGroups = new[]
        {
            examplePrimaryAwsSecurityGroup.Id,
        },
        DeploymentMode = "ACTIVE_STANDBY_MULTI_AZ",
        Users = new[]
        {
            new Aws.Mq.Inputs.BrokerUserArgs
            {
                Username = "ExampleUser",
                Password = "MindTheGap",
            },
            new Aws.Mq.Inputs.BrokerUserArgs
            {
                Username = "ExampleReplicationUser",
                Password = "Example12345",
                ReplicationUser = true,
            },
        },
    });

    var example = new Aws.Mq.Broker("example", new()
    {
        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,
        Users = new[]
        {
            new Aws.Mq.Inputs.BrokerUserArgs
            {
                Username = "ExampleUser",
                Password = "MindTheGap",
            },
            new Aws.Mq.Inputs.BrokerUserArgs
            {
                Username = "ExampleReplicationUser",
                Password = "Example12345",
                ReplicationUser = true,
            },
        },
    });

});

    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.List;
import java.util.ArrayList;
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()
            .applyImmediately(true)
            .brokerName("example_primary")
            .engineType("ActiveMQ")
            .engineVersion("5.17.6")
            .hostInstanceType("mq.m5.large")
            .securityGroups(examplePrimaryAwsSecurityGroup.id())
            .deploymentMode("ACTIVE_STANDBY_MULTI_AZ")
            .users(            
                BrokerUserArgs.builder()
                    .username("ExampleUser")
                    .password("MindTheGap")
                    .build(),
                BrokerUserArgs.builder()
                    .username("ExampleReplicationUser")
                    .password("Example12345")
                    .replicationUser(true)
                    .build())
            .build());

        var example = new Broker("example", BrokerArgs.builder()
            .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())
            .users(            
                BrokerUserArgs.builder()
                    .username("ExampleUser")
                    .password("MindTheGap")
                    .build(),
                BrokerUserArgs.builder()
                    .username("ExampleReplicationUser")
                    .password("Example12345")
                    .replicationUser(true)
                    .build())
            .build());

    }
}

    resources:
  examplePrimary:
    type: aws:mq:Broker
    name: example_primary
    properties:
      applyImmediately: true
      brokerName: example_primary
      engineType: ActiveMQ
      engineVersion: 5.17.6
      hostInstanceType: mq.m5.large
      securityGroups:
        - ${examplePrimaryAwsSecurityGroup.id}
      deploymentMode: ACTIVE_STANDBY_MULTI_AZ
      users:
        - username: ExampleUser
          password: MindTheGap
        - username: ExampleReplicationUser
          password: Example12345
          replicationUser: true
  example:
    type: aws:mq:Broker
    properties:
      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}
      users:
        - username: ExampleUser
          password: MindTheGap
        - username: ExampleReplicationUser
          password: Example12345
          replicationUser: true

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

    Create Broker Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Broker(name: string, args: BrokerArgs, opts?: CustomResourceOptions);
    @overload
def Broker(resource_name: str,
           args: BrokerArgs,
           opts: Optional[ResourceOptions] = None)

@overload
def Broker(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           engine_type: Optional[str] = None,
           users: Optional[Sequence[BrokerUserArgs]] = None,
           host_instance_type: Optional[str] = None,
           engine_version: Optional[str] = None,
           data_replication_mode: Optional[str] = None,
           logs: Optional[BrokerLogsArgs] = None,
           data_replication_primary_broker_arn: Optional[str] = None,
           deployment_mode: Optional[str] = None,
           encryption_options: Optional[BrokerEncryptionOptionsArgs] = None,
           configuration: Optional[BrokerConfigurationArgs] = None,
           broker_name: Optional[str] = None,
           auto_minor_version_upgrade: Optional[bool] = None,
           ldap_server_metadata: Optional[BrokerLdapServerMetadataArgs] = None,
           apply_immediately: Optional[bool] = None,
           maintenance_window_start_time: Optional[BrokerMaintenanceWindowStartTimeArgs] = None,
           publicly_accessible: Optional[bool] = None,
           security_groups: Optional[Sequence[str]] = None,
           storage_type: Optional[str] = None,
           subnet_ids: Optional[Sequence[str]] = None,
           tags: Optional[Mapping[str, str]] = None,
           authentication_strategy: Optional[str] = None)
    func NewBroker(ctx *Context, name string, args BrokerArgs, opts ...ResourceOption) (*Broker, error)
    public Broker(string name, BrokerArgs args, CustomResourceOptions? opts = null)
    public Broker(String name, BrokerArgs args)
public Broker(String name, BrokerArgs args, CustomResourceOptions options)

    type: aws:mq:Broker
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    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.
    args BrokerArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control 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.
    name String
    The unique name of the resource.
    args BrokerArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var brokerResource = new Aws.Mq.Broker("brokerResource", new()
{
    EngineType = "string",
    Users = new[]
    {
        new Aws.Mq.Inputs.BrokerUserArgs
        {
            Password = "string",
            Username = "string",
            ConsoleAccess = false,
            Groups = new[]
            {
                "string",
            },
            ReplicationUser = false,
        },
    },
    HostInstanceType = "string",
    EngineVersion = "string",
    DataReplicationMode = "string",
    Logs = new Aws.Mq.Inputs.BrokerLogsArgs
    {
        Audit = false,
        General = false,
    },
    DataReplicationPrimaryBrokerArn = "string",
    DeploymentMode = "string",
    EncryptionOptions = new Aws.Mq.Inputs.BrokerEncryptionOptionsArgs
    {
        KmsKeyId = "string",
        UseAwsOwnedKey = false,
    },
    Configuration = new Aws.Mq.Inputs.BrokerConfigurationArgs
    {
        Id = "string",
        Revision = 0,
    },
    BrokerName = "string",
    AutoMinorVersionUpgrade = false,
    LdapServerMetadata = new Aws.Mq.Inputs.BrokerLdapServerMetadataArgs
    {
        Hosts = new[]
        {
            "string",
        },
        RoleBase = "string",
        RoleName = "string",
        RoleSearchMatching = "string",
        RoleSearchSubtree = false,
        ServiceAccountPassword = "string",
        ServiceAccountUsername = "string",
        UserBase = "string",
        UserRoleName = "string",
        UserSearchMatching = "string",
        UserSearchSubtree = false,
    },
    ApplyImmediately = false,
    MaintenanceWindowStartTime = new Aws.Mq.Inputs.BrokerMaintenanceWindowStartTimeArgs
    {
        DayOfWeek = "string",
        TimeOfDay = "string",
        TimeZone = "string",
    },
    PubliclyAccessible = false,
    SecurityGroups = new[]
    {
        "string",
    },
    StorageType = "string",
    SubnetIds = new[]
    {
        "string",
    },
    Tags = 
    {
        { "string", "string" },
    },
    AuthenticationStrategy = "string",
});

    example, err := mq.NewBroker(ctx, "brokerResource", &mq.BrokerArgs{
	EngineType: pulumi.String("string"),
	Users: mq.BrokerUserArray{
		&mq.BrokerUserArgs{
			Password:      pulumi.String("string"),
			Username:      pulumi.String("string"),
			ConsoleAccess: pulumi.Bool(false),
			Groups: pulumi.StringArray{
				pulumi.String("string"),
			},
			ReplicationUser: pulumi.Bool(false),
		},
	},
	HostInstanceType:    pulumi.String("string"),
	EngineVersion:       pulumi.String("string"),
	DataReplicationMode: pulumi.String("string"),
	Logs: &mq.BrokerLogsArgs{
		Audit:   pulumi.Bool(false),
		General: pulumi.Bool(false),
	},
	DataReplicationPrimaryBrokerArn: pulumi.String("string"),
	DeploymentMode:                  pulumi.String("string"),
	EncryptionOptions: &mq.BrokerEncryptionOptionsArgs{
		KmsKeyId:       pulumi.String("string"),
		UseAwsOwnedKey: pulumi.Bool(false),
	},
	Configuration: &mq.BrokerConfigurationArgs{
		Id:       pulumi.String("string"),
		Revision: pulumi.Int(0),
	},
	BrokerName:              pulumi.String("string"),
	AutoMinorVersionUpgrade: pulumi.Bool(false),
	LdapServerMetadata: &mq.BrokerLdapServerMetadataArgs{
		Hosts: pulumi.StringArray{
			pulumi.String("string"),
		},
		RoleBase:               pulumi.String("string"),
		RoleName:               pulumi.String("string"),
		RoleSearchMatching:     pulumi.String("string"),
		RoleSearchSubtree:      pulumi.Bool(false),
		ServiceAccountPassword: pulumi.String("string"),
		ServiceAccountUsername: pulumi.String("string"),
		UserBase:               pulumi.String("string"),
		UserRoleName:           pulumi.String("string"),
		UserSearchMatching:     pulumi.String("string"),
		UserSearchSubtree:      pulumi.Bool(false),
	},
	ApplyImmediately: pulumi.Bool(false),
	MaintenanceWindowStartTime: &mq.BrokerMaintenanceWindowStartTimeArgs{
		DayOfWeek: pulumi.String("string"),
		TimeOfDay: pulumi.String("string"),
		TimeZone:  pulumi.String("string"),
	},
	PubliclyAccessible: pulumi.Bool(false),
	SecurityGroups: pulumi.StringArray{
		pulumi.String("string"),
	},
	StorageType: pulumi.String("string"),
	SubnetIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	AuthenticationStrategy: pulumi.String("string"),
})

    var brokerResource = new Broker("brokerResource", BrokerArgs.builder()
    .engineType("string")
    .users(BrokerUserArgs.builder()
        .password("string")
        .username("string")
        .consoleAccess(false)
        .groups("string")
        .replicationUser(false)
        .build())
    .hostInstanceType("string")
    .engineVersion("string")
    .dataReplicationMode("string")
    .logs(BrokerLogsArgs.builder()
        .audit(false)
        .general(false)
        .build())
    .dataReplicationPrimaryBrokerArn("string")
    .deploymentMode("string")
    .encryptionOptions(BrokerEncryptionOptionsArgs.builder()
        .kmsKeyId("string")
        .useAwsOwnedKey(false)
        .build())
    .configuration(BrokerConfigurationArgs.builder()
        .id("string")
        .revision(0)
        .build())
    .brokerName("string")
    .autoMinorVersionUpgrade(false)
    .ldapServerMetadata(BrokerLdapServerMetadataArgs.builder()
        .hosts("string")
        .roleBase("string")
        .roleName("string")
        .roleSearchMatching("string")
        .roleSearchSubtree(false)
        .serviceAccountPassword("string")
        .serviceAccountUsername("string")
        .userBase("string")
        .userRoleName("string")
        .userSearchMatching("string")
        .userSearchSubtree(false)
        .build())
    .applyImmediately(false)
    .maintenanceWindowStartTime(BrokerMaintenanceWindowStartTimeArgs.builder()
        .dayOfWeek("string")
        .timeOfDay("string")
        .timeZone("string")
        .build())
    .publiclyAccessible(false)
    .securityGroups("string")
    .storageType("string")
    .subnetIds("string")
    .tags(Map.of("string", "string"))
    .authenticationStrategy("string")
    .build());

    broker_resource = aws.mq.Broker("brokerResource",
    engine_type="string",
    users=[{
        "password": "string",
        "username": "string",
        "console_access": False,
        "groups": ["string"],
        "replication_user": False,
    }],
    host_instance_type="string",
    engine_version="string",
    data_replication_mode="string",
    logs={
        "audit": False,
        "general": False,
    },
    data_replication_primary_broker_arn="string",
    deployment_mode="string",
    encryption_options={
        "kms_key_id": "string",
        "use_aws_owned_key": False,
    },
    configuration={
        "id": "string",
        "revision": 0,
    },
    broker_name="string",
    auto_minor_version_upgrade=False,
    ldap_server_metadata={
        "hosts": ["string"],
        "role_base": "string",
        "role_name": "string",
        "role_search_matching": "string",
        "role_search_subtree": False,
        "service_account_password": "string",
        "service_account_username": "string",
        "user_base": "string",
        "user_role_name": "string",
        "user_search_matching": "string",
        "user_search_subtree": False,
    },
    apply_immediately=False,
    maintenance_window_start_time={
        "day_of_week": "string",
        "time_of_day": "string",
        "time_zone": "string",
    },
    publicly_accessible=False,
    security_groups=["string"],
    storage_type="string",
    subnet_ids=["string"],
    tags={
        "string": "string",
    },
    authentication_strategy="string")

    const brokerResource = new aws.mq.Broker("brokerResource", {
    engineType: "string",
    users: [{
        password: "string",
        username: "string",
        consoleAccess: false,
        groups: ["string"],
        replicationUser: false,
    }],
    hostInstanceType: "string",
    engineVersion: "string",
    dataReplicationMode: "string",
    logs: {
        audit: false,
        general: false,
    },
    dataReplicationPrimaryBrokerArn: "string",
    deploymentMode: "string",
    encryptionOptions: {
        kmsKeyId: "string",
        useAwsOwnedKey: false,
    },
    configuration: {
        id: "string",
        revision: 0,
    },
    brokerName: "string",
    autoMinorVersionUpgrade: false,
    ldapServerMetadata: {
        hosts: ["string"],
        roleBase: "string",
        roleName: "string",
        roleSearchMatching: "string",
        roleSearchSubtree: false,
        serviceAccountPassword: "string",
        serviceAccountUsername: "string",
        userBase: "string",
        userRoleName: "string",
        userSearchMatching: "string",
        userSearchSubtree: false,
    },
    applyImmediately: false,
    maintenanceWindowStartTime: {
        dayOfWeek: "string",
        timeOfDay: "string",
        timeZone: "string",
    },
    publiclyAccessible: false,
    securityGroups: ["string"],
    storageType: "string",
    subnetIds: ["string"],
    tags: {
        string: "string",
    },
    authenticationStrategy: "string",
});

    type: aws:mq:Broker
properties:
    applyImmediately: false
    authenticationStrategy: string
    autoMinorVersionUpgrade: false
    brokerName: string
    configuration:
        id: string
        revision: 0
    dataReplicationMode: string
    dataReplicationPrimaryBrokerArn: string
    deploymentMode: string
    encryptionOptions:
        kmsKeyId: string
        useAwsOwnedKey: false
    engineType: string
    engineVersion: string
    hostInstanceType: string
    ldapServerMetadata:
        hosts:
            - string
        roleBase: string
        roleName: string
        roleSearchMatching: string
        roleSearchSubtree: false
        serviceAccountPassword: string
        serviceAccountUsername: string
        userBase: string
        userRoleName: string
        userSearchMatching: string
        userSearchSubtree: false
    logs:
        audit: false
        general: false
    maintenanceWindowStartTime:
        dayOfWeek: string
        timeOfDay: string
        timeZone: string
    publiclyAccessible: false
    securityGroups:
        - string
    storageType: string
    subnetIds:
        - string
    tags:
        string: string
    users:
        - consoleAccess: false
          groups:
            - string
          password: string
          replicationUser: false
          username: string

    Broker Resource Properties

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

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Broker resource accepts the following input properties:

    EngineType string
    Type of broker engine. Valid values are ActiveMQ and RabbitMQ.
    EngineVersion string
    Version of the broker engine. See the AmazonMQ Broker Engine docs for supported versions. For example, 5.17.6.
    HostInstanceType string
    Broker's instance type. For example, mq.t3.micro, mq.m5.large.
    Users List<BrokerUser>

    Configuration block for broker users. For engine_type of RabbitMQ, Amazon MQ does not return broker users preventing this resource from making user updates and drift detection. Detailed below.

    The following arguments are optional:

    ApplyImmediately bool
    Specifies whether any broker modifications are applied immediately, or during the next maintenance window. Default is false.
    AuthenticationStrategy string
    Authentication strategy used to secure the broker. Valid values are simple and ldap. ldap is not supported for engine_type RabbitMQ.
    AutoMinorVersionUpgrade bool
    Whether to automatically upgrade to new minor versions of brokers as Amazon MQ makes releases available.
    BrokerName string
    Name of the broker.
    Configuration BrokerConfiguration
    Configuration block for broker configuration. Applies to engine_type of ActiveMQ and RabbitMQ only. Detailed below.
    DataReplicationMode string
    Defines whether this broker is a part of a data replication pair. Valid values are CRDR and NONE.
    DataReplicationPrimaryBrokerArn string
    The Amazon Resource Name (ARN) of the primary broker that is used to replicate data from in a data replication pair, and is applied to the replica broker. Must be set when data_replication_mode is CRDR.
    DeploymentMode string
    Deployment mode of the broker. Valid values are SINGLE_INSTANCE, ACTIVE_STANDBY_MULTI_AZ, and CLUSTER_MULTI_AZ. Default is SINGLE_INSTANCE.
    EncryptionOptions BrokerEncryptionOptions
    Configuration block containing encryption options. Detailed below.
    LdapServerMetadata BrokerLdapServerMetadata
    Configuration block for the LDAP server used to authenticate and authorize connections to the broker. Not supported for engine_type RabbitMQ. Detailed below. (Currently, AWS may not process changes to LDAP server metadata.)
    Logs BrokerLogs
    Configuration block for the logging configuration of the broker. Detailed below.
    MaintenanceWindowStartTime BrokerMaintenanceWindowStartTime
    Configuration block for the maintenance window start time. Detailed below.
    PubliclyAccessible bool
    Whether to enable connections from applications outside of the VPC that hosts the broker's subnets.
    SecurityGroups List<string>
    List of security group IDs assigned to the broker.
    StorageType string
    Storage type of the broker. For engine_type ActiveMQ, the valid values are efs and ebs, and the AWS-default is efs. For engine_type RabbitMQ, only ebs is supported. When using ebs, only the mq.m5 broker instance type family is supported.
    SubnetIds 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.
    Tags Dictionary<string, string>
    Map of tags to assign to the broker. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    EngineType string
    Type of broker engine. Valid values are ActiveMQ and RabbitMQ.
    EngineVersion string
    Version of the broker engine. See the AmazonMQ Broker Engine docs for supported versions. For example, 5.17.6.
    HostInstanceType string
    Broker's instance type. For example, mq.t3.micro, mq.m5.large.
    Users []BrokerUserArgs

    Configuration block for broker users. For engine_type of RabbitMQ, Amazon MQ does not return broker users preventing this resource from making user updates and drift detection. Detailed below.

    The following arguments are optional:

    ApplyImmediately bool
    Specifies whether any broker modifications are applied immediately, or during the next maintenance window. Default is false.
    AuthenticationStrategy string
    Authentication strategy used to secure the broker. Valid values are simple and ldap. ldap is not supported for engine_type RabbitMQ.
    AutoMinorVersionUpgrade bool
    Whether to automatically upgrade to new minor versions of brokers as Amazon MQ makes releases available.
    BrokerName string
    Name of the broker.
    Configuration BrokerConfigurationArgs
    Configuration block for broker configuration. Applies to engine_type of ActiveMQ and RabbitMQ only. Detailed below.
    DataReplicationMode string
    Defines whether this broker is a part of a data replication pair. Valid values are CRDR and NONE.
    DataReplicationPrimaryBrokerArn string
    The Amazon Resource Name (ARN) of the primary broker that is used to replicate data from in a data replication pair, and is applied to the replica broker. Must be set when data_replication_mode is CRDR.
    DeploymentMode string
    Deployment mode of the broker. Valid values are SINGLE_INSTANCE, ACTIVE_STANDBY_MULTI_AZ, and CLUSTER_MULTI_AZ. Default is SINGLE_INSTANCE.
    EncryptionOptions BrokerEncryptionOptionsArgs
    Configuration block containing encryption options. Detailed below.
    LdapServerMetadata BrokerLdapServerMetadataArgs
    Configuration block for the LDAP server used to authenticate and authorize connections to the broker. Not supported for engine_type RabbitMQ. Detailed below. (Currently, AWS may not process changes to LDAP server metadata.)
    Logs BrokerLogsArgs
    Configuration block for the logging configuration of the broker. Detailed below.
    MaintenanceWindowStartTime BrokerMaintenanceWindowStartTimeArgs
    Configuration block for the maintenance window start time. Detailed below.
    PubliclyAccessible bool
    Whether to enable connections from applications outside of the VPC that hosts the broker's subnets.
    SecurityGroups []string
    List of security group IDs assigned to the broker.
    StorageType string
    Storage type of the broker. For engine_type ActiveMQ, the valid values are efs and ebs, and the AWS-default is efs. For engine_type RabbitMQ, only ebs is supported. When using ebs, only the mq.m5 broker instance type family is supported.
    SubnetIds []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.
    Tags map[string]string
    Map of tags to assign to the broker. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    engineType String
    Type of broker engine. Valid values are ActiveMQ and RabbitMQ.
    engineVersion String
    Version of the broker engine. See the AmazonMQ Broker Engine docs for supported versions. For example, 5.17.6.
    hostInstanceType String
    Broker's instance type. For example, mq.t3.micro, mq.m5.large.
    users List<BrokerUser>

    Configuration block for broker users. For engine_type of RabbitMQ, Amazon MQ does not return broker users preventing this resource from making user updates and drift detection. Detailed below.

    The following arguments are optional:

    applyImmediately Boolean
    Specifies whether any broker modifications are applied immediately, or during the next maintenance window. Default is false.
    authenticationStrategy String
    Authentication strategy used to secure the broker. Valid values are simple and ldap. ldap is not supported for engine_type RabbitMQ.
    autoMinorVersionUpgrade Boolean
    Whether to automatically upgrade to new minor versions of brokers as Amazon MQ makes releases available.
    brokerName String
    Name of the broker.
    configuration BrokerConfiguration
    Configuration block for broker configuration. Applies to engine_type of ActiveMQ and RabbitMQ only. Detailed below.
    dataReplicationMode String
    Defines whether this broker is a part of a data replication pair. Valid values are CRDR and NONE.
    dataReplicationPrimaryBrokerArn String
    The Amazon Resource Name (ARN) of the primary broker that is used to replicate data from in a data replication pair, and is applied to the replica broker. Must be set when data_replication_mode is CRDR.
    deploymentMode String
    Deployment mode of the broker. Valid values are SINGLE_INSTANCE, ACTIVE_STANDBY_MULTI_AZ, and CLUSTER_MULTI_AZ. Default is SINGLE_INSTANCE.
    encryptionOptions BrokerEncryptionOptions
    Configuration block containing encryption options. Detailed below.
    ldapServerMetadata BrokerLdapServerMetadata
    Configuration block for the LDAP server used to authenticate and authorize connections to the broker. Not supported for engine_type RabbitMQ. Detailed below. (Currently, AWS may not process changes to LDAP server metadata.)
    logs BrokerLogs
    Configuration block for the logging configuration of the broker. Detailed below.
    maintenanceWindowStartTime BrokerMaintenanceWindowStartTime
    Configuration block for the maintenance window start time. Detailed below.
    publiclyAccessible Boolean
    Whether to enable connections from applications outside of the VPC that hosts the broker's subnets.
    securityGroups List<String>
    List of security group IDs assigned to the broker.
    storageType String
    Storage type of the broker. For engine_type ActiveMQ, the valid values are efs and ebs, and the AWS-default is efs. For engine_type RabbitMQ, only ebs is supported. When using ebs, only the mq.m5 broker instance type family is supported.
    subnetIds 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.
    tags Map<String,String>
    Map of tags to assign to the broker. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    engineType string
    Type of broker engine. Valid values are ActiveMQ and RabbitMQ.
    engineVersion string
    Version of the broker engine. See the AmazonMQ Broker Engine docs for supported versions. For example, 5.17.6.
    hostInstanceType string
    Broker's instance type. For example, mq.t3.micro, mq.m5.large.
    users BrokerUser[]

    Configuration block for broker users. For engine_type of RabbitMQ, Amazon MQ does not return broker users preventing this resource from making user updates and drift detection. Detailed below.

    The following arguments are optional:

    applyImmediately boolean
    Specifies whether any broker modifications are applied immediately, or during the next maintenance window. Default is false.
    authenticationStrategy string
    Authentication strategy used to secure the broker. Valid values are simple and ldap. ldap is not supported for engine_type RabbitMQ.
    autoMinorVersionUpgrade boolean
    Whether to automatically upgrade to new minor versions of brokers as Amazon MQ makes releases available.
    brokerName string
    Name of the broker.
    configuration BrokerConfiguration
    Configuration block for broker configuration. Applies to engine_type of ActiveMQ and RabbitMQ only. Detailed below.
    dataReplicationMode string
    Defines whether this broker is a part of a data replication pair. Valid values are CRDR and NONE.
    dataReplicationPrimaryBrokerArn string
    The Amazon Resource Name (ARN) of the primary broker that is used to replicate data from in a data replication pair, and is applied to the replica broker. Must be set when data_replication_mode is CRDR.
    deploymentMode string
    Deployment mode of the broker. Valid values are SINGLE_INSTANCE, ACTIVE_STANDBY_MULTI_AZ, and CLUSTER_MULTI_AZ. Default is SINGLE_INSTANCE.
    encryptionOptions BrokerEncryptionOptions
    Configuration block containing encryption options. Detailed below.
    ldapServerMetadata BrokerLdapServerMetadata
    Configuration block for the LDAP server used to authenticate and authorize connections to the broker. Not supported for engine_type RabbitMQ. Detailed below. (Currently, AWS may not process changes to LDAP server metadata.)
    logs BrokerLogs
    Configuration block for the logging configuration of the broker. Detailed below.
    maintenanceWindowStartTime BrokerMaintenanceWindowStartTime
    Configuration block for the maintenance window start time. Detailed below.
    publiclyAccessible boolean
    Whether to enable connections from applications outside of the VPC that hosts the broker's subnets.
    securityGroups string[]
    List of security group IDs assigned to the broker.
    storageType string
    Storage type of the broker. For engine_type ActiveMQ, the valid values are efs and ebs, and the AWS-default is efs. For engine_type RabbitMQ, only ebs is supported. When using ebs, only the mq.m5 broker instance type family is supported.
    subnetIds 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.
    tags {[key: string]: string}
    Map of tags to assign to the broker. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    engine_type str
    Type of broker engine. Valid values are ActiveMQ and RabbitMQ.
    engine_version str
    Version of the broker engine. See the AmazonMQ Broker Engine docs for supported versions. For example, 5.17.6.
    host_instance_type str
    Broker's instance type. For example, mq.t3.micro, mq.m5.large.
    users Sequence[BrokerUserArgs]

    Configuration block for broker users. For engine_type of RabbitMQ, Amazon MQ does not return broker users preventing this resource from making user updates and drift detection. Detailed below.

    The following arguments are optional:

    apply_immediately bool
    Specifies whether any broker modifications are applied immediately, or during the next maintenance window. Default is false.
    authentication_strategy str
    Authentication strategy used to secure the broker. Valid values are simple and ldap. ldap is not supported for engine_type RabbitMQ.
    auto_minor_version_upgrade bool
    Whether to automatically upgrade to new minor versions of brokers as Amazon MQ makes releases available.
    broker_name str
    Name of the broker.
    configuration BrokerConfigurationArgs
    Configuration block for broker configuration. Applies to engine_type of ActiveMQ and RabbitMQ only. Detailed below.
    data_replication_mode str
    Defines whether this broker is a part of a data replication pair. Valid values are CRDR and NONE.
    data_replication_primary_broker_arn str
    The Amazon Resource Name (ARN) of the primary broker that is used to replicate data from in a data replication pair, and is applied to the replica broker. Must be set when data_replication_mode is CRDR.
    deployment_mode str
    Deployment mode of the broker. Valid values are SINGLE_INSTANCE, ACTIVE_STANDBY_MULTI_AZ, and CLUSTER_MULTI_AZ. Default is SINGLE_INSTANCE.
    encryption_options BrokerEncryptionOptionsArgs
    Configuration block containing encryption options. Detailed below.
    ldap_server_metadata BrokerLdapServerMetadataArgs
    Configuration block for the LDAP server used to authenticate and authorize connections to the broker. Not supported for engine_type RabbitMQ. Detailed below. (Currently, AWS may not process changes to LDAP server metadata.)
    logs BrokerLogsArgs
    Configuration block for the logging configuration of the broker. Detailed below.
    maintenance_window_start_time BrokerMaintenanceWindowStartTimeArgs
    Configuration block for the maintenance window start time. Detailed below.
    publicly_accessible bool
    Whether to enable connections from applications outside of the VPC that hosts the broker's subnets.
    security_groups Sequence[str]
    List of security group IDs assigned to the broker.
    storage_type str
    Storage type of the broker. For engine_type ActiveMQ, the valid values are efs and ebs, and the AWS-default is efs. For engine_type RabbitMQ, only ebs is supported. When using ebs, only the mq.m5 broker instance type family is supported.
    subnet_ids Sequence[str]
    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.
    tags Mapping[str, str]
    Map of tags to assign to the broker. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    engineType String
    Type of broker engine. Valid values are ActiveMQ and RabbitMQ.
    engineVersion String
    Version of the broker engine. See the AmazonMQ Broker Engine docs for supported versions. For example, 5.17.6.
    hostInstanceType String
    Broker's instance type. For example, mq.t3.micro, mq.m5.large.
    users List<Property Map>

    Configuration block for broker users. For engine_type of RabbitMQ, Amazon MQ does not return broker users preventing this resource from making user updates and drift detection. Detailed below.

    The following arguments are optional:

    applyImmediately Boolean
    Specifies whether any broker modifications are applied immediately, or during the next maintenance window. Default is false.
    authenticationStrategy String
    Authentication strategy used to secure the broker. Valid values are simple and ldap. ldap is not supported for engine_type RabbitMQ.
    autoMinorVersionUpgrade Boolean
    Whether to automatically upgrade to new minor versions of brokers as Amazon MQ makes releases available.
    brokerName String
    Name of the broker.
    configuration Property Map
    Configuration block for broker configuration. Applies to engine_type of ActiveMQ and RabbitMQ only. Detailed below.
    dataReplicationMode String
    Defines whether this broker is a part of a data replication pair. Valid values are CRDR and NONE.
    dataReplicationPrimaryBrokerArn String
    The Amazon Resource Name (ARN) of the primary broker that is used to replicate data from in a data replication pair, and is applied to the replica broker. Must be set when data_replication_mode is CRDR.
    deploymentMode String
    Deployment mode of the broker. Valid values are SINGLE_INSTANCE, ACTIVE_STANDBY_MULTI_AZ, and CLUSTER_MULTI_AZ. Default is SINGLE_INSTANCE.
    encryptionOptions Property Map
    Configuration block containing encryption options. Detailed below.
    ldapServerMetadata Property Map
    Configuration block for the LDAP server used to authenticate and authorize connections to the broker. Not supported for engine_type RabbitMQ. Detailed below. (Currently, AWS may not process changes to LDAP server metadata.)
    logs Property Map
    Configuration block for the logging configuration of the broker. Detailed below.
    maintenanceWindowStartTime Property Map
    Configuration block for the maintenance window start time. Detailed below.
    publiclyAccessible Boolean
    Whether to enable connections from applications outside of the VPC that hosts the broker's subnets.
    securityGroups List<String>
    List of security group IDs assigned to the broker.
    storageType String
    Storage type of the broker. For engine_type ActiveMQ, the valid values are efs and ebs, and the AWS-default is efs. For engine_type RabbitMQ, only ebs is supported. When using ebs, only the mq.m5 broker instance type family is supported.
    subnetIds 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.
    tags Map<String>
    Map of tags to assign to the broker. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    Outputs

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

    Arn string
    ARN of the broker.
    Id string
    The provider-assigned unique ID for this managed resource.
    Instances List<BrokerInstance>
    List of information about allocated brokers (both active & standby).
    PendingDataReplicationMode string
    (Optional) The data replication mode that will be applied after reboot.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Arn string
    ARN of the broker.
    Id string
    The provider-assigned unique ID for this managed resource.
    Instances []BrokerInstance
    List of information about allocated brokers (both active & standby).
    PendingDataReplicationMode string
    (Optional) The data replication mode that will be applied after reboot.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    ARN of the broker.
    id String
    The provider-assigned unique ID for this managed resource.
    instances List<BrokerInstance>
    List of information about allocated brokers (both active & standby).
    pendingDataReplicationMode String
    (Optional) The data replication mode that will be applied after reboot.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn string
    ARN of the broker.
    id string
    The provider-assigned unique ID for this managed resource.
    instances BrokerInstance[]
    List of information about allocated brokers (both active & standby).
    pendingDataReplicationMode string
    (Optional) The data replication mode that will be applied after reboot.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn str
    ARN of the broker.
    id str
    The provider-assigned unique ID for this managed resource.
    instances Sequence[BrokerInstance]
    List of information about allocated brokers (both active & standby).
    pending_data_replication_mode str
    (Optional) The data replication mode that will be applied after reboot.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    ARN of the broker.
    id String
    The provider-assigned unique ID for this managed resource.
    instances List<Property Map>
    List of information about allocated brokers (both active & standby).
    pendingDataReplicationMode String
    (Optional) The data replication mode that will be applied after reboot.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Look up 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
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        apply_immediately: Optional[bool] = None,
        arn: Optional[str] = None,
        authentication_strategy: Optional[str] = None,
        auto_minor_version_upgrade: Optional[bool] = None,
        broker_name: Optional[str] = None,
        configuration: Optional[BrokerConfigurationArgs] = None,
        data_replication_mode: Optional[str] = None,
        data_replication_primary_broker_arn: Optional[str] = None,
        deployment_mode: Optional[str] = None,
        encryption_options: Optional[BrokerEncryptionOptionsArgs] = None,
        engine_type: Optional[str] = None,
        engine_version: Optional[str] = None,
        host_instance_type: Optional[str] = None,
        instances: Optional[Sequence[BrokerInstanceArgs]] = None,
        ldap_server_metadata: Optional[BrokerLdapServerMetadataArgs] = None,
        logs: Optional[BrokerLogsArgs] = None,
        maintenance_window_start_time: Optional[BrokerMaintenanceWindowStartTimeArgs] = None,
        pending_data_replication_mode: Optional[str] = None,
        publicly_accessible: Optional[bool] = None,
        security_groups: Optional[Sequence[str]] = None,
        storage_type: Optional[str] = None,
        subnet_ids: Optional[Sequence[str]] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None,
        users: Optional[Sequence[BrokerUserArgs]] = None) -> Broker
    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)
    public static Broker get(String name, Output<String> id, BrokerState state, CustomResourceOptions options)
    resources:  _:    type: aws:mq:Broker    get:      id: ${id}
    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.
    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
    ARN of the broker.
    AuthenticationStrategy string
    Authentication strategy used to secure the broker. Valid values are simple and ldap. ldap is not supported for engine_type RabbitMQ.
    AutoMinorVersionUpgrade bool
    Whether to automatically upgrade to new minor versions of brokers as Amazon MQ makes releases available.
    BrokerName string
    Name of the broker.
    Configuration BrokerConfiguration
    Configuration block for broker configuration. Applies to engine_type of ActiveMQ and RabbitMQ only. Detailed below.
    DataReplicationMode string
    Defines whether this broker is a part of a data replication pair. Valid values are CRDR and NONE.
    DataReplicationPrimaryBrokerArn string
    The Amazon Resource Name (ARN) of the primary broker that is used to replicate data from in a data replication pair, and is applied to the replica broker. Must be set when data_replication_mode is CRDR.
    DeploymentMode string
    Deployment mode of the broker. Valid values are SINGLE_INSTANCE, ACTIVE_STANDBY_MULTI_AZ, and CLUSTER_MULTI_AZ. Default is SINGLE_INSTANCE.
    EncryptionOptions BrokerEncryptionOptions
    Configuration block containing encryption options. Detailed below.
    EngineType string
    Type of broker engine. Valid values are ActiveMQ and RabbitMQ.
    EngineVersion string
    Version of the broker engine. See the AmazonMQ Broker Engine docs for supported versions. For example, 5.17.6.
    HostInstanceType string
    Broker's instance type. For example, mq.t3.micro, mq.m5.large.
    Instances List<BrokerInstance>
    List of information about allocated brokers (both active & standby).
    LdapServerMetadata BrokerLdapServerMetadata
    Configuration block for the LDAP server used to authenticate and authorize connections to the broker. Not supported for engine_type RabbitMQ. Detailed below. (Currently, AWS may not process changes to LDAP server metadata.)
    Logs BrokerLogs
    Configuration block for the logging configuration of the broker. Detailed below.
    MaintenanceWindowStartTime BrokerMaintenanceWindowStartTime
    Configuration block for the maintenance window start time. Detailed below.
    PendingDataReplicationMode string
    (Optional) The data replication mode that will be applied after reboot.
    PubliclyAccessible bool
    Whether to enable connections from applications outside of the VPC that hosts the broker's subnets.
    SecurityGroups List<string>
    List of security group IDs assigned to the broker.
    StorageType string
    Storage type of the broker. For engine_type ActiveMQ, the valid values are efs and ebs, and the AWS-default is efs. For engine_type RabbitMQ, only ebs is supported. When using ebs, only the mq.m5 broker instance type family is supported.
    SubnetIds 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.
    Tags Dictionary<string, string>
    Map of tags to assign to the broker. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Users List<BrokerUser>

    Configuration block for broker users. For engine_type of RabbitMQ, Amazon MQ does not return broker users preventing this resource from making user updates and drift detection. Detailed below.

    The following arguments are optional:

    ApplyImmediately bool
    Specifies whether any broker modifications are applied immediately, or during the next maintenance window. Default is false.
    Arn string
    ARN of the broker.
    AuthenticationStrategy string
    Authentication strategy used to secure the broker. Valid values are simple and ldap. ldap is not supported for engine_type RabbitMQ.
    AutoMinorVersionUpgrade bool
    Whether to automatically upgrade to new minor versions of brokers as Amazon MQ makes releases available.
    BrokerName string
    Name of the broker.
    Configuration BrokerConfigurationArgs
    Configuration block for broker configuration. Applies to engine_type of ActiveMQ and RabbitMQ only. Detailed below.
    DataReplicationMode string
    Defines whether this broker is a part of a data replication pair. Valid values are CRDR and NONE.
    DataReplicationPrimaryBrokerArn string
    The Amazon Resource Name (ARN) of the primary broker that is used to replicate data from in a data replication pair, and is applied to the replica broker. Must be set when data_replication_mode is CRDR.
    DeploymentMode string
    Deployment mode of the broker. Valid values are SINGLE_INSTANCE, ACTIVE_STANDBY_MULTI_AZ, and CLUSTER_MULTI_AZ. Default is SINGLE_INSTANCE.
    EncryptionOptions BrokerEncryptionOptionsArgs
    Configuration block containing encryption options. Detailed below.
    EngineType string
    Type of broker engine. Valid values are ActiveMQ and RabbitMQ.
    EngineVersion string
    Version of the broker engine. See the AmazonMQ Broker Engine docs for supported versions. For example, 5.17.6.
    HostInstanceType string
    Broker's instance type. For example, mq.t3.micro, mq.m5.large.
    Instances []BrokerInstanceArgs
    List of information about allocated brokers (both active & standby).
    LdapServerMetadata BrokerLdapServerMetadataArgs
    Configuration block for the LDAP server used to authenticate and authorize connections to the broker. Not supported for engine_type RabbitMQ. Detailed below. (Currently, AWS may not process changes to LDAP server metadata.)
    Logs BrokerLogsArgs
    Configuration block for the logging configuration of the broker. Detailed below.
    MaintenanceWindowStartTime BrokerMaintenanceWindowStartTimeArgs
    Configuration block for the maintenance window start time. Detailed below.
    PendingDataReplicationMode string
    (Optional) The data replication mode that will be applied after reboot.
    PubliclyAccessible bool
    Whether to enable connections from applications outside of the VPC that hosts the broker's subnets.
    SecurityGroups []string
    List of security group IDs assigned to the broker.
    StorageType string
    Storage type of the broker. For engine_type ActiveMQ, the valid values are efs and ebs, and the AWS-default is efs. For engine_type RabbitMQ, only ebs is supported. When using ebs, only the mq.m5 broker instance type family is supported.
    SubnetIds []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.
    Tags map[string]string
    Map of tags to assign to the broker. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Users []BrokerUserArgs

    Configuration block for broker users. For engine_type of RabbitMQ, Amazon MQ does not return broker users preventing this resource from making user updates and drift detection. Detailed below.

    The following arguments are optional:

    applyImmediately Boolean
    Specifies whether any broker modifications are applied immediately, or during the next maintenance window. Default is false.
    arn String
    ARN of the broker.
    authenticationStrategy String
    Authentication strategy used to secure the broker. Valid values are simple and ldap. ldap is not supported for engine_type RabbitMQ.
    autoMinorVersionUpgrade Boolean
    Whether to automatically upgrade to new minor versions of brokers as Amazon MQ makes releases available.
    brokerName String
    Name of the broker.
    configuration BrokerConfiguration
    Configuration block for broker configuration. Applies to engine_type of ActiveMQ and RabbitMQ only. Detailed below.
    dataReplicationMode String
    Defines whether this broker is a part of a data replication pair. Valid values are CRDR and NONE.
    dataReplicationPrimaryBrokerArn String
    The Amazon Resource Name (ARN) of the primary broker that is used to replicate data from in a data replication pair, and is applied to the replica broker. Must be set when data_replication_mode is CRDR.
    deploymentMode String
    Deployment mode of the broker. Valid values are SINGLE_INSTANCE, ACTIVE_STANDBY_MULTI_AZ, and CLUSTER_MULTI_AZ. Default is SINGLE_INSTANCE.
    encryptionOptions BrokerEncryptionOptions
    Configuration block containing encryption options. Detailed below.
    engineType String
    Type of broker engine. Valid values are ActiveMQ and RabbitMQ.
    engineVersion String
    Version of the broker engine. See the AmazonMQ Broker Engine docs for supported versions. For example, 5.17.6.
    hostInstanceType String
    Broker's instance type. For example, mq.t3.micro, mq.m5.large.
    instances List<BrokerInstance>
    List of information about allocated brokers (both active & standby).
    ldapServerMetadata BrokerLdapServerMetadata
    Configuration block for the LDAP server used to authenticate and authorize connections to the broker. Not supported for engine_type RabbitMQ. Detailed below. (Currently, AWS may not process changes to LDAP server metadata.)
    logs BrokerLogs
    Configuration block for the logging configuration of the broker. Detailed below.
    maintenanceWindowStartTime BrokerMaintenanceWindowStartTime
    Configuration block for the maintenance window start time. Detailed below.
    pendingDataReplicationMode String
    (Optional) The data replication mode that will be applied after reboot.
    publiclyAccessible Boolean
    Whether to enable connections from applications outside of the VPC that hosts the broker's subnets.
    securityGroups List<String>
    List of security group IDs assigned to the broker.
    storageType String
    Storage type of the broker. For engine_type ActiveMQ, the valid values are efs and ebs, and the AWS-default is efs. For engine_type RabbitMQ, only ebs is supported. When using ebs, only the mq.m5 broker instance type family is supported.
    subnetIds 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.
    tags Map<String,String>
    Map of tags to assign to the broker. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    users List<BrokerUser>

    Configuration block for broker users. For engine_type of RabbitMQ, Amazon MQ does not return broker users preventing this resource from making user updates and drift detection. Detailed below.

    The following arguments are optional:

    applyImmediately boolean
    Specifies whether any broker modifications are applied immediately, or during the next maintenance window. Default is false.
    arn string
    ARN of the broker.
    authenticationStrategy string
    Authentication strategy used to secure the broker. Valid values are simple and ldap. ldap is not supported for engine_type RabbitMQ.
    autoMinorVersionUpgrade boolean
    Whether to automatically upgrade to new minor versions of brokers as Amazon MQ makes releases available.
    brokerName string
    Name of the broker.
    configuration BrokerConfiguration
    Configuration block for broker configuration. Applies to engine_type of ActiveMQ and RabbitMQ only. Detailed below.
    dataReplicationMode string
    Defines whether this broker is a part of a data replication pair. Valid values are CRDR and NONE.
    dataReplicationPrimaryBrokerArn string
    The Amazon Resource Name (ARN) of the primary broker that is used to replicate data from in a data replication pair, and is applied to the replica broker. Must be set when data_replication_mode is CRDR.
    deploymentMode string
    Deployment mode of the broker. Valid values are SINGLE_INSTANCE, ACTIVE_STANDBY_MULTI_AZ, and CLUSTER_MULTI_AZ. Default is SINGLE_INSTANCE.
    encryptionOptions BrokerEncryptionOptions
    Configuration block containing encryption options. Detailed below.
    engineType string
    Type of broker engine. Valid values are ActiveMQ and RabbitMQ.
    engineVersion string
    Version of the broker engine. See the AmazonMQ Broker Engine docs for supported versions. For example, 5.17.6.
    hostInstanceType string
    Broker's instance type. For example, mq.t3.micro, mq.m5.large.
    instances BrokerInstance[]
    List of information about allocated brokers (both active & standby).
    ldapServerMetadata BrokerLdapServerMetadata
    Configuration block for the LDAP server used to authenticate and authorize connections to the broker. Not supported for engine_type RabbitMQ. Detailed below. (Currently, AWS may not process changes to LDAP server metadata.)
    logs BrokerLogs
    Configuration block for the logging configuration of the broker. Detailed below.
    maintenanceWindowStartTime BrokerMaintenanceWindowStartTime
    Configuration block for the maintenance window start time. Detailed below.
    pendingDataReplicationMode string
    (Optional) The data replication mode that will be applied after reboot.
    publiclyAccessible boolean
    Whether to enable connections from applications outside of the VPC that hosts the broker's subnets.
    securityGroups string[]
    List of security group IDs assigned to the broker.
    storageType string
    Storage type of the broker. For engine_type ActiveMQ, the valid values are efs and ebs, and the AWS-default is efs. For engine_type RabbitMQ, only ebs is supported. When using ebs, only the mq.m5 broker instance type family is supported.
    subnetIds 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.
    tags {[key: string]: string}
    Map of tags to assign to the broker. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    users BrokerUser[]

    Configuration block for broker users. For engine_type of RabbitMQ, Amazon MQ does not return broker users preventing this resource from making user updates and drift detection. Detailed below.

    The following arguments are optional:

    apply_immediately bool
    Specifies whether any broker modifications are applied immediately, or during the next maintenance window. Default is false.
    arn str
    ARN of the broker.
    authentication_strategy str
    Authentication strategy used to secure the broker. Valid values are simple and ldap. ldap is not supported for engine_type RabbitMQ.
    auto_minor_version_upgrade bool
    Whether to automatically upgrade to new minor versions of brokers as Amazon MQ makes releases available.
    broker_name str
    Name of the broker.
    configuration BrokerConfigurationArgs
    Configuration block for broker configuration. Applies to engine_type of ActiveMQ and RabbitMQ only. Detailed below.
    data_replication_mode str
    Defines whether this broker is a part of a data replication pair. Valid values are CRDR and NONE.
    data_replication_primary_broker_arn str
    The Amazon Resource Name (ARN) of the primary broker that is used to replicate data from in a data replication pair, and is applied to the replica broker. Must be set when data_replication_mode is CRDR.
    deployment_mode str
    Deployment mode of the broker. Valid values are SINGLE_INSTANCE, ACTIVE_STANDBY_MULTI_AZ, and CLUSTER_MULTI_AZ. Default is SINGLE_INSTANCE.
    encryption_options BrokerEncryptionOptionsArgs
    Configuration block containing encryption options. Detailed below.
    engine_type str
    Type of broker engine. Valid values are ActiveMQ and RabbitMQ.
    engine_version str
    Version of the broker engine. See the AmazonMQ Broker Engine docs for supported versions. For example, 5.17.6.
    host_instance_type str
    Broker's instance type. For example, mq.t3.micro, mq.m5.large.
    instances Sequence[BrokerInstanceArgs]
    List of information about allocated brokers (both active & standby).
    ldap_server_metadata BrokerLdapServerMetadataArgs
    Configuration block for the LDAP server used to authenticate and authorize connections to the broker. Not supported for engine_type RabbitMQ. Detailed below. (Currently, AWS may not process changes to LDAP server metadata.)
    logs BrokerLogsArgs
    Configuration block for the logging configuration of the broker. Detailed below.
    maintenance_window_start_time BrokerMaintenanceWindowStartTimeArgs
    Configuration block for the maintenance window start time. Detailed below.
    pending_data_replication_mode str
    (Optional) The data replication mode that will be applied after reboot.
    publicly_accessible bool
    Whether to enable connections from applications outside of the VPC that hosts the broker's subnets.
    security_groups Sequence[str]
    List of security group IDs assigned to the broker.
    storage_type str
    Storage type of the broker. For engine_type ActiveMQ, the valid values are efs and ebs, and the AWS-default is efs. For engine_type RabbitMQ, only ebs is supported. When using ebs, only the mq.m5 broker instance type family is supported.
    subnet_ids Sequence[str]
    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.
    tags Mapping[str, str]
    Map of tags to assign to the broker. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    users Sequence[BrokerUserArgs]

    Configuration block for broker users. For engine_type of RabbitMQ, Amazon MQ does not return broker users preventing this resource from making user updates and drift detection. Detailed below.

    The following arguments are optional:

    applyImmediately Boolean
    Specifies whether any broker modifications are applied immediately, or during the next maintenance window. Default is false.
    arn String
    ARN of the broker.
    authenticationStrategy String
    Authentication strategy used to secure the broker. Valid values are simple and ldap. ldap is not supported for engine_type RabbitMQ.
    autoMinorVersionUpgrade Boolean
    Whether to automatically upgrade to new minor versions of brokers as Amazon MQ makes releases available.
    brokerName String
    Name of the broker.
    configuration Property Map
    Configuration block for broker configuration. Applies to engine_type of ActiveMQ and RabbitMQ only. Detailed below.
    dataReplicationMode String
    Defines whether this broker is a part of a data replication pair. Valid values are CRDR and NONE.
    dataReplicationPrimaryBrokerArn String
    The Amazon Resource Name (ARN) of the primary broker that is used to replicate data from in a data replication pair, and is applied to the replica broker. Must be set when data_replication_mode is CRDR.
    deploymentMode String
    Deployment mode of the broker. Valid values are SINGLE_INSTANCE, ACTIVE_STANDBY_MULTI_AZ, and CLUSTER_MULTI_AZ. Default is SINGLE_INSTANCE.
    encryptionOptions Property Map
    Configuration block containing encryption options. Detailed below.
    engineType String
    Type of broker engine. Valid values are ActiveMQ and RabbitMQ.
    engineVersion String
    Version of the broker engine. See the AmazonMQ Broker Engine docs for supported versions. For example, 5.17.6.
    hostInstanceType String
    Broker's instance type. For example, mq.t3.micro, mq.m5.large.
    instances List<Property Map>
    List of information about allocated brokers (both active & standby).
    ldapServerMetadata Property Map
    Configuration block for the LDAP server used to authenticate and authorize connections to the broker. Not supported for engine_type RabbitMQ. Detailed below. (Currently, AWS may not process changes to LDAP server metadata.)
    logs Property Map
    Configuration block for the logging configuration of the broker. Detailed below.
    maintenanceWindowStartTime Property Map
    Configuration block for the maintenance window start time. Detailed below.
    pendingDataReplicationMode String
    (Optional) The data replication mode that will be applied after reboot.
    publiclyAccessible Boolean
    Whether to enable connections from applications outside of the VPC that hosts the broker's subnets.
    securityGroups List<String>
    List of security group IDs assigned to the broker.
    storageType String
    Storage type of the broker. For engine_type ActiveMQ, the valid values are efs and ebs, and the AWS-default is efs. For engine_type RabbitMQ, only ebs is supported. When using ebs, only the mq.m5 broker instance type family is supported.
    subnetIds 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.
    tags Map<String>
    Map of tags to assign to the broker. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    users List<Property Map>

    Configuration block for broker users. For engine_type of RabbitMQ, Amazon MQ does not return broker users preventing this resource from making user updates and drift detection. Detailed below.

    The following arguments are optional:

    Supporting Types

    BrokerConfiguration, BrokerConfigurationArgs

    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 Integer
    Revision of the Configuration.
    id string
    The Configuration ID.
    revision number
    Revision of the Configuration.
    id str
    The Configuration ID.
    revision int
    Revision of the Configuration.
    id String
    The Configuration ID.
    revision Number
    Revision of the Configuration.

    BrokerEncryptionOptions, BrokerEncryptionOptionsArgs

    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
    Whether to enable an AWS-owned KMS CMK that is not in your account. Defaults to true. Setting to false without configuring kms_key_id will create an AWS-managed 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
    Whether to enable an AWS-owned KMS CMK that is not in your account. Defaults to true. Setting to false without configuring kms_key_id will create an AWS-managed 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
    Whether to enable an AWS-owned KMS CMK that is not in your account. Defaults to true. Setting to false without configuring kms_key_id will create an AWS-managed 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
    Whether to enable an AWS-owned KMS CMK that is not in your account. Defaults to true. Setting to false without configuring kms_key_id will create an AWS-managed 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.
    use_aws_owned_key bool
    Whether to enable an AWS-owned KMS CMK that is not in your account. Defaults to true. Setting to false without configuring kms_key_id will create an AWS-managed 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
    Whether to enable an AWS-owned KMS CMK that is not in your account. Defaults to true. Setting to false without configuring kms_key_id will create an AWS-managed CMK aliased to aws/mq in your account.

    BrokerInstance, BrokerInstanceArgs

    ConsoleUrl string
    The URL of the ActiveMQ Web Console or the RabbitMQ Management UI depending on engine_type.
    Endpoints List<string>
    Broker's wire-level protocol endpoints in the following order & format referenceable e.g., as instances.0.endpoints.0 (SSL):

    • For ActiveMQ:
    • 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
    • For RabbitMQ:
    • amqps://broker-id.mq.us-west-2.amazonaws.com:5671
    IpAddress string
    IP Address of the broker.
    ConsoleUrl string
    The URL of the ActiveMQ Web Console or the RabbitMQ Management UI depending on engine_type.
    Endpoints []string
    Broker's wire-level protocol endpoints in the following order & format referenceable e.g., as instances.0.endpoints.0 (SSL):

    • For ActiveMQ:
    • 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
    • For RabbitMQ:
    • amqps://broker-id.mq.us-west-2.amazonaws.com:5671
    IpAddress string
    IP Address of the broker.
    consoleUrl String
    The URL of the ActiveMQ Web Console or the RabbitMQ Management UI depending on engine_type.
    endpoints List<String>
    Broker's wire-level protocol endpoints in the following order & format referenceable e.g., as instances.0.endpoints.0 (SSL):

    • For ActiveMQ:
    • 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
    • For RabbitMQ:
    • amqps://broker-id.mq.us-west-2.amazonaws.com:5671
    ipAddress String
    IP Address of the broker.
    consoleUrl string
    The URL of the ActiveMQ Web Console or the RabbitMQ Management UI depending on engine_type.
    endpoints string[]
    Broker's wire-level protocol endpoints in the following order & format referenceable e.g., as instances.0.endpoints.0 (SSL):

    • For ActiveMQ:
    • 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
    • For RabbitMQ:
    • amqps://broker-id.mq.us-west-2.amazonaws.com:5671
    ipAddress string
    IP Address of the broker.
    console_url str
    The URL of the ActiveMQ Web Console or the RabbitMQ Management UI depending on engine_type.
    endpoints Sequence[str]
    Broker's wire-level protocol endpoints in the following order & format referenceable e.g., as instances.0.endpoints.0 (SSL):

    • For ActiveMQ:
    • 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
    • For RabbitMQ:
    • amqps://broker-id.mq.us-west-2.amazonaws.com:5671
    ip_address str
    IP Address of the broker.
    consoleUrl String
    The URL of the ActiveMQ Web Console or the RabbitMQ Management UI depending on engine_type.
    endpoints List<String>
    Broker's wire-level protocol endpoints in the following order & format referenceable e.g., as instances.0.endpoints.0 (SSL):

    • For ActiveMQ:
    • 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
    • For RabbitMQ:
    • amqps://broker-id.mq.us-west-2.amazonaws.com:5671
    ipAddress String
    IP Address of the broker.

    BrokerLdapServerMetadata, BrokerLdapServerMetadataArgs

    Hosts List<string>
    List of a fully qualified domain name of the LDAP server and an optional failover server.
    RoleBase string
    Fully qualified name of the directory to search for a user’s groups.
    RoleName string
    Specifies the LDAP attribute that identifies the group name attribute in the object returned from the group membership query.
    RoleSearchMatching string
    Search criteria for groups.
    RoleSearchSubtree bool
    Whether the directory search scope is the entire sub-tree.
    ServiceAccountPassword string
    Service account password.
    ServiceAccountUsername string
    Service account username.
    UserBase string
    Fully qualified name of the directory where you want to search for users.
    UserRoleName string
    Specifies the name of the LDAP attribute for the user group membership.
    UserSearchMatching string
    Search criteria for users.
    UserSearchSubtree bool
    Whether the directory search scope is the entire sub-tree.
    Hosts []string
    List of a fully qualified domain name of the LDAP server and an optional failover server.
    RoleBase string
    Fully qualified name of the directory to search for a user’s groups.
    RoleName string
    Specifies the LDAP attribute that identifies the group name attribute in the object returned from the group membership query.
    RoleSearchMatching string
    Search criteria for groups.
    RoleSearchSubtree bool
    Whether the directory search scope is the entire sub-tree.
    ServiceAccountPassword string
    Service account password.
    ServiceAccountUsername string
    Service account username.
    UserBase string
    Fully qualified name of the directory where you want to search for users.
    UserRoleName string
    Specifies the name of the LDAP attribute for the user group membership.
    UserSearchMatching string
    Search criteria for users.
    UserSearchSubtree bool
    Whether the directory search scope is the entire sub-tree.
    hosts List<String>
    List of a fully qualified domain name of the LDAP server and an optional failover server.
    roleBase String
    Fully qualified name of the directory to search for a user’s groups.
    roleName String
    Specifies the LDAP attribute that identifies the group name attribute in the object returned from the group membership query.
    roleSearchMatching String
    Search criteria for groups.
    roleSearchSubtree Boolean
    Whether the directory search scope is the entire sub-tree.
    serviceAccountPassword String
    Service account password.
    serviceAccountUsername String
    Service account username.
    userBase String
    Fully qualified name of the directory where you want to search for users.
    userRoleName String
    Specifies the name of the LDAP attribute for the user group membership.
    userSearchMatching String
    Search criteria for users.
    userSearchSubtree Boolean
    Whether the directory search scope is the entire sub-tree.
    hosts string[]
    List of a fully qualified domain name of the LDAP server and an optional failover server.
    roleBase string
    Fully qualified name of the directory to search for a user’s groups.
    roleName string
    Specifies the LDAP attribute that identifies the group name attribute in the object returned from the group membership query.
    roleSearchMatching string
    Search criteria for groups.
    roleSearchSubtree boolean
    Whether the directory search scope is the entire sub-tree.
    serviceAccountPassword string
    Service account password.
    serviceAccountUsername string
    Service account username.
    userBase string
    Fully qualified name of the directory where you want to search for users.
    userRoleName string
    Specifies the name of the LDAP attribute for the user group membership.
    userSearchMatching string
    Search criteria for users.
    userSearchSubtree boolean
    Whether the directory search scope is the entire sub-tree.
    hosts Sequence[str]
    List of a fully qualified domain name of the LDAP server and an optional failover server.
    role_base str
    Fully qualified name of the directory to search for a user’s groups.
    role_name str
    Specifies the LDAP attribute that identifies the group name attribute in the object returned from the group membership query.
    role_search_matching str
    Search criteria for groups.
    role_search_subtree bool
    Whether the directory search scope is the entire sub-tree.
    service_account_password str
    Service account password.
    service_account_username str
    Service account username.
    user_base str
    Fully qualified name of the directory where you want to search for users.
    user_role_name str
    Specifies the name of the LDAP attribute for the user group membership.
    user_search_matching str
    Search criteria for users.
    user_search_subtree bool
    Whether the directory search scope is the entire sub-tree.
    hosts List<String>
    List of a fully qualified domain name of the LDAP server and an optional failover server.
    roleBase String
    Fully qualified name of the directory to search for a user’s groups.
    roleName String
    Specifies the LDAP attribute that identifies the group name attribute in the object returned from the group membership query.
    roleSearchMatching String
    Search criteria for groups.
    roleSearchSubtree Boolean
    Whether the directory search scope is the entire sub-tree.
    serviceAccountPassword String
    Service account password.
    serviceAccountUsername String
    Service account username.
    userBase String
    Fully qualified name of the directory where you want to search for users.
    userRoleName String
    Specifies the name of the LDAP attribute for the user group membership.
    userSearchMatching String
    Search criteria for users.
    userSearchSubtree Boolean
    Whether the directory search scope is the entire sub-tree.

    BrokerLogs, BrokerLogsArgs

    Audit bool
    Enables audit logging. Auditing is only possible for engine_type of ActiveMQ. 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. Auditing is only possible for engine_type of ActiveMQ. 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. Auditing is only possible for engine_type of ActiveMQ. 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 boolean
    Enables audit logging. Auditing is only possible for engine_type of ActiveMQ. 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. Auditing is only possible for engine_type of ActiveMQ. 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. Auditing is only possible for engine_type of ActiveMQ. 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.

    BrokerMaintenanceWindowStartTime, BrokerMaintenanceWindowStartTimeArgs

    DayOfWeek string
    Day of the week, e.g., MONDAY, TUESDAY, or WEDNESDAY.
    TimeOfDay string
    Time, in 24-hour format, e.g., 02:00.
    TimeZone string
    Time zone in either the Country/City format or the UTC offset format, e.g., CET.
    DayOfWeek string
    Day of the week, e.g., MONDAY, TUESDAY, or WEDNESDAY.
    TimeOfDay string
    Time, in 24-hour format, e.g., 02:00.
    TimeZone string
    Time zone in either the Country/City format or the UTC offset format, e.g., CET.
    dayOfWeek String
    Day of the week, e.g., MONDAY, TUESDAY, or WEDNESDAY.
    timeOfDay String
    Time, in 24-hour format, e.g., 02:00.
    timeZone String
    Time zone in either the Country/City format or the UTC offset format, e.g., CET.
    dayOfWeek string
    Day of the week, e.g., MONDAY, TUESDAY, or WEDNESDAY.
    timeOfDay string
    Time, in 24-hour format, e.g., 02:00.
    timeZone string
    Time zone in either the Country/City format or the UTC offset format, e.g., CET.
    day_of_week str
    Day of the week, e.g., MONDAY, TUESDAY, or WEDNESDAY.
    time_of_day str
    Time, in 24-hour format, e.g., 02:00.
    time_zone str
    Time zone in either the Country/City format or the UTC offset format, e.g., CET.
    dayOfWeek String
    Day of the week, e.g., MONDAY, TUESDAY, or WEDNESDAY.
    timeOfDay String
    Time, in 24-hour format, e.g., 02:00.
    timeZone String
    Time zone in either the Country/City format or the UTC offset format, e.g., CET.

    BrokerUser, BrokerUserArgs

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

    Username of the user.

    NOTE: AWS currently does not support updating RabbitMQ users. Updates to users can only be in the RabbitMQ UI.

    ConsoleAccess bool
    Whether to enable access to the ActiveMQ Web Console for the user. Applies to engine_type of ActiveMQ only.
    Groups List<string>
    List of groups (20 maximum) to which the ActiveMQ user belongs. Applies to engine_type of ActiveMQ only.
    ReplicationUser bool
    Whether to set set replication user. Defaults to false.
    Password string
    Password of the user. It must be 12 to 250 characters long, at least 4 unique characters, and must not contain commas.
    Username string

    Username of the user.

    NOTE: AWS currently does not support updating RabbitMQ users. Updates to users can only be in the RabbitMQ UI.

    ConsoleAccess bool
    Whether to enable access to the ActiveMQ Web Console for the user. Applies to engine_type of ActiveMQ only.
    Groups []string
    List of groups (20 maximum) to which the ActiveMQ user belongs. Applies to engine_type of ActiveMQ only.
    ReplicationUser bool
    Whether to set set replication user. Defaults to false.
    password String
    Password of the user. It must be 12 to 250 characters long, at least 4 unique characters, and must not contain commas.
    username String

    Username of the user.

    NOTE: AWS currently does not support updating RabbitMQ users. Updates to users can only be in the RabbitMQ UI.

    consoleAccess Boolean
    Whether to enable access to the ActiveMQ Web Console for the user. Applies to engine_type of ActiveMQ only.
    groups List<String>
    List of groups (20 maximum) to which the ActiveMQ user belongs. Applies to engine_type of ActiveMQ only.
    replicationUser Boolean
    Whether to set set replication user. Defaults to false.
    password string
    Password of the user. It must be 12 to 250 characters long, at least 4 unique characters, and must not contain commas.
    username string

    Username of the user.

    NOTE: AWS currently does not support updating RabbitMQ users. Updates to users can only be in the RabbitMQ UI.

    consoleAccess boolean
    Whether to enable access to the ActiveMQ Web Console for the user. Applies to engine_type of ActiveMQ only.
    groups string[]
    List of groups (20 maximum) to which the ActiveMQ user belongs. Applies to engine_type of ActiveMQ only.
    replicationUser boolean
    Whether to set set replication user. Defaults to false.
    password str
    Password of the user. It must be 12 to 250 characters long, at least 4 unique characters, and must not contain commas.
    username str

    Username of the user.

    NOTE: AWS currently does not support updating RabbitMQ users. Updates to users can only be in the RabbitMQ UI.

    console_access bool
    Whether to enable access to the ActiveMQ Web Console for the user. Applies to engine_type of ActiveMQ only.
    groups Sequence[str]
    List of groups (20 maximum) to which the ActiveMQ user belongs. Applies to engine_type of ActiveMQ only.
    replication_user bool
    Whether to set set replication user. Defaults to false.
    password String
    Password of the user. It must be 12 to 250 characters long, at least 4 unique characters, and must not contain commas.
    username String

    Username of the user.

    NOTE: AWS currently does not support updating RabbitMQ users. Updates to users can only be in the RabbitMQ UI.

    consoleAccess Boolean
    Whether to enable access to the ActiveMQ Web Console for the user. Applies to engine_type of ActiveMQ only.
    groups List<String>
    List of groups (20 maximum) to which the ActiveMQ user belongs. Applies to engine_type of ActiveMQ only.
    replicationUser Boolean
    Whether to set set replication user. Defaults to false.

    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

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo
    AWS v6.80.0 published on Tuesday, May 6, 2025 by Pulumi
    pulumi/pulumi-aws