AWS Cloud Control v1.36.0, Oct 3 25

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.36.0 published on Friday, Oct 3, 2025 by Pulumi

pulumi/pulumi-aws-native

aws-native.amazonmq.Broker

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.36.0 published on Friday, Oct 3, 2025 by Pulumi

pulumi/pulumi-aws-native

Example Usage

Example

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AwsNative = Pulumi.AwsNative;

return await Deployment.RunAsync(() => 
{
    var basicBroker = new AwsNative.AmazonMq.Broker("basicBroker", new()
    {
        AutoMinorVersionUpgrade = false,
        BrokerName = "MyBasicActiveBroker",
        DeploymentMode = AwsNative.AmazonMq.BrokerDeploymentMode.SingleInstance,
        EngineType = "ActiveMQ",
        EngineVersion = "5.15.0",
        HostInstanceType = "mq.t2.micro",
        PubliclyAccessible = true,
        Users = new[]
        {
            new AwsNative.AmazonMq.Inputs.BrokerUserArgs
            {
                ConsoleAccess = true,
                Groups = new[]
                {
                    "MyGroup",
                },
                Password = "AmazonMqPassword",
                Username = "AmazonMqUsername",
            },
        },
    });

});

package main

import (
	"github.com/pulumi/pulumi-aws-native/sdk/go/aws/amazonmq"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := amazonmq.NewBroker(ctx, "basicBroker", &amazonmq.BrokerArgs{
			AutoMinorVersionUpgrade: pulumi.Bool(false),
			BrokerName:              pulumi.String("MyBasicActiveBroker"),
			DeploymentMode:          pulumi.String(amazonmq.BrokerDeploymentModeSingleInstance),
			EngineType:              pulumi.String("ActiveMQ"),
			EngineVersion:           pulumi.String("5.15.0"),
			HostInstanceType:        pulumi.String("mq.t2.micro"),
			PubliclyAccessible:      pulumi.Bool(true),
			Users: amazonmq.BrokerUserArray{
				&amazonmq.BrokerUserArgs{
					ConsoleAccess: pulumi.Bool(true),
					Groups: pulumi.StringArray{
						pulumi.String("MyGroup"),
					},
					Password: pulumi.String("AmazonMqPassword"),
					Username: pulumi.String("AmazonMqUsername"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

Example coming soon!

import * as pulumi from "@pulumi/pulumi";
import * as aws_native from "@pulumi/aws-native";

const basicBroker = new aws_native.amazonmq.Broker("basicBroker", {
    autoMinorVersionUpgrade: false,
    brokerName: "MyBasicActiveBroker",
    deploymentMode: aws_native.amazonmq.BrokerDeploymentMode.SingleInstance,
    engineType: "ActiveMQ",
    engineVersion: "5.15.0",
    hostInstanceType: "mq.t2.micro",
    publiclyAccessible: true,
    users: [{
        consoleAccess: true,
        groups: ["MyGroup"],
        password: "AmazonMqPassword",
        username: "AmazonMqUsername",
    }],
});

import pulumi
import pulumi_aws_native as aws_native

basic_broker = aws_native.amazonmq.Broker("basicBroker",
    auto_minor_version_upgrade=False,
    broker_name="MyBasicActiveBroker",
    deployment_mode=aws_native.amazonmq.BrokerDeploymentMode.SINGLE_INSTANCE,
    engine_type="ActiveMQ",
    engine_version="5.15.0",
    host_instance_type="mq.t2.micro",
    publicly_accessible=True,
    users=[{
        "console_access": True,
        "groups": ["MyGroup"],
        "password": "AmazonMqPassword",
        "username": "AmazonMqUsername",
    }])

Example coming soon!

Example

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AwsNative = Pulumi.AwsNative;

return await Deployment.RunAsync(() => 
{
    var basicBroker = new AwsNative.AmazonMq.Broker("basicBroker", new()
    {
        AutoMinorVersionUpgrade = false,
        BrokerName = "MyBasicRabbitBroker",
        DeploymentMode = AwsNative.AmazonMq.BrokerDeploymentMode.SingleInstance,
        EngineType = "RabbitMQ",
        EngineVersion = "3.8.6",
        HostInstanceType = "mq.t3.micro",
        PubliclyAccessible = true,
        Users = new[]
        {
            new AwsNative.AmazonMq.Inputs.BrokerUserArgs
            {
                Password = "AmazonMqPassword",
                Username = "AmazonMqUsername",
            },
        },
    });

});

package main

import (
	"github.com/pulumi/pulumi-aws-native/sdk/go/aws/amazonmq"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := amazonmq.NewBroker(ctx, "basicBroker", &amazonmq.BrokerArgs{
			AutoMinorVersionUpgrade: pulumi.Bool(false),
			BrokerName:              pulumi.String("MyBasicRabbitBroker"),
			DeploymentMode:          pulumi.String(amazonmq.BrokerDeploymentModeSingleInstance),
			EngineType:              pulumi.String("RabbitMQ"),
			EngineVersion:           pulumi.String("3.8.6"),
			HostInstanceType:        pulumi.String("mq.t3.micro"),
			PubliclyAccessible:      pulumi.Bool(true),
			Users: amazonmq.BrokerUserArray{
				&amazonmq.BrokerUserArgs{
					Password: pulumi.String("AmazonMqPassword"),
					Username: pulumi.String("AmazonMqUsername"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

Example coming soon!

import * as pulumi from "@pulumi/pulumi";
import * as aws_native from "@pulumi/aws-native";

const basicBroker = new aws_native.amazonmq.Broker("basicBroker", {
    autoMinorVersionUpgrade: false,
    brokerName: "MyBasicRabbitBroker",
    deploymentMode: aws_native.amazonmq.BrokerDeploymentMode.SingleInstance,
    engineType: "RabbitMQ",
    engineVersion: "3.8.6",
    hostInstanceType: "mq.t3.micro",
    publiclyAccessible: true,
    users: [{
        password: "AmazonMqPassword",
        username: "AmazonMqUsername",
    }],
});

import pulumi
import pulumi_aws_native as aws_native

basic_broker = aws_native.amazonmq.Broker("basicBroker",
    auto_minor_version_upgrade=False,
    broker_name="MyBasicRabbitBroker",
    deployment_mode=aws_native.amazonmq.BrokerDeploymentMode.SINGLE_INSTANCE,
    engine_type="RabbitMQ",
    engine_version="3.8.6",
    host_instance_type="mq.t3.micro",
    publicly_accessible=True,
    users=[{
        "password": "AmazonMqPassword",
        "username": "AmazonMqUsername",
    }])

Example coming soon!

Example

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AwsNative = Pulumi.AwsNative;

return await Deployment.RunAsync(() => 
{
    var basicBroker = new AwsNative.AmazonMq.Broker("basicBroker", new()
    {
        AutoMinorVersionUpgrade = false,
        BrokerName = "MyBasicActiveBroker",
        DeploymentMode = AwsNative.AmazonMq.BrokerDeploymentMode.SingleInstance,
        EngineType = "ActiveMQ",
        EngineVersion = "5.15.0",
        HostInstanceType = "mq.t2.micro",
        PubliclyAccessible = true,
        Users = new[]
        {
            new AwsNative.AmazonMq.Inputs.BrokerUserArgs
            {
                ConsoleAccess = true,
                Groups = new[]
                {
                    "MyGroup",
                },
                Password = "AmazonMqPassword",
                Username = "AmazonMqUsername",
            },
        },
    });

});

package main

import (
	"github.com/pulumi/pulumi-aws-native/sdk/go/aws/amazonmq"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := amazonmq.NewBroker(ctx, "basicBroker", &amazonmq.BrokerArgs{
			AutoMinorVersionUpgrade: pulumi.Bool(false),
			BrokerName:              pulumi.String("MyBasicActiveBroker"),
			DeploymentMode:          pulumi.String(amazonmq.BrokerDeploymentModeSingleInstance),
			EngineType:              pulumi.String("ActiveMQ"),
			EngineVersion:           pulumi.String("5.15.0"),
			HostInstanceType:        pulumi.String("mq.t2.micro"),
			PubliclyAccessible:      pulumi.Bool(true),
			Users: amazonmq.BrokerUserArray{
				&amazonmq.BrokerUserArgs{
					ConsoleAccess: pulumi.Bool(true),
					Groups: pulumi.StringArray{
						pulumi.String("MyGroup"),
					},
					Password: pulumi.String("AmazonMqPassword"),
					Username: pulumi.String("AmazonMqUsername"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

Example coming soon!

import * as pulumi from "@pulumi/pulumi";
import * as aws_native from "@pulumi/aws-native";

const basicBroker = new aws_native.amazonmq.Broker("basicBroker", {
    autoMinorVersionUpgrade: false,
    brokerName: "MyBasicActiveBroker",
    deploymentMode: aws_native.amazonmq.BrokerDeploymentMode.SingleInstance,
    engineType: "ActiveMQ",
    engineVersion: "5.15.0",
    hostInstanceType: "mq.t2.micro",
    publiclyAccessible: true,
    users: [{
        consoleAccess: true,
        groups: ["MyGroup"],
        password: "AmazonMqPassword",
        username: "AmazonMqUsername",
    }],
});

import pulumi
import pulumi_aws_native as aws_native

basic_broker = aws_native.amazonmq.Broker("basicBroker",
    auto_minor_version_upgrade=False,
    broker_name="MyBasicActiveBroker",
    deployment_mode=aws_native.amazonmq.BrokerDeploymentMode.SINGLE_INSTANCE,
    engine_type="ActiveMQ",
    engine_version="5.15.0",
    host_instance_type="mq.t2.micro",
    publicly_accessible=True,
    users=[{
        "console_access": True,
        "groups": ["MyGroup"],
        "password": "AmazonMqPassword",
        "username": "AmazonMqUsername",
    }])

Example coming soon!

Example

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AwsNative = Pulumi.AwsNative;

return await Deployment.RunAsync(() => 
{
    var basicBroker = new AwsNative.AmazonMq.Broker("basicBroker", new()
    {
        AutoMinorVersionUpgrade = false,
        BrokerName = "MyBasicRabbitBroker",
        DeploymentMode = AwsNative.AmazonMq.BrokerDeploymentMode.SingleInstance,
        EngineType = "RabbitMQ",
        EngineVersion = "3.8.6",
        HostInstanceType = "mq.t3.micro",
        PubliclyAccessible = true,
        Users = new[]
        {
            new AwsNative.AmazonMq.Inputs.BrokerUserArgs
            {
                Password = "AmazonMqPassword",
                Username = "AmazonMqUsername",
            },
        },
    });

});

package main

import (
	"github.com/pulumi/pulumi-aws-native/sdk/go/aws/amazonmq"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := amazonmq.NewBroker(ctx, "basicBroker", &amazonmq.BrokerArgs{
			AutoMinorVersionUpgrade: pulumi.Bool(false),
			BrokerName:              pulumi.String("MyBasicRabbitBroker"),
			DeploymentMode:          pulumi.String(amazonmq.BrokerDeploymentModeSingleInstance),
			EngineType:              pulumi.String("RabbitMQ"),
			EngineVersion:           pulumi.String("3.8.6"),
			HostInstanceType:        pulumi.String("mq.t3.micro"),
			PubliclyAccessible:      pulumi.Bool(true),
			Users: amazonmq.BrokerUserArray{
				&amazonmq.BrokerUserArgs{
					Password: pulumi.String("AmazonMqPassword"),
					Username: pulumi.String("AmazonMqUsername"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

Example coming soon!

import * as pulumi from "@pulumi/pulumi";
import * as aws_native from "@pulumi/aws-native";

const basicBroker = new aws_native.amazonmq.Broker("basicBroker", {
    autoMinorVersionUpgrade: false,
    brokerName: "MyBasicRabbitBroker",
    deploymentMode: aws_native.amazonmq.BrokerDeploymentMode.SingleInstance,
    engineType: "RabbitMQ",
    engineVersion: "3.8.6",
    hostInstanceType: "mq.t3.micro",
    publiclyAccessible: true,
    users: [{
        password: "AmazonMqPassword",
        username: "AmazonMqUsername",
    }],
});

import pulumi
import pulumi_aws_native as aws_native

basic_broker = aws_native.amazonmq.Broker("basicBroker",
    auto_minor_version_upgrade=False,
    broker_name="MyBasicRabbitBroker",
    deployment_mode=aws_native.amazonmq.BrokerDeploymentMode.SINGLE_INSTANCE,
    engine_type="RabbitMQ",
    engine_version="3.8.6",
    host_instance_type="mq.t3.micro",
    publicly_accessible=True,
    users=[{
        "password": "AmazonMqPassword",
        "username": "AmazonMqUsername",
    }])

Example coming soon!

Example

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AwsNative = Pulumi.AwsNative;

return await Deployment.RunAsync(() => 
{
    var complexBroker = new AwsNative.AmazonMq.Broker("complexBroker", new()
    {
        AutoMinorVersionUpgrade = true,
        BrokerName = "MyComplexRabbitBroker",
        DeploymentMode = AwsNative.AmazonMq.BrokerDeploymentMode.SingleInstance,
        EngineType = "RabbitMQ",
        EngineVersion = "3.8.6",
        HostInstanceType = "mq.t3.micro",
        Logs = new AwsNative.AmazonMq.Inputs.BrokerLogListArgs
        {
            General = true,
        },
        MaintenanceWindowStartTime = new AwsNative.AmazonMq.Inputs.BrokerMaintenanceWindowArgs
        {
            DayOfWeek = "Monday",
            TimeOfDay = "22:45",
            TimeZone = "America/Los_Angeles",
        },
        PubliclyAccessible = false,
        SecurityGroups = new[]
        {
            "sg-1a234b5cd6efgh7i8",
        },
        SubnetIds = new[]
        {
            "subnet-123456b7891abcd1f",
        },
        Users = new[]
        {
            new AwsNative.AmazonMq.Inputs.BrokerUserArgs
            {
                Password = "AmazonMqPassword",
                Username = "AmazonMqUsername",
            },
        },
    });

});

package main

import (
	"github.com/pulumi/pulumi-aws-native/sdk/go/aws/amazonmq"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := amazonmq.NewBroker(ctx, "complexBroker", &amazonmq.BrokerArgs{
			AutoMinorVersionUpgrade: pulumi.Bool(true),
			BrokerName:              pulumi.String("MyComplexRabbitBroker"),
			DeploymentMode:          pulumi.String(amazonmq.BrokerDeploymentModeSingleInstance),
			EngineType:              pulumi.String("RabbitMQ"),
			EngineVersion:           pulumi.String("3.8.6"),
			HostInstanceType:        pulumi.String("mq.t3.micro"),
			Logs: &amazonmq.BrokerLogListArgs{
				General: pulumi.Bool(true),
			},
			MaintenanceWindowStartTime: &amazonmq.BrokerMaintenanceWindowArgs{
				DayOfWeek: pulumi.String("Monday"),
				TimeOfDay: pulumi.String("22:45"),
				TimeZone:  pulumi.String("America/Los_Angeles"),
			},
			PubliclyAccessible: pulumi.Bool(false),
			SecurityGroups: pulumi.StringArray{
				pulumi.String("sg-1a234b5cd6efgh7i8"),
			},
			SubnetIds: pulumi.StringArray{
				pulumi.String("subnet-123456b7891abcd1f"),
			},
			Users: amazonmq.BrokerUserArray{
				&amazonmq.BrokerUserArgs{
					Password: pulumi.String("AmazonMqPassword"),
					Username: pulumi.String("AmazonMqUsername"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

Example coming soon!

import * as pulumi from "@pulumi/pulumi";
import * as aws_native from "@pulumi/aws-native";

const complexBroker = new aws_native.amazonmq.Broker("complexBroker", {
    autoMinorVersionUpgrade: true,
    brokerName: "MyComplexRabbitBroker",
    deploymentMode: aws_native.amazonmq.BrokerDeploymentMode.SingleInstance,
    engineType: "RabbitMQ",
    engineVersion: "3.8.6",
    hostInstanceType: "mq.t3.micro",
    logs: {
        general: true,
    },
    maintenanceWindowStartTime: {
        dayOfWeek: "Monday",
        timeOfDay: "22:45",
        timeZone: "America/Los_Angeles",
    },
    publiclyAccessible: false,
    securityGroups: ["sg-1a234b5cd6efgh7i8"],
    subnetIds: ["subnet-123456b7891abcd1f"],
    users: [{
        password: "AmazonMqPassword",
        username: "AmazonMqUsername",
    }],
});

import pulumi
import pulumi_aws_native as aws_native

complex_broker = aws_native.amazonmq.Broker("complexBroker",
    auto_minor_version_upgrade=True,
    broker_name="MyComplexRabbitBroker",
    deployment_mode=aws_native.amazonmq.BrokerDeploymentMode.SINGLE_INSTANCE,
    engine_type="RabbitMQ",
    engine_version="3.8.6",
    host_instance_type="mq.t3.micro",
    logs={
        "general": True,
    },
    maintenance_window_start_time={
        "day_of_week": "Monday",
        "time_of_day": "22:45",
        "time_zone": "America/Los_Angeles",
    },
    publicly_accessible=False,
    security_groups=["sg-1a234b5cd6efgh7i8"],
    subnet_ids=["subnet-123456b7891abcd1f"],
    users=[{
        "password": "AmazonMqPassword",
        "username": "AmazonMqUsername",
    }])

Example coming soon!

Example

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AwsNative = Pulumi.AwsNative;

return await Deployment.RunAsync(() => 
{
    var complexBroker = new AwsNative.AmazonMq.Broker("complexBroker", new()
    {
        AutoMinorVersionUpgrade = false,
        BrokerName = "MyComplexRabbitBroker",
        DeploymentMode = AwsNative.AmazonMq.BrokerDeploymentMode.SingleInstance,
        EngineType = "RabbitMQ",
        EngineVersion = "3.8.6",
        HostInstanceType = "mq.t3.micro",
        Logs = new AwsNative.AmazonMq.Inputs.BrokerLogListArgs
        {
            General = true,
        },
        MaintenanceWindowStartTime = new AwsNative.AmazonMq.Inputs.BrokerMaintenanceWindowArgs
        {
            DayOfWeek = "Monday",
            TimeOfDay = "22:45",
            TimeZone = "America/Los_Angeles",
        },
        PubliclyAccessible = false,
        SecurityGroups = new[]
        {
            "sg-1a234b5cd6efgh7i8",
        },
        SubnetIds = new[]
        {
            "subnet-123456b7891abcd1f",
        },
        Users = new[]
        {
            new AwsNative.AmazonMq.Inputs.BrokerUserArgs
            {
                Password = "AmazonMqPassword",
                Username = "AmazonMqUsername",
            },
        },
    });

});

package main

import (
	"github.com/pulumi/pulumi-aws-native/sdk/go/aws/amazonmq"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := amazonmq.NewBroker(ctx, "complexBroker", &amazonmq.BrokerArgs{
			AutoMinorVersionUpgrade: pulumi.Bool(false),
			BrokerName:              pulumi.String("MyComplexRabbitBroker"),
			DeploymentMode:          pulumi.String(amazonmq.BrokerDeploymentModeSingleInstance),
			EngineType:              pulumi.String("RabbitMQ"),
			EngineVersion:           pulumi.String("3.8.6"),
			HostInstanceType:        pulumi.String("mq.t3.micro"),
			Logs: &amazonmq.BrokerLogListArgs{
				General: pulumi.Bool(true),
			},
			MaintenanceWindowStartTime: &amazonmq.BrokerMaintenanceWindowArgs{
				DayOfWeek: pulumi.String("Monday"),
				TimeOfDay: pulumi.String("22:45"),
				TimeZone:  pulumi.String("America/Los_Angeles"),
			},
			PubliclyAccessible: pulumi.Bool(false),
			SecurityGroups: pulumi.StringArray{
				pulumi.String("sg-1a234b5cd6efgh7i8"),
			},
			SubnetIds: pulumi.StringArray{
				pulumi.String("subnet-123456b7891abcd1f"),
			},
			Users: amazonmq.BrokerUserArray{
				&amazonmq.BrokerUserArgs{
					Password: pulumi.String("AmazonMqPassword"),
					Username: pulumi.String("AmazonMqUsername"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

Example coming soon!

import * as pulumi from "@pulumi/pulumi";
import * as aws_native from "@pulumi/aws-native";

const complexBroker = new aws_native.amazonmq.Broker("complexBroker", {
    autoMinorVersionUpgrade: false,
    brokerName: "MyComplexRabbitBroker",
    deploymentMode: aws_native.amazonmq.BrokerDeploymentMode.SingleInstance,
    engineType: "RabbitMQ",
    engineVersion: "3.8.6",
    hostInstanceType: "mq.t3.micro",
    logs: {
        general: true,
    },
    maintenanceWindowStartTime: {
        dayOfWeek: "Monday",
        timeOfDay: "22:45",
        timeZone: "America/Los_Angeles",
    },
    publiclyAccessible: false,
    securityGroups: ["sg-1a234b5cd6efgh7i8"],
    subnetIds: ["subnet-123456b7891abcd1f"],
    users: [{
        password: "AmazonMqPassword",
        username: "AmazonMqUsername",
    }],
});

import pulumi
import pulumi_aws_native as aws_native

complex_broker = aws_native.amazonmq.Broker("complexBroker",
    auto_minor_version_upgrade=False,
    broker_name="MyComplexRabbitBroker",
    deployment_mode=aws_native.amazonmq.BrokerDeploymentMode.SINGLE_INSTANCE,
    engine_type="RabbitMQ",
    engine_version="3.8.6",
    host_instance_type="mq.t3.micro",
    logs={
        "general": True,
    },
    maintenance_window_start_time={
        "day_of_week": "Monday",
        "time_of_day": "22:45",
        "time_zone": "America/Los_Angeles",
    },
    publicly_accessible=False,
    security_groups=["sg-1a234b5cd6efgh7i8"],
    subnet_ids=["subnet-123456b7891abcd1f"],
    users=[{
        "password": "AmazonMqPassword",
        "username": "AmazonMqUsername",
    }])

Example coming soon!

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,
           deployment_mode: Optional[Union[BrokerDeploymentMode, str]] = None,
           publicly_accessible: Optional[bool] = None,
           host_instance_type: Optional[str] = None,
           engine_type: Optional[Union[BrokerEngineType, str]] = None,
           data_replication_primary_broker_arn: Optional[str] = None,
           ldap_server_metadata: Optional[BrokerLdapServerMetadataArgs] = None,
           data_replication_mode: Optional[Union[BrokerDataReplicationMode, str]] = None,
           encryption_options: Optional[BrokerEncryptionOptionsArgs] = None,
           configuration: Optional[BrokerConfigurationIdArgs] = None,
           engine_version: Optional[str] = None,
           broker_name: Optional[str] = None,
           authentication_strategy: Optional[Union[BrokerAuthenticationStrategy, str]] = None,
           logs: Optional[BrokerLogListArgs] = None,
           maintenance_window_start_time: Optional[BrokerMaintenanceWindowArgs] = None,
           auto_minor_version_upgrade: Optional[bool] = None,
           security_groups: Optional[Sequence[str]] = None,
           storage_type: Optional[Union[BrokerStorageType, str]] = None,
           subnet_ids: Optional[Sequence[str]] = None,
           tags: Optional[Sequence[_root_inputs.TagArgs]] = None,
           users: Optional[Sequence[BrokerUserArgs]] = 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-native:amazonmq: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.

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:

DeploymentMode Pulumi.AwsNative.AmazonMq.BrokerDeploymentMode | string

The deployment mode of the broker. Available values:

SINGLE_INSTANCE
ACTIVE_STANDBY_MULTI_AZ
CLUSTER_MULTI_AZ

EngineType Pulumi.AwsNative.AmazonMq.BrokerEngineType | string

The type of broker engine. Currently, Amazon MQ supports ACTIVEMQ and RABBITMQ .

HostInstanceType string

The broker's instance type.

PubliclyAccessible bool

Enables connections from applications outside of the VPC that hosts the broker's subnets.

AuthenticationStrategy Pulumi.AwsNative.AmazonMq.BrokerAuthenticationStrategy | string

Optional. The authentication strategy used to secure the broker. The default is SIMPLE .

AutoMinorVersionUpgrade bool

Enables automatic upgrades to new minor versions for brokers, as new broker engine versions are released and supported by Amazon MQ. Automatic upgrades occur during the scheduled maintenance window of the broker or after a manual broker reboot.

BrokerName string

The name of the broker. This value must be unique in your AWS account , 1-50 characters long, must contain only letters, numbers, dashes, and underscores, and must not contain white spaces, brackets, wildcard characters, or special characters.

Do not add personally identifiable information (PII) or other confidential or sensitive information in broker names. Broker names are accessible to other AWS services, including C CloudWatch Logs . Broker names are not intended to be used for private or sensitive data.

Configuration Pulumi.AwsNative.AmazonMq.Inputs.BrokerConfigurationId

The intended configuration (ID and revision) to be set when creating or updating. This property is write-only so that applications of a ConfigurationAssociation do not cause drift.

DataReplicationMode Pulumi.AwsNative.AmazonMq.BrokerDataReplicationMode | string

Defines whether this broker is a part of a data replication pair.

DataReplicationPrimaryBrokerArn string

The ARN of the primary broker that is used to replicate data from in a data replication pair when creating a replica. This field is only used at creation-time. Changes to it subsequently are ignored by CloudFormation. Information on the current primary is available on the DataReplicationMetadata object returned by the API.

EncryptionOptions Pulumi.AwsNative.AmazonMq.Inputs.BrokerEncryptionOptions

Encryption options for the broker. Does not apply to RabbitMQ brokers.

EngineVersion string

The version specified to use. See also EngineVersionCurrent.

LdapServerMetadata Pulumi.AwsNative.AmazonMq.Inputs.BrokerLdapServerMetadata

Optional. The metadata of the LDAP server used to authenticate and authorize connections to the broker. Does not apply to RabbitMQ brokers.

Logs Pulumi.AwsNative.AmazonMq.Inputs.BrokerLogList

Enables Amazon CloudWatch logging for brokers.

MaintenanceWindowStartTime Pulumi.AwsNative.AmazonMq.Inputs.BrokerMaintenanceWindow

The scheduled time period relative to UTC during which Amazon MQ begins to apply pending updates or patches to the broker.

SecurityGroups List<string>

The list of rules (1 minimum, 125 maximum) that authorize connections to brokers.

StorageType Pulumi.AwsNative.AmazonMq.BrokerStorageType | string

The broker's storage type.

SubnetIds List<string>

The list of groups that define which subnets and IP ranges the broker can use from different Availability Zones. If you specify more than one subnet, the subnets must be in different Availability Zones. Amazon MQ will not be able to create VPC endpoints for your broker with multiple subnets in the same Availability Zone. A SINGLE_INSTANCE deployment requires one subnet (for example, the default subnet). An ACTIVE_STANDBY_MULTI_AZ deployment (ACTIVEMQ) requires two subnets. A CLUSTER_MULTI_AZ deployment (RABBITMQ) has no subnet requirements when deployed with public accessibility, deployment without public accessibility requires at least one subnet.

If you specify subnets in a shared VPC for a RabbitMQ broker, the associated VPC to which the specified subnets belong must be owned by your AWS account . Amazon MQ will not be able to create VPC enpoints in VPCs that are not owned by your AWS account .

Tags List<Pulumi.AwsNative.Inputs.Tag>

An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Billing and Cost Management User Guide .

Users List<Pulumi.AwsNative.AmazonMq.Inputs.BrokerUser>

Users to configure on the broker. For RabbitMQ, this should be one user, created when the broker is created, and changes thereafter are ignored. For ActiveMQ, changes to anything but Password are detected and will trigger an update, but changes to Password cannot be detected so updates to Password may not take effect unless there is some other change.

DeploymentMode BrokerDeploymentMode | string

The deployment mode of the broker. Available values:

SINGLE_INSTANCE
ACTIVE_STANDBY_MULTI_AZ
CLUSTER_MULTI_AZ

EngineType BrokerEngineType | string

The type of broker engine. Currently, Amazon MQ supports ACTIVEMQ and RABBITMQ .

HostInstanceType string

The broker's instance type.

PubliclyAccessible bool

Enables connections from applications outside of the VPC that hosts the broker's subnets.

AuthenticationStrategy BrokerAuthenticationStrategy | string

Optional. The authentication strategy used to secure the broker. The default is SIMPLE .

AutoMinorVersionUpgrade bool

BrokerName string

Do not add personally identifiable information (PII) or other confidential or sensitive information in broker names. Broker names are accessible to other AWS services, including C CloudWatch Logs . Broker names are not intended to be used for private or sensitive data.

Configuration BrokerConfigurationIdArgs

The intended configuration (ID and revision) to be set when creating or updating. This property is write-only so that applications of a ConfigurationAssociation do not cause drift.

DataReplicationMode BrokerDataReplicationMode | string

Defines whether this broker is a part of a data replication pair.

DataReplicationPrimaryBrokerArn string

EncryptionOptions BrokerEncryptionOptionsArgs

Encryption options for the broker. Does not apply to RabbitMQ brokers.

EngineVersion string

The version specified to use. See also EngineVersionCurrent.

LdapServerMetadata BrokerLdapServerMetadataArgs

Optional. The metadata of the LDAP server used to authenticate and authorize connections to the broker. Does not apply to RabbitMQ brokers.

Logs BrokerLogListArgs

Enables Amazon CloudWatch logging for brokers.

MaintenanceWindowStartTime BrokerMaintenanceWindowArgs

The scheduled time period relative to UTC during which Amazon MQ begins to apply pending updates or patches to the broker.

SecurityGroups []string

The list of rules (1 minimum, 125 maximum) that authorize connections to brokers.

StorageType BrokerStorageType | string

The broker's storage type.

SubnetIds []string

If you specify subnets in a shared VPC for a RabbitMQ broker, the associated VPC to which the specified subnets belong must be owned by your AWS account . Amazon MQ will not be able to create VPC enpoints in VPCs that are not owned by your AWS account .

Tags TagArgs

An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Billing and Cost Management User Guide .

Users []BrokerUserArgs

deploymentMode BrokerDeploymentMode | String

The deployment mode of the broker. Available values:

SINGLE_INSTANCE
ACTIVE_STANDBY_MULTI_AZ
CLUSTER_MULTI_AZ

engineType BrokerEngineType | String

The type of broker engine. Currently, Amazon MQ supports ACTIVEMQ and RABBITMQ .

hostInstanceType String

The broker's instance type.

publiclyAccessible Boolean

Enables connections from applications outside of the VPC that hosts the broker's subnets.

authenticationStrategy BrokerAuthenticationStrategy | String

Optional. The authentication strategy used to secure the broker. The default is SIMPLE .

autoMinorVersionUpgrade Boolean

brokerName String

Do not add personally identifiable information (PII) or other confidential or sensitive information in broker names. Broker names are accessible to other AWS services, including C CloudWatch Logs . Broker names are not intended to be used for private or sensitive data.

configuration BrokerConfigurationId

The intended configuration (ID and revision) to be set when creating or updating. This property is write-only so that applications of a ConfigurationAssociation do not cause drift.

dataReplicationMode BrokerDataReplicationMode | String

Defines whether this broker is a part of a data replication pair.

dataReplicationPrimaryBrokerArn String

encryptionOptions BrokerEncryptionOptions

Encryption options for the broker. Does not apply to RabbitMQ brokers.

engineVersion String

The version specified to use. See also EngineVersionCurrent.

ldapServerMetadata BrokerLdapServerMetadata

Optional. The metadata of the LDAP server used to authenticate and authorize connections to the broker. Does not apply to RabbitMQ brokers.

logs BrokerLogList

Enables Amazon CloudWatch logging for brokers.

maintenanceWindowStartTime BrokerMaintenanceWindow

The scheduled time period relative to UTC during which Amazon MQ begins to apply pending updates or patches to the broker.

securityGroups List<String>

The list of rules (1 minimum, 125 maximum) that authorize connections to brokers.

storageType BrokerStorageType | String

The broker's storage type.

subnetIds List<String>

If you specify subnets in a shared VPC for a RabbitMQ broker, the associated VPC to which the specified subnets belong must be owned by your AWS account . Amazon MQ will not be able to create VPC enpoints in VPCs that are not owned by your AWS account .

tags List<Tag>

An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Billing and Cost Management User Guide .

users List<BrokerUser>

deploymentMode BrokerDeploymentMode | string

The deployment mode of the broker. Available values:

SINGLE_INSTANCE
ACTIVE_STANDBY_MULTI_AZ
CLUSTER_MULTI_AZ

engineType BrokerEngineType | string

The type of broker engine. Currently, Amazon MQ supports ACTIVEMQ and RABBITMQ .

hostInstanceType string

The broker's instance type.

publiclyAccessible boolean

Enables connections from applications outside of the VPC that hosts the broker's subnets.

authenticationStrategy BrokerAuthenticationStrategy | string

Optional. The authentication strategy used to secure the broker. The default is SIMPLE .

autoMinorVersionUpgrade boolean

brokerName string

Do not add personally identifiable information (PII) or other confidential or sensitive information in broker names. Broker names are accessible to other AWS services, including C CloudWatch Logs . Broker names are not intended to be used for private or sensitive data.

configuration BrokerConfigurationId

The intended configuration (ID and revision) to be set when creating or updating. This property is write-only so that applications of a ConfigurationAssociation do not cause drift.

dataReplicationMode BrokerDataReplicationMode | string

Defines whether this broker is a part of a data replication pair.

dataReplicationPrimaryBrokerArn string

encryptionOptions BrokerEncryptionOptions

Encryption options for the broker. Does not apply to RabbitMQ brokers.

engineVersion string

The version specified to use. See also EngineVersionCurrent.

ldapServerMetadata BrokerLdapServerMetadata

Optional. The metadata of the LDAP server used to authenticate and authorize connections to the broker. Does not apply to RabbitMQ brokers.

logs BrokerLogList

Enables Amazon CloudWatch logging for brokers.

maintenanceWindowStartTime BrokerMaintenanceWindow

The scheduled time period relative to UTC during which Amazon MQ begins to apply pending updates or patches to the broker.

securityGroups string[]

The list of rules (1 minimum, 125 maximum) that authorize connections to brokers.

storageType BrokerStorageType | string

The broker's storage type.

subnetIds string[]

If you specify subnets in a shared VPC for a RabbitMQ broker, the associated VPC to which the specified subnets belong must be owned by your AWS account . Amazon MQ will not be able to create VPC enpoints in VPCs that are not owned by your AWS account .

tags Tag[]

An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Billing and Cost Management User Guide .

users BrokerUser[]

deployment_mode BrokerDeploymentMode | str

The deployment mode of the broker. Available values:

SINGLE_INSTANCE
ACTIVE_STANDBY_MULTI_AZ
CLUSTER_MULTI_AZ

engine_type BrokerEngineType | str

The type of broker engine. Currently, Amazon MQ supports ACTIVEMQ and RABBITMQ .

host_instance_type str

The broker's instance type.

publicly_accessible bool

Enables connections from applications outside of the VPC that hosts the broker's subnets.

authentication_strategy BrokerAuthenticationStrategy | str

Optional. The authentication strategy used to secure the broker. The default is SIMPLE .

auto_minor_version_upgrade bool

broker_name str

Do not add personally identifiable information (PII) or other confidential or sensitive information in broker names. Broker names are accessible to other AWS services, including C CloudWatch Logs . Broker names are not intended to be used for private or sensitive data.

configuration BrokerConfigurationIdArgs

The intended configuration (ID and revision) to be set when creating or updating. This property is write-only so that applications of a ConfigurationAssociation do not cause drift.

data_replication_mode BrokerDataReplicationMode | str

Defines whether this broker is a part of a data replication pair.

data_replication_primary_broker_arn str

encryption_options BrokerEncryptionOptionsArgs

Encryption options for the broker. Does not apply to RabbitMQ brokers.

engine_version str

The version specified to use. See also EngineVersionCurrent.

ldap_server_metadata BrokerLdapServerMetadataArgs

Optional. The metadata of the LDAP server used to authenticate and authorize connections to the broker. Does not apply to RabbitMQ brokers.

logs BrokerLogListArgs

Enables Amazon CloudWatch logging for brokers.

maintenance_window_start_time BrokerMaintenanceWindowArgs

The scheduled time period relative to UTC during which Amazon MQ begins to apply pending updates or patches to the broker.

security_groups Sequence[str]

The list of rules (1 minimum, 125 maximum) that authorize connections to brokers.

storage_type BrokerStorageType | str

The broker's storage type.

subnet_ids Sequence[str]

If you specify subnets in a shared VPC for a RabbitMQ broker, the associated VPC to which the specified subnets belong must be owned by your AWS account . Amazon MQ will not be able to create VPC enpoints in VPCs that are not owned by your AWS account .

tags Sequence[TagArgs]

An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Billing and Cost Management User Guide .

users Sequence[BrokerUserArgs]

deploymentMode "SINGLE_INSTANCE" | "ACTIVE_STANDBY_MULTI_AZ" | "CLUSTER_MULTI_AZ" | String

The deployment mode of the broker. Available values:

SINGLE_INSTANCE
ACTIVE_STANDBY_MULTI_AZ
CLUSTER_MULTI_AZ

engineType "ACTIVEMQ" | "RABBITMQ" | String

The type of broker engine. Currently, Amazon MQ supports ACTIVEMQ and RABBITMQ .

hostInstanceType String

The broker's instance type.

publiclyAccessible Boolean

Enables connections from applications outside of the VPC that hosts the broker's subnets.

authenticationStrategy "SIMPLE" | "LDAP" | String

Optional. The authentication strategy used to secure the broker. The default is SIMPLE .

autoMinorVersionUpgrade Boolean

brokerName String

Do not add personally identifiable information (PII) or other confidential or sensitive information in broker names. Broker names are accessible to other AWS services, including C CloudWatch Logs . Broker names are not intended to be used for private or sensitive data.

configuration Property Map

The intended configuration (ID and revision) to be set when creating or updating. This property is write-only so that applications of a ConfigurationAssociation do not cause drift.

dataReplicationMode "NONE" | "CRDR" | String

Defines whether this broker is a part of a data replication pair.

dataReplicationPrimaryBrokerArn String

encryptionOptions Property Map

Encryption options for the broker. Does not apply to RabbitMQ brokers.

engineVersion String

The version specified to use. See also EngineVersionCurrent.

ldapServerMetadata Property Map

Optional. The metadata of the LDAP server used to authenticate and authorize connections to the broker. Does not apply to RabbitMQ brokers.

logs Property Map

Enables Amazon CloudWatch logging for brokers.

maintenanceWindowStartTime Property Map

The scheduled time period relative to UTC during which Amazon MQ begins to apply pending updates or patches to the broker.

securityGroups List<String>

The list of rules (1 minimum, 125 maximum) that authorize connections to brokers.

storageType "EBS" | "EFS" | String

The broker's storage type.

subnetIds List<String>

If you specify subnets in a shared VPC for a RabbitMQ broker, the associated VPC to which the specified subnets belong must be owned by your AWS account . Amazon MQ will not be able to create VPC enpoints in VPCs that are not owned by your AWS account .

tags List<Property Map>

An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Billing and Cost Management User Guide .

users List<Property Map>

Outputs

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

AmqpEndpoints List<string>

The AMQP endpoints of each broker instance as a list of strings.

amqp+ssl://b-4aada85d-a80c-4be0-9d30-e344a01b921e-1.mq.eu-central-amazonaws.com:5671

Arn string

The Amazon Resource Name (ARN) of the Amazon MQ broker.

arn:aws:mq:us-east-2:123456789012:broker:MyBroker:b-1234a5b6-78cd-901e-2fgh-3i45j6k178l9

AwsId string

Required. The unique ID that Amazon MQ generates for the configuration.

ConfigurationId string

The ID of the current actual configuration.

ConfigurationRevision string

The revision of the current actual configuration.

ConsoleUrls List<string>

EngineVersionCurrent string

The version in use. This may have more precision than the specified EngineVersion.

Id string

The provider-assigned unique ID for this managed resource.

IpAddresses List<string>

The IP addresses of each broker instance as a list of strings. Does not apply to RabbitMQ brokers.

['198.51.100.2', '203.0.113.9']

MqttEndpoints List<string>

The MQTT endpoints of each broker instance as a list of strings.

mqtt+ssl://b-4aada85d-a80c-4be0-9d30-e344a01b921e-1.mq.eu-central-amazonaws.com:8883

OpenWireEndpoints List<string>

The OpenWire endpoints of each broker instance as a list of strings.

ssl://b-4aada85d-a80c-4be0-9d30-e344a01b921e-1.mq.eu-central-amazonaws.com:61617

StompEndpoints List<string>

The STOMP endpoints of each broker instance as a list of strings.

stomp+ssl://b-4aada85d-a80c-4be0-9d30-e344a01b921e-1.mq.eu-central-amazonaws.com:61614

WssEndpoints List<string>

The WSS endpoints of each broker instance as a list of strings.

wss://b-4aada85d-a80c-4be0-9d30-e344a01b921e-1.mq.eu-central-amazonaws.com:61619

AmqpEndpoints []string

The AMQP endpoints of each broker instance as a list of strings.

amqp+ssl://b-4aada85d-a80c-4be0-9d30-e344a01b921e-1.mq.eu-central-amazonaws.com:5671

Arn string

The Amazon Resource Name (ARN) of the Amazon MQ broker.

arn:aws:mq:us-east-2:123456789012:broker:MyBroker:b-1234a5b6-78cd-901e-2fgh-3i45j6k178l9

AwsId string

Required. The unique ID that Amazon MQ generates for the configuration.

ConfigurationId string

The ID of the current actual configuration.

ConfigurationRevision string

The revision of the current actual configuration.

ConsoleUrls []string

EngineVersionCurrent string

The version in use. This may have more precision than the specified EngineVersion.

Id string

The provider-assigned unique ID for this managed resource.

IpAddresses []string

The IP addresses of each broker instance as a list of strings. Does not apply to RabbitMQ brokers.

['198.51.100.2', '203.0.113.9']

MqttEndpoints []string

The MQTT endpoints of each broker instance as a list of strings.

mqtt+ssl://b-4aada85d-a80c-4be0-9d30-e344a01b921e-1.mq.eu-central-amazonaws.com:8883

OpenWireEndpoints []string

The OpenWire endpoints of each broker instance as a list of strings.

ssl://b-4aada85d-a80c-4be0-9d30-e344a01b921e-1.mq.eu-central-amazonaws.com:61617

StompEndpoints []string

The STOMP endpoints of each broker instance as a list of strings.

stomp+ssl://b-4aada85d-a80c-4be0-9d30-e344a01b921e-1.mq.eu-central-amazonaws.com:61614

WssEndpoints []string

The WSS endpoints of each broker instance as a list of strings.

wss://b-4aada85d-a80c-4be0-9d30-e344a01b921e-1.mq.eu-central-amazonaws.com:61619

amqpEndpoints List<String>

The AMQP endpoints of each broker instance as a list of strings.

amqp+ssl://b-4aada85d-a80c-4be0-9d30-e344a01b921e-1.mq.eu-central-amazonaws.com:5671

arn String

The Amazon Resource Name (ARN) of the Amazon MQ broker.

arn:aws:mq:us-east-2:123456789012:broker:MyBroker:b-1234a5b6-78cd-901e-2fgh-3i45j6k178l9

awsId String

Required. The unique ID that Amazon MQ generates for the configuration.

configurationId String

The ID of the current actual configuration.

configurationRevision String

The revision of the current actual configuration.

consoleUrls List<String>

engineVersionCurrent String

The version in use. This may have more precision than the specified EngineVersion.

id String

The provider-assigned unique ID for this managed resource.

ipAddresses List<String>

The IP addresses of each broker instance as a list of strings. Does not apply to RabbitMQ brokers.

['198.51.100.2', '203.0.113.9']

mqttEndpoints List<String>

The MQTT endpoints of each broker instance as a list of strings.

mqtt+ssl://b-4aada85d-a80c-4be0-9d30-e344a01b921e-1.mq.eu-central-amazonaws.com:8883

openWireEndpoints List<String>

The OpenWire endpoints of each broker instance as a list of strings.

ssl://b-4aada85d-a80c-4be0-9d30-e344a01b921e-1.mq.eu-central-amazonaws.com:61617

stompEndpoints List<String>

The STOMP endpoints of each broker instance as a list of strings.

stomp+ssl://b-4aada85d-a80c-4be0-9d30-e344a01b921e-1.mq.eu-central-amazonaws.com:61614

wssEndpoints List<String>

The WSS endpoints of each broker instance as a list of strings.

wss://b-4aada85d-a80c-4be0-9d30-e344a01b921e-1.mq.eu-central-amazonaws.com:61619

amqpEndpoints string[]

The AMQP endpoints of each broker instance as a list of strings.

amqp+ssl://b-4aada85d-a80c-4be0-9d30-e344a01b921e-1.mq.eu-central-amazonaws.com:5671

arn string

The Amazon Resource Name (ARN) of the Amazon MQ broker.

arn:aws:mq:us-east-2:123456789012:broker:MyBroker:b-1234a5b6-78cd-901e-2fgh-3i45j6k178l9

awsId string

Required. The unique ID that Amazon MQ generates for the configuration.

configurationId string

The ID of the current actual configuration.

configurationRevision string

The revision of the current actual configuration.

consoleUrls string[]

engineVersionCurrent string

The version in use. This may have more precision than the specified EngineVersion.

id string

The provider-assigned unique ID for this managed resource.

ipAddresses string[]

The IP addresses of each broker instance as a list of strings. Does not apply to RabbitMQ brokers.

['198.51.100.2', '203.0.113.9']

mqttEndpoints string[]

The MQTT endpoints of each broker instance as a list of strings.

mqtt+ssl://b-4aada85d-a80c-4be0-9d30-e344a01b921e-1.mq.eu-central-amazonaws.com:8883

openWireEndpoints string[]

The OpenWire endpoints of each broker instance as a list of strings.

ssl://b-4aada85d-a80c-4be0-9d30-e344a01b921e-1.mq.eu-central-amazonaws.com:61617

stompEndpoints string[]

The STOMP endpoints of each broker instance as a list of strings.

stomp+ssl://b-4aada85d-a80c-4be0-9d30-e344a01b921e-1.mq.eu-central-amazonaws.com:61614

wssEndpoints string[]

The WSS endpoints of each broker instance as a list of strings.

wss://b-4aada85d-a80c-4be0-9d30-e344a01b921e-1.mq.eu-central-amazonaws.com:61619

amqp_endpoints Sequence[str]

The AMQP endpoints of each broker instance as a list of strings.

amqp+ssl://b-4aada85d-a80c-4be0-9d30-e344a01b921e-1.mq.eu-central-amazonaws.com:5671

arn str

The Amazon Resource Name (ARN) of the Amazon MQ broker.

arn:aws:mq:us-east-2:123456789012:broker:MyBroker:b-1234a5b6-78cd-901e-2fgh-3i45j6k178l9

aws_id str

Required. The unique ID that Amazon MQ generates for the configuration.

configuration_id str

The ID of the current actual configuration.

configuration_revision str

The revision of the current actual configuration.

console_urls Sequence[str]

engine_version_current str

The version in use. This may have more precision than the specified EngineVersion.

id str

The provider-assigned unique ID for this managed resource.

ip_addresses Sequence[str]

The IP addresses of each broker instance as a list of strings. Does not apply to RabbitMQ brokers.

['198.51.100.2', '203.0.113.9']

mqtt_endpoints Sequence[str]

The MQTT endpoints of each broker instance as a list of strings.

mqtt+ssl://b-4aada85d-a80c-4be0-9d30-e344a01b921e-1.mq.eu-central-amazonaws.com:8883

open_wire_endpoints Sequence[str]

The OpenWire endpoints of each broker instance as a list of strings.

ssl://b-4aada85d-a80c-4be0-9d30-e344a01b921e-1.mq.eu-central-amazonaws.com:61617

stomp_endpoints Sequence[str]

The STOMP endpoints of each broker instance as a list of strings.

stomp+ssl://b-4aada85d-a80c-4be0-9d30-e344a01b921e-1.mq.eu-central-amazonaws.com:61614

wss_endpoints Sequence[str]

The WSS endpoints of each broker instance as a list of strings.

wss://b-4aada85d-a80c-4be0-9d30-e344a01b921e-1.mq.eu-central-amazonaws.com:61619

amqpEndpoints List<String>

The AMQP endpoints of each broker instance as a list of strings.

amqp+ssl://b-4aada85d-a80c-4be0-9d30-e344a01b921e-1.mq.eu-central-amazonaws.com:5671

arn String

The Amazon Resource Name (ARN) of the Amazon MQ broker.

arn:aws:mq:us-east-2:123456789012:broker:MyBroker:b-1234a5b6-78cd-901e-2fgh-3i45j6k178l9

awsId String

Required. The unique ID that Amazon MQ generates for the configuration.

configurationId String

The ID of the current actual configuration.

configurationRevision String

The revision of the current actual configuration.

consoleUrls List<String>

engineVersionCurrent String

The version in use. This may have more precision than the specified EngineVersion.

id String

The provider-assigned unique ID for this managed resource.

ipAddresses List<String>

The IP addresses of each broker instance as a list of strings. Does not apply to RabbitMQ brokers.

['198.51.100.2', '203.0.113.9']

mqttEndpoints List<String>

The MQTT endpoints of each broker instance as a list of strings.

mqtt+ssl://b-4aada85d-a80c-4be0-9d30-e344a01b921e-1.mq.eu-central-amazonaws.com:8883

openWireEndpoints List<String>

The OpenWire endpoints of each broker instance as a list of strings.

ssl://b-4aada85d-a80c-4be0-9d30-e344a01b921e-1.mq.eu-central-amazonaws.com:61617

stompEndpoints List<String>

The STOMP endpoints of each broker instance as a list of strings.

stomp+ssl://b-4aada85d-a80c-4be0-9d30-e344a01b921e-1.mq.eu-central-amazonaws.com:61614

wssEndpoints List<String>

The WSS endpoints of each broker instance as a list of strings.

wss://b-4aada85d-a80c-4be0-9d30-e344a01b921e-1.mq.eu-central-amazonaws.com:61619

Supporting Types

BrokerAuthenticationStrategy, BrokerAuthenticationStrategyArgs

Simple: SIMPLE
Ldap: LDAP

BrokerAuthenticationStrategySimple: SIMPLE
BrokerAuthenticationStrategyLdap: LDAP

Simple: SIMPLE
Ldap: LDAP

Simple: SIMPLE
Ldap: LDAP

SIMPLE: SIMPLE
LDAP: LDAP

"SIMPLE": SIMPLE
"LDAP": LDAP

BrokerConfigurationId, BrokerConfigurationIdArgs

Id string: The unique ID that Amazon MQ generates for the configuration.
Revision int: The revision number of the configuration.

Id string: The unique ID that Amazon MQ generates for the configuration.
Revision int: The revision number of the configuration.

id String: The unique ID that Amazon MQ generates for the configuration.
revision Integer: The revision number of the configuration.

id string: The unique ID that Amazon MQ generates for the configuration.
revision number: The revision number of the configuration.

id str: The unique ID that Amazon MQ generates for the configuration.
revision int: The revision number of the configuration.

id String: The unique ID that Amazon MQ generates for the configuration.
revision Number: The revision number of the configuration.

BrokerDataReplicationMode, BrokerDataReplicationModeArgs

None: NONE
Crdr: CRDR

BrokerDataReplicationModeNone: NONE
BrokerDataReplicationModeCrdr: CRDR

None: NONE
Crdr: CRDR

None: NONE
Crdr: CRDR

NONE: NONE
CRDR: CRDR

"NONE": NONE
"CRDR": CRDR

BrokerDeploymentMode, BrokerDeploymentModeArgs

SingleInstance: SINGLE_INSTANCE
ActiveStandbyMultiAz: ACTIVE_STANDBY_MULTI_AZ
ClusterMultiAz: CLUSTER_MULTI_AZ

BrokerDeploymentModeSingleInstance: SINGLE_INSTANCE
BrokerDeploymentModeActiveStandbyMultiAz: ACTIVE_STANDBY_MULTI_AZ
BrokerDeploymentModeClusterMultiAz: CLUSTER_MULTI_AZ

SingleInstance: SINGLE_INSTANCE
ActiveStandbyMultiAz: ACTIVE_STANDBY_MULTI_AZ
ClusterMultiAz: CLUSTER_MULTI_AZ

SingleInstance: SINGLE_INSTANCE
ActiveStandbyMultiAz: ACTIVE_STANDBY_MULTI_AZ
ClusterMultiAz: CLUSTER_MULTI_AZ

SINGLE_INSTANCE: SINGLE_INSTANCE
ACTIVE_STANDBY_MULTI_AZ: ACTIVE_STANDBY_MULTI_AZ
CLUSTER_MULTI_AZ: CLUSTER_MULTI_AZ

"SINGLE_INSTANCE": SINGLE_INSTANCE
"ACTIVE_STANDBY_MULTI_AZ": ACTIVE_STANDBY_MULTI_AZ
"CLUSTER_MULTI_AZ": CLUSTER_MULTI_AZ

BrokerEncryptionOptions, BrokerEncryptionOptionsArgs

UseAwsOwnedKey bool: Enables the use of an AWS owned CMK using AWS KMS (KMS). Set to true by default, if no value is provided, for example, for RabbitMQ brokers.
KmsKeyId string: The customer master key (CMK) to use for the A KMS (KMS). This key is used to encrypt your data at rest. If not provided, Amazon MQ will use a default CMK to encrypt your data. The Key ARN is recommended so that drift can be detected, but a key ID or key alias will also be accepted for API compatibility reasons.

UseAwsOwnedKey bool: Enables the use of an AWS owned CMK using AWS KMS (KMS). Set to true by default, if no value is provided, for example, for RabbitMQ brokers.
KmsKeyId string: The customer master key (CMK) to use for the A KMS (KMS). This key is used to encrypt your data at rest. If not provided, Amazon MQ will use a default CMK to encrypt your data. The Key ARN is recommended so that drift can be detected, but a key ID or key alias will also be accepted for API compatibility reasons.

useAwsOwnedKey Boolean: Enables the use of an AWS owned CMK using AWS KMS (KMS). Set to true by default, if no value is provided, for example, for RabbitMQ brokers.
kmsKeyId String: The customer master key (CMK) to use for the A KMS (KMS). This key is used to encrypt your data at rest. If not provided, Amazon MQ will use a default CMK to encrypt your data. The Key ARN is recommended so that drift can be detected, but a key ID or key alias will also be accepted for API compatibility reasons.

useAwsOwnedKey boolean: Enables the use of an AWS owned CMK using AWS KMS (KMS). Set to true by default, if no value is provided, for example, for RabbitMQ brokers.
kmsKeyId string: The customer master key (CMK) to use for the A KMS (KMS). This key is used to encrypt your data at rest. If not provided, Amazon MQ will use a default CMK to encrypt your data. The Key ARN is recommended so that drift can be detected, but a key ID or key alias will also be accepted for API compatibility reasons.

use_aws_owned_key bool: Enables the use of an AWS owned CMK using AWS KMS (KMS). Set to true by default, if no value is provided, for example, for RabbitMQ brokers.
kms_key_id str: The customer master key (CMK) to use for the A KMS (KMS). This key is used to encrypt your data at rest. If not provided, Amazon MQ will use a default CMK to encrypt your data. The Key ARN is recommended so that drift can be detected, but a key ID or key alias will also be accepted for API compatibility reasons.

useAwsOwnedKey Boolean: Enables the use of an AWS owned CMK using AWS KMS (KMS). Set to true by default, if no value is provided, for example, for RabbitMQ brokers.
kmsKeyId String: The customer master key (CMK) to use for the A KMS (KMS). This key is used to encrypt your data at rest. If not provided, Amazon MQ will use a default CMK to encrypt your data. The Key ARN is recommended so that drift can be detected, but a key ID or key alias will also be accepted for API compatibility reasons.

BrokerEngineType, BrokerEngineTypeArgs

Activemq: ACTIVEMQ
Rabbitmq: RABBITMQ

BrokerEngineTypeActivemq: ACTIVEMQ
BrokerEngineTypeRabbitmq: RABBITMQ

Activemq: ACTIVEMQ
Rabbitmq: RABBITMQ

Activemq: ACTIVEMQ
Rabbitmq: RABBITMQ

ACTIVEMQ: ACTIVEMQ
RABBITMQ: RABBITMQ

"ACTIVEMQ": ACTIVEMQ
"RABBITMQ": RABBITMQ

BrokerLdapServerMetadata, BrokerLdapServerMetadataArgs

Hosts List<string>: Specifies the location of the LDAP server such as AWS Directory Service for Microsoft Active Directory . Optional failover server.
RoleBase string: The distinguished name of the node in the directory information tree (DIT) to search for roles or groups. For example, ou=group , ou=corp , dc=corp , dc=example , dc=com .
RoleSearchMatching string: The LDAP search filter used to find roles within the roleBase. The distinguished name of the user matched by userSearchMatching is substituted into the {0} placeholder in the search filter. The client's username is substituted into the {1} placeholder. For example, if you set this option to (member=uid={1}) for the user janedoe, the search filter becomes (member=uid=janedoe) after string substitution. It matches all role entries that have a member attribute equal to uid=janedoe under the subtree selected by the RoleBases .
ServiceAccountUsername string: Service account username. A service account is an account in your LDAP server that has access to initiate a connection. For example, cn=admin , ou=corp , dc=corp , dc=example , dc=com .
UserBase string: Select a particular subtree of the directory information tree (DIT) to search for user entries. The subtree is specified by a DN, which specifies the base node of the subtree. For example, by setting this option to ou=Users , ou=corp , dc=corp , dc=example , dc=com , the search for user entries is restricted to the subtree beneath ou=Users , ou=corp , dc=corp , dc=example , dc=com .
UserSearchMatching string: The LDAP search filter used to find users within the userBase . The client's username is substituted into the {0} placeholder in the search filter. For example, if this option is set to (uid={0}) and the received username is janedoe , the search filter becomes (uid=janedoe) after string substitution. It will result in matching an entry like uid=janedoe , ou=Users , ou=corp , dc=corp , dc=example , dc=com .
RoleName string: The group name attribute in a role entry whose value is the name of that role. For example, you can specify cn for a group entry's common name. If authentication succeeds, then the user is assigned the the value of the cn attribute for each role entry that they are a member of.
RoleSearchSubtree bool: The directory search scope for the role. If set to true, scope is to search the entire subtree.
ServiceAccountPassword string: Service account password. A service account is an account in your LDAP server that has access to initiate a connection. For example, cn=admin , dc=corp , dc=example , dc=com .
UserRoleName string: The name of the LDAP attribute in the user's directory entry for the user's group membership. In some cases, user roles may be identified by the value of an attribute in the user's directory entry. The UserRoleName option allows you to provide the name of this attribute.
UserSearchSubtree bool: The directory search scope for the user. If set to true, scope is to search the entire subtree.

Hosts []string: Specifies the location of the LDAP server such as AWS Directory Service for Microsoft Active Directory . Optional failover server.
RoleBase string: The distinguished name of the node in the directory information tree (DIT) to search for roles or groups. For example, ou=group , ou=corp , dc=corp , dc=example , dc=com .
RoleSearchMatching string: The LDAP search filter used to find roles within the roleBase. The distinguished name of the user matched by userSearchMatching is substituted into the {0} placeholder in the search filter. The client's username is substituted into the {1} placeholder. For example, if you set this option to (member=uid={1}) for the user janedoe, the search filter becomes (member=uid=janedoe) after string substitution. It matches all role entries that have a member attribute equal to uid=janedoe under the subtree selected by the RoleBases .
ServiceAccountUsername string: Service account username. A service account is an account in your LDAP server that has access to initiate a connection. For example, cn=admin , ou=corp , dc=corp , dc=example , dc=com .
UserBase string: Select a particular subtree of the directory information tree (DIT) to search for user entries. The subtree is specified by a DN, which specifies the base node of the subtree. For example, by setting this option to ou=Users , ou=corp , dc=corp , dc=example , dc=com , the search for user entries is restricted to the subtree beneath ou=Users , ou=corp , dc=corp , dc=example , dc=com .
UserSearchMatching string: The LDAP search filter used to find users within the userBase . The client's username is substituted into the {0} placeholder in the search filter. For example, if this option is set to (uid={0}) and the received username is janedoe , the search filter becomes (uid=janedoe) after string substitution. It will result in matching an entry like uid=janedoe , ou=Users , ou=corp , dc=corp , dc=example , dc=com .
RoleName string: The group name attribute in a role entry whose value is the name of that role. For example, you can specify cn for a group entry's common name. If authentication succeeds, then the user is assigned the the value of the cn attribute for each role entry that they are a member of.
RoleSearchSubtree bool: The directory search scope for the role. If set to true, scope is to search the entire subtree.
ServiceAccountPassword string: Service account password. A service account is an account in your LDAP server that has access to initiate a connection. For example, cn=admin , dc=corp , dc=example , dc=com .
UserRoleName string: The name of the LDAP attribute in the user's directory entry for the user's group membership. In some cases, user roles may be identified by the value of an attribute in the user's directory entry. The UserRoleName option allows you to provide the name of this attribute.
UserSearchSubtree bool: The directory search scope for the user. If set to true, scope is to search the entire subtree.

hosts List<String>: Specifies the location of the LDAP server such as AWS Directory Service for Microsoft Active Directory . Optional failover server.
roleBase String: The distinguished name of the node in the directory information tree (DIT) to search for roles or groups. For example, ou=group , ou=corp , dc=corp , dc=example , dc=com .
roleSearchMatching String: The LDAP search filter used to find roles within the roleBase. The distinguished name of the user matched by userSearchMatching is substituted into the {0} placeholder in the search filter. The client's username is substituted into the {1} placeholder. For example, if you set this option to (member=uid={1}) for the user janedoe, the search filter becomes (member=uid=janedoe) after string substitution. It matches all role entries that have a member attribute equal to uid=janedoe under the subtree selected by the RoleBases .
serviceAccountUsername String: Service account username. A service account is an account in your LDAP server that has access to initiate a connection. For example, cn=admin , ou=corp , dc=corp , dc=example , dc=com .
userBase String: Select a particular subtree of the directory information tree (DIT) to search for user entries. The subtree is specified by a DN, which specifies the base node of the subtree. For example, by setting this option to ou=Users , ou=corp , dc=corp , dc=example , dc=com , the search for user entries is restricted to the subtree beneath ou=Users , ou=corp , dc=corp , dc=example , dc=com .
userSearchMatching String: The LDAP search filter used to find users within the userBase . The client's username is substituted into the {0} placeholder in the search filter. For example, if this option is set to (uid={0}) and the received username is janedoe , the search filter becomes (uid=janedoe) after string substitution. It will result in matching an entry like uid=janedoe , ou=Users , ou=corp , dc=corp , dc=example , dc=com .
roleName String: The group name attribute in a role entry whose value is the name of that role. For example, you can specify cn for a group entry's common name. If authentication succeeds, then the user is assigned the the value of the cn attribute for each role entry that they are a member of.
roleSearchSubtree Boolean: The directory search scope for the role. If set to true, scope is to search the entire subtree.
serviceAccountPassword String: Service account password. A service account is an account in your LDAP server that has access to initiate a connection. For example, cn=admin , dc=corp , dc=example , dc=com .
userRoleName String: The name of the LDAP attribute in the user's directory entry for the user's group membership. In some cases, user roles may be identified by the value of an attribute in the user's directory entry. The UserRoleName option allows you to provide the name of this attribute.
userSearchSubtree Boolean: The directory search scope for the user. If set to true, scope is to search the entire subtree.

hosts string[]: Specifies the location of the LDAP server such as AWS Directory Service for Microsoft Active Directory . Optional failover server.
roleBase string: The distinguished name of the node in the directory information tree (DIT) to search for roles or groups. For example, ou=group , ou=corp , dc=corp , dc=example , dc=com .
roleSearchMatching string: The LDAP search filter used to find roles within the roleBase. The distinguished name of the user matched by userSearchMatching is substituted into the {0} placeholder in the search filter. The client's username is substituted into the {1} placeholder. For example, if you set this option to (member=uid={1}) for the user janedoe, the search filter becomes (member=uid=janedoe) after string substitution. It matches all role entries that have a member attribute equal to uid=janedoe under the subtree selected by the RoleBases .
serviceAccountUsername string: Service account username. A service account is an account in your LDAP server that has access to initiate a connection. For example, cn=admin , ou=corp , dc=corp , dc=example , dc=com .
userBase string: Select a particular subtree of the directory information tree (DIT) to search for user entries. The subtree is specified by a DN, which specifies the base node of the subtree. For example, by setting this option to ou=Users , ou=corp , dc=corp , dc=example , dc=com , the search for user entries is restricted to the subtree beneath ou=Users , ou=corp , dc=corp , dc=example , dc=com .
userSearchMatching string: The LDAP search filter used to find users within the userBase . The client's username is substituted into the {0} placeholder in the search filter. For example, if this option is set to (uid={0}) and the received username is janedoe , the search filter becomes (uid=janedoe) after string substitution. It will result in matching an entry like uid=janedoe , ou=Users , ou=corp , dc=corp , dc=example , dc=com .
roleName string: The group name attribute in a role entry whose value is the name of that role. For example, you can specify cn for a group entry's common name. If authentication succeeds, then the user is assigned the the value of the cn attribute for each role entry that they are a member of.
roleSearchSubtree boolean: The directory search scope for the role. If set to true, scope is to search the entire subtree.
serviceAccountPassword string: Service account password. A service account is an account in your LDAP server that has access to initiate a connection. For example, cn=admin , dc=corp , dc=example , dc=com .
userRoleName string: The name of the LDAP attribute in the user's directory entry for the user's group membership. In some cases, user roles may be identified by the value of an attribute in the user's directory entry. The UserRoleName option allows you to provide the name of this attribute.
userSearchSubtree boolean: The directory search scope for the user. If set to true, scope is to search the entire subtree.

hosts Sequence[str]: Specifies the location of the LDAP server such as AWS Directory Service for Microsoft Active Directory . Optional failover server.
role_base str: The distinguished name of the node in the directory information tree (DIT) to search for roles or groups. For example, ou=group , ou=corp , dc=corp , dc=example , dc=com .
role_search_matching str: The LDAP search filter used to find roles within the roleBase. The distinguished name of the user matched by userSearchMatching is substituted into the {0} placeholder in the search filter. The client's username is substituted into the {1} placeholder. For example, if you set this option to (member=uid={1}) for the user janedoe, the search filter becomes (member=uid=janedoe) after string substitution. It matches all role entries that have a member attribute equal to uid=janedoe under the subtree selected by the RoleBases .
service_account_username str: Service account username. A service account is an account in your LDAP server that has access to initiate a connection. For example, cn=admin , ou=corp , dc=corp , dc=example , dc=com .
user_base str: Select a particular subtree of the directory information tree (DIT) to search for user entries. The subtree is specified by a DN, which specifies the base node of the subtree. For example, by setting this option to ou=Users , ou=corp , dc=corp , dc=example , dc=com , the search for user entries is restricted to the subtree beneath ou=Users , ou=corp , dc=corp , dc=example , dc=com .
user_search_matching str: The LDAP search filter used to find users within the userBase . The client's username is substituted into the {0} placeholder in the search filter. For example, if this option is set to (uid={0}) and the received username is janedoe , the search filter becomes (uid=janedoe) after string substitution. It will result in matching an entry like uid=janedoe , ou=Users , ou=corp , dc=corp , dc=example , dc=com .
role_name str: The group name attribute in a role entry whose value is the name of that role. For example, you can specify cn for a group entry's common name. If authentication succeeds, then the user is assigned the the value of the cn attribute for each role entry that they are a member of.
role_search_subtree bool: The directory search scope for the role. If set to true, scope is to search the entire subtree.
service_account_password str: Service account password. A service account is an account in your LDAP server that has access to initiate a connection. For example, cn=admin , dc=corp , dc=example , dc=com .
user_role_name str: The name of the LDAP attribute in the user's directory entry for the user's group membership. In some cases, user roles may be identified by the value of an attribute in the user's directory entry. The UserRoleName option allows you to provide the name of this attribute.
user_search_subtree bool: The directory search scope for the user. If set to true, scope is to search the entire subtree.

hosts List<String>: Specifies the location of the LDAP server such as AWS Directory Service for Microsoft Active Directory . Optional failover server.
roleBase String: The distinguished name of the node in the directory information tree (DIT) to search for roles or groups. For example, ou=group , ou=corp , dc=corp , dc=example , dc=com .
roleSearchMatching String: The LDAP search filter used to find roles within the roleBase. The distinguished name of the user matched by userSearchMatching is substituted into the {0} placeholder in the search filter. The client's username is substituted into the {1} placeholder. For example, if you set this option to (member=uid={1}) for the user janedoe, the search filter becomes (member=uid=janedoe) after string substitution. It matches all role entries that have a member attribute equal to uid=janedoe under the subtree selected by the RoleBases .
serviceAccountUsername String: Service account username. A service account is an account in your LDAP server that has access to initiate a connection. For example, cn=admin , ou=corp , dc=corp , dc=example , dc=com .
userBase String: Select a particular subtree of the directory information tree (DIT) to search for user entries. The subtree is specified by a DN, which specifies the base node of the subtree. For example, by setting this option to ou=Users , ou=corp , dc=corp , dc=example , dc=com , the search for user entries is restricted to the subtree beneath ou=Users , ou=corp , dc=corp , dc=example , dc=com .
userSearchMatching String: The LDAP search filter used to find users within the userBase . The client's username is substituted into the {0} placeholder in the search filter. For example, if this option is set to (uid={0}) and the received username is janedoe , the search filter becomes (uid=janedoe) after string substitution. It will result in matching an entry like uid=janedoe , ou=Users , ou=corp , dc=corp , dc=example , dc=com .
roleName String: The group name attribute in a role entry whose value is the name of that role. For example, you can specify cn for a group entry's common name. If authentication succeeds, then the user is assigned the the value of the cn attribute for each role entry that they are a member of.
roleSearchSubtree Boolean: The directory search scope for the role. If set to true, scope is to search the entire subtree.
serviceAccountPassword String: Service account password. A service account is an account in your LDAP server that has access to initiate a connection. For example, cn=admin , dc=corp , dc=example , dc=com .
userRoleName String: The name of the LDAP attribute in the user's directory entry for the user's group membership. In some cases, user roles may be identified by the value of an attribute in the user's directory entry. The UserRoleName option allows you to provide the name of this attribute.
userSearchSubtree Boolean: The directory search scope for the user. If set to true, scope is to search the entire subtree.

BrokerLogList, BrokerLogListArgs

Audit bool: Enables audit logging. Every user management action made using JMX or the ActiveMQ Web Console is logged. Does not apply to RabbitMQ brokers.
General bool: Enables general logging.

Audit bool: Enables audit logging. Every user management action made using JMX or the ActiveMQ Web Console is logged. Does not apply to RabbitMQ brokers.
General bool: Enables general logging.

audit Boolean: Enables audit logging. Every user management action made using JMX or the ActiveMQ Web Console is logged. Does not apply to RabbitMQ brokers.
general Boolean: Enables general logging.

audit boolean: Enables audit logging. Every user management action made using JMX or the ActiveMQ Web Console is logged. Does not apply to RabbitMQ brokers.
general boolean: Enables general logging.

audit bool: Enables audit logging. Every user management action made using JMX or the ActiveMQ Web Console is logged. Does not apply to RabbitMQ brokers.
general bool: Enables general logging.

audit Boolean: Enables audit logging. Every user management action made using JMX or the ActiveMQ Web Console is logged. Does not apply to RabbitMQ brokers.
general Boolean: Enables general logging.

BrokerMaintenanceWindow, BrokerMaintenanceWindowArgs

DayOfWeek Pulumi.AwsNative.AmazonMq.BrokerMaintenanceWindowDayOfWeek | string: Allowed Values: MONDAY | TUESDAY | WEDNESDAY | THURSDAY | FRIDAY | SATURDAY | SUNDAY
TimeOfDay string: The time, in 24-hour format, and use only numbers separated by a colon, HH:MM or HH:MM:SS. Example: 13:05. When writing YAML this may need to be quoted to prevent a timestamp being read and converted to a number of minutes or seconds.
TimeZone string: The time zone, UTC by default, in either the Country/City format, or the UTC offset format.

DayOfWeek BrokerMaintenanceWindowDayOfWeek | string: Allowed Values: MONDAY | TUESDAY | WEDNESDAY | THURSDAY | FRIDAY | SATURDAY | SUNDAY
TimeOfDay string: The time, in 24-hour format, and use only numbers separated by a colon, HH:MM or HH:MM:SS. Example: 13:05. When writing YAML this may need to be quoted to prevent a timestamp being read and converted to a number of minutes or seconds.
TimeZone string: The time zone, UTC by default, in either the Country/City format, or the UTC offset format.

dayOfWeek BrokerMaintenanceWindowDayOfWeek | String: Allowed Values: MONDAY | TUESDAY | WEDNESDAY | THURSDAY | FRIDAY | SATURDAY | SUNDAY
timeOfDay String: The time, in 24-hour format, and use only numbers separated by a colon, HH:MM or HH:MM:SS. Example: 13:05. When writing YAML this may need to be quoted to prevent a timestamp being read and converted to a number of minutes or seconds.
timeZone String: The time zone, UTC by default, in either the Country/City format, or the UTC offset format.

dayOfWeek BrokerMaintenanceWindowDayOfWeek | string: Allowed Values: MONDAY | TUESDAY | WEDNESDAY | THURSDAY | FRIDAY | SATURDAY | SUNDAY
timeOfDay string: The time, in 24-hour format, and use only numbers separated by a colon, HH:MM or HH:MM:SS. Example: 13:05. When writing YAML this may need to be quoted to prevent a timestamp being read and converted to a number of minutes or seconds.
timeZone string: The time zone, UTC by default, in either the Country/City format, or the UTC offset format.

day_of_week BrokerMaintenanceWindowDayOfWeek | str: Allowed Values: MONDAY | TUESDAY | WEDNESDAY | THURSDAY | FRIDAY | SATURDAY | SUNDAY
time_of_day str: The time, in 24-hour format, and use only numbers separated by a colon, HH:MM or HH:MM:SS. Example: 13:05. When writing YAML this may need to be quoted to prevent a timestamp being read and converted to a number of minutes or seconds.
time_zone str: The time zone, UTC by default, in either the Country/City format, or the UTC offset format.

dayOfWeek "MONDAY" | "TUESDAY" | "WEDNESDAY" | "THURSDAY" | "FRIDAY" | "SATURDAY" | "SUNDAY" | String: Allowed Values: MONDAY | TUESDAY | WEDNESDAY | THURSDAY | FRIDAY | SATURDAY | SUNDAY
timeOfDay String: The time, in 24-hour format, and use only numbers separated by a colon, HH:MM or HH:MM:SS. Example: 13:05. When writing YAML this may need to be quoted to prevent a timestamp being read and converted to a number of minutes or seconds.
timeZone String: The time zone, UTC by default, in either the Country/City format, or the UTC offset format.

BrokerMaintenanceWindowDayOfWeek, BrokerMaintenanceWindowDayOfWeekArgs

Monday: MONDAY
Tuesday: TUESDAY
Wednesday: WEDNESDAY
Thursday: THURSDAY
Friday: FRIDAY
Saturday: SATURDAY
Sunday: SUNDAY

BrokerMaintenanceWindowDayOfWeekMonday: MONDAY
BrokerMaintenanceWindowDayOfWeekTuesday: TUESDAY
BrokerMaintenanceWindowDayOfWeekWednesday: WEDNESDAY
BrokerMaintenanceWindowDayOfWeekThursday: THURSDAY
BrokerMaintenanceWindowDayOfWeekFriday: FRIDAY
BrokerMaintenanceWindowDayOfWeekSaturday: SATURDAY
BrokerMaintenanceWindowDayOfWeekSunday: SUNDAY

Monday: MONDAY
Tuesday: TUESDAY
Wednesday: WEDNESDAY
Thursday: THURSDAY
Friday: FRIDAY
Saturday: SATURDAY
Sunday: SUNDAY

Monday: MONDAY
Tuesday: TUESDAY
Wednesday: WEDNESDAY
Thursday: THURSDAY
Friday: FRIDAY
Saturday: SATURDAY
Sunday: SUNDAY

MONDAY: MONDAY
TUESDAY: TUESDAY
WEDNESDAY: WEDNESDAY
THURSDAY: THURSDAY
FRIDAY: FRIDAY
SATURDAY: SATURDAY
SUNDAY: SUNDAY

"MONDAY": MONDAY
"TUESDAY": TUESDAY
"WEDNESDAY": WEDNESDAY
"THURSDAY": THURSDAY
"FRIDAY": FRIDAY
"SATURDAY": SATURDAY
"SUNDAY": SUNDAY

BrokerStorageType, BrokerStorageTypeArgs

Ebs: EBS
Efs: EFS

BrokerStorageTypeEbs: EBS
BrokerStorageTypeEfs: EFS

Ebs: EBS
Efs: EFS

Ebs: EBS
Efs: EFS

EBS: EBS
EFS: EFS

"EBS": EBS
"EFS": EFS

BrokerUser, BrokerUserArgs

Password string: The password of the user. This value must be at least 12 characters long, must contain at least 4 unique characters, and must not contain commas, colons, or equal signs (,:=).
Username string: The username of the broker user. For Amazon MQ for ActiveMQ brokers, this value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). For Amazon MQ for RabbitMQ brokers, this value can contain only alphanumeric characters, dashes, periods, underscores (- . _). This value must not contain a tilde (~) character. Amazon MQ prohibts using guest as a valid usename. This value must be 2-100 characters long.
Do not add personally identifiable information (PII) or other confidential or sensitive information in broker usernames. Broker usernames are accessible to other AWS services, including CloudWatch Logs . Broker usernames are not intended to be used for private or sensitive data.
ConsoleAccess bool: Enables access to the ActiveMQ web console for the ActiveMQ user. Does not apply to RabbitMQ brokers.
Groups List<string>: The list of groups (20 maximum) to which the ActiveMQ user belongs. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long. Does not apply to RabbitMQ brokers.
ReplicationUser bool: Defines if this user is intended for CRDR replication purposes.

Password string: The password of the user. This value must be at least 12 characters long, must contain at least 4 unique characters, and must not contain commas, colons, or equal signs (,:=).
Username string: The username of the broker user. For Amazon MQ for ActiveMQ brokers, this value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). For Amazon MQ for RabbitMQ brokers, this value can contain only alphanumeric characters, dashes, periods, underscores (- . _). This value must not contain a tilde (~) character. Amazon MQ prohibts using guest as a valid usename. This value must be 2-100 characters long.
Do not add personally identifiable information (PII) or other confidential or sensitive information in broker usernames. Broker usernames are accessible to other AWS services, including CloudWatch Logs . Broker usernames are not intended to be used for private or sensitive data.
ConsoleAccess bool: Enables access to the ActiveMQ web console for the ActiveMQ user. Does not apply to RabbitMQ brokers.
Groups []string: The list of groups (20 maximum) to which the ActiveMQ user belongs. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long. Does not apply to RabbitMQ brokers.
ReplicationUser bool: Defines if this user is intended for CRDR replication purposes.

password String: The password of the user. This value must be at least 12 characters long, must contain at least 4 unique characters, and must not contain commas, colons, or equal signs (,:=).
username String: The username of the broker user. For Amazon MQ for ActiveMQ brokers, this value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). For Amazon MQ for RabbitMQ brokers, this value can contain only alphanumeric characters, dashes, periods, underscores (- . _). This value must not contain a tilde (~) character. Amazon MQ prohibts using guest as a valid usename. This value must be 2-100 characters long.
Do not add personally identifiable information (PII) or other confidential or sensitive information in broker usernames. Broker usernames are accessible to other AWS services, including CloudWatch Logs . Broker usernames are not intended to be used for private or sensitive data.
consoleAccess Boolean: Enables access to the ActiveMQ web console for the ActiveMQ user. Does not apply to RabbitMQ brokers.
groups List<String>: The list of groups (20 maximum) to which the ActiveMQ user belongs. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long. Does not apply to RabbitMQ brokers.
replicationUser Boolean: Defines if this user is intended for CRDR replication purposes.

password string: The password of the user. This value must be at least 12 characters long, must contain at least 4 unique characters, and must not contain commas, colons, or equal signs (,:=).
username string: The username of the broker user. For Amazon MQ for ActiveMQ brokers, this value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). For Amazon MQ for RabbitMQ brokers, this value can contain only alphanumeric characters, dashes, periods, underscores (- . _). This value must not contain a tilde (~) character. Amazon MQ prohibts using guest as a valid usename. This value must be 2-100 characters long.
Do not add personally identifiable information (PII) or other confidential or sensitive information in broker usernames. Broker usernames are accessible to other AWS services, including CloudWatch Logs . Broker usernames are not intended to be used for private or sensitive data.
consoleAccess boolean: Enables access to the ActiveMQ web console for the ActiveMQ user. Does not apply to RabbitMQ brokers.
groups string[]: The list of groups (20 maximum) to which the ActiveMQ user belongs. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long. Does not apply to RabbitMQ brokers.
replicationUser boolean: Defines if this user is intended for CRDR replication purposes.

password str: The password of the user. This value must be at least 12 characters long, must contain at least 4 unique characters, and must not contain commas, colons, or equal signs (,:=).
username str: The username of the broker user. For Amazon MQ for ActiveMQ brokers, this value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). For Amazon MQ for RabbitMQ brokers, this value can contain only alphanumeric characters, dashes, periods, underscores (- . _). This value must not contain a tilde (~) character. Amazon MQ prohibts using guest as a valid usename. This value must be 2-100 characters long.
Do not add personally identifiable information (PII) or other confidential or sensitive information in broker usernames. Broker usernames are accessible to other AWS services, including CloudWatch Logs . Broker usernames are not intended to be used for private or sensitive data.
console_access bool: Enables access to the ActiveMQ web console for the ActiveMQ user. Does not apply to RabbitMQ brokers.
groups Sequence[str]: The list of groups (20 maximum) to which the ActiveMQ user belongs. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long. Does not apply to RabbitMQ brokers.
replication_user bool: Defines if this user is intended for CRDR replication purposes.

password String: The password of the user. This value must be at least 12 characters long, must contain at least 4 unique characters, and must not contain commas, colons, or equal signs (,:=).
username String: The username of the broker user. For Amazon MQ for ActiveMQ brokers, this value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). For Amazon MQ for RabbitMQ brokers, this value can contain only alphanumeric characters, dashes, periods, underscores (- . _). This value must not contain a tilde (~) character. Amazon MQ prohibts using guest as a valid usename. This value must be 2-100 characters long.
Do not add personally identifiable information (PII) or other confidential or sensitive information in broker usernames. Broker usernames are accessible to other AWS services, including CloudWatch Logs . Broker usernames are not intended to be used for private or sensitive data.
consoleAccess Boolean: Enables access to the ActiveMQ web console for the ActiveMQ user. Does not apply to RabbitMQ brokers.
groups List<String>: The list of groups (20 maximum) to which the ActiveMQ user belongs. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long. Does not apply to RabbitMQ brokers.
replicationUser Boolean: Defines if this user is intended for CRDR replication purposes.

Tag, TagArgs

Key string: The key name of the tag
Value string: The value of the tag

Key string: The key name of the tag
Value string: The value of the tag

key String: The key name of the tag
value String: The value of the tag

key string: The key name of the tag
value string: The value of the tag

key str: The key name of the tag
value str: The value of the tag

key String: The key name of the tag
value String: The value of the tag

Package Details

Repository: AWS Native pulumi/pulumi-aws-native
License: Apache-2.0

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.36.0 published on Friday, Oct 3, 2025 by Pulumi

pulumi/pulumi-aws-native

aws-native.amazonmq.Broker

On this page

On this page

Example Usage

Example

Example

Example

Example

Example

Example

Create Broker Resource

Constructor syntax

Parameters

Broker Resource Properties

Inputs

Outputs

Supporting Types

BrokerAuthenticationStrategy, BrokerAuthenticationStrategyArgs

BrokerConfigurationId, BrokerConfigurationIdArgs

BrokerDataReplicationMode, BrokerDataReplicationModeArgs

BrokerDeploymentMode, BrokerDeploymentModeArgs

BrokerEncryptionOptions, BrokerEncryptionOptionsArgs

BrokerEngineType, BrokerEngineTypeArgs

BrokerLdapServerMetadata, BrokerLdapServerMetadataArgs

BrokerLogList, BrokerLogListArgs

BrokerMaintenanceWindow, BrokerMaintenanceWindowArgs

BrokerMaintenanceWindowDayOfWeek, BrokerMaintenanceWindowDayOfWeekArgs

BrokerStorageType, BrokerStorageTypeArgs

BrokerUser, BrokerUserArgs

Tag, TagArgs

Package Details

On this page

On this page