Docs Packages
  1. Packages
  2. AWS Classic
  3. API Docs
  4. mq
  5. Broker

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.13.0 published on Saturday, Dec 2, 2023 by Pulumi
pulumi/pulumi-aws

aws.mq.Broker

Explore with Pulumi AI

aws logo

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.13.0 published on Saturday, Dec 2, 2023 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

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

return await Deployment.RunAsync(() => 
{
    var example = new Aws.Mq.Broker("example", new()
    {
        Configuration = new Aws.Mq.Inputs.BrokerConfigurationArgs
        {
            Id = aws_mq_configuration.Test.Id,
            Revision = aws_mq_configuration.Test.Latest_revision,
        },
        EngineType = "ActiveMQ",
        EngineVersion = "5.17.6",
        HostInstanceType = "mq.t2.micro",
        SecurityGroups = new[]
        {
            aws_security_group.Test.Id,
        },
        Users = new[]
        {
            new Aws.Mq.Inputs.BrokerUserArgs
            {
                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{
			Configuration: &mq.BrokerConfigurationArgs{
				Id:       pulumi.Any(aws_mq_configuration.Test.Id),
				Revision: pulumi.Any(aws_mq_configuration.Test.Latest_revision),
			},
			EngineType:       pulumi.String("ActiveMQ"),
			EngineVersion:    pulumi.String("5.17.6"),
			HostInstanceType: pulumi.String("mq.t2.micro"),
			SecurityGroups: pulumi.StringArray{
				aws_security_group.Test.Id,
			},
			Users: mq.BrokerUserArray{
				&mq.BrokerUserArgs{
					Username: pulumi.String("ExampleUser"),
					Password: pulumi.String("MindTheGap"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    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()        
            .configuration(BrokerConfigurationArgs.builder()
                .id(aws_mq_configuration.test().id())
                .revision(aws_mq_configuration.test().latest_revision())
                .build())
            .engineType("ActiveMQ")
            .engineVersion("5.17.6")
            .hostInstanceType("mq.t2.micro")
            .securityGroups(aws_security_group.test().id())
            .users(BrokerUserArgs.builder()
                .username("ExampleUser")
                .password("MindTheGap")
                .build())
            .build());

    }
}

    import pulumi
import pulumi_aws as aws

example = aws.mq.Broker("example",
    configuration=aws.mq.BrokerConfigurationArgs(
        id=aws_mq_configuration["test"]["id"],
        revision=aws_mq_configuration["test"]["latest_revision"],
    ),
    engine_type="ActiveMQ",
    engine_version="5.17.6",
    host_instance_type="mq.t2.micro",
    security_groups=[aws_security_group["test"]["id"]],
    users=[aws.mq.BrokerUserArgs(
        username="ExampleUser",
        password="MindTheGap",
    )])

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

const example = new aws.mq.Broker("example", {
    configuration: {
        id: aws_mq_configuration.test.id,
        revision: aws_mq_configuration.test.latest_revision,
    },
    engineType: "ActiveMQ",
    engineVersion: "5.17.6",
    hostInstanceType: "mq.t2.micro",
    securityGroups: [aws_security_group.test.id],
    users: [{
        username: "ExampleUser",
        password: "MindTheGap",
    }],
});

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

    High-throughput Optimized Example

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

return await Deployment.RunAsync(() => 
{
    var example = new Aws.Mq.Broker("example", new()
    {
        Configuration = new Aws.Mq.Inputs.BrokerConfigurationArgs
        {
            Id = aws_mq_configuration.Test.Id,
            Revision = aws_mq_configuration.Test.Latest_revision,
        },
        EngineType = "ActiveMQ",
        EngineVersion = "5.17.6",
        StorageType = "ebs",
        HostInstanceType = "mq.m5.large",
        SecurityGroups = new[]
        {
            aws_security_group.Test.Id,
        },
        Users = new[]
        {
            new Aws.Mq.Inputs.BrokerUserArgs
            {
                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{
			Configuration: &mq.BrokerConfigurationArgs{
				Id:       pulumi.Any(aws_mq_configuration.Test.Id),
				Revision: pulumi.Any(aws_mq_configuration.Test.Latest_revision),
			},
			EngineType:       pulumi.String("ActiveMQ"),
			EngineVersion:    pulumi.String("5.17.6"),
			StorageType:      pulumi.String("ebs"),
			HostInstanceType: pulumi.String("mq.m5.large"),
			SecurityGroups: pulumi.StringArray{
				aws_security_group.Test.Id,
			},
			Users: mq.BrokerUserArray{
				&mq.BrokerUserArgs{
					Username: pulumi.String("ExampleUser"),
					Password: pulumi.String("MindTheGap"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    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()        
            .configuration(BrokerConfigurationArgs.builder()
                .id(aws_mq_configuration.test().id())
                .revision(aws_mq_configuration.test().latest_revision())
                .build())
            .engineType("ActiveMQ")
            .engineVersion("5.17.6")
            .storageType("ebs")
            .hostInstanceType("mq.m5.large")
            .securityGroups(aws_security_group.test().id())
            .users(BrokerUserArgs.builder()
                .username("ExampleUser")
                .password("MindTheGap")
                .build())
            .build());

    }
}

    import pulumi
import pulumi_aws as aws

example = aws.mq.Broker("example",
    configuration=aws.mq.BrokerConfigurationArgs(
        id=aws_mq_configuration["test"]["id"],
        revision=aws_mq_configuration["test"]["latest_revision"],
    ),
    engine_type="ActiveMQ",
    engine_version="5.17.6",
    storage_type="ebs",
    host_instance_type="mq.m5.large",
    security_groups=[aws_security_group["test"]["id"]],
    users=[aws.mq.BrokerUserArgs(
        username="ExampleUser",
        password="MindTheGap",
    )])

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

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

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

    Create Broker Resource

    new Broker(name: string, args: BrokerArgs, opts?: CustomResourceOptions);
    @overload
def Broker(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           apply_immediately: Optional[bool] = None,
           authentication_strategy: Optional[str] = None,
           auto_minor_version_upgrade: Optional[bool] = None,
           broker_name: Optional[str] = None,
           configuration: Optional[BrokerConfigurationArgs] = 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,
           ldap_server_metadata: Optional[BrokerLdapServerMetadataArgs] = None,
           logs: Optional[BrokerLogsArgs] = 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,
           users: Optional[Sequence[BrokerUserArgs]] = None)
@overload
def Broker(resource_name: str,
           args: BrokerArgs,
           opts: Optional[ResourceOptions] = 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.
    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

    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.

    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.

    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.

    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.

    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.

    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.

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

    • instances.0.console_url - The URL of the ActiveMQ Web Console or the RabbitMQ Management UI depending on engine_type.
    • instances.0.ip_address - IP Address of the broker.
    • instances.0.endpoints - 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
    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).

    • instances.0.console_url - The URL of the ActiveMQ Web Console or the RabbitMQ Management UI depending on engine_type.
    • instances.0.ip_address - IP Address of the broker.
    • instances.0.endpoints - 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
    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).

    • instances.0.console_url - The URL of the ActiveMQ Web Console or the RabbitMQ Management UI depending on engine_type.
    • instances.0.ip_address - IP Address of the broker.
    • instances.0.endpoints - 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
    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).

    • instances.0.console_url - The URL of the ActiveMQ Web Console or the RabbitMQ Management UI depending on engine_type.
    • instances.0.ip_address - IP Address of the broker.
    • instances.0.endpoints - 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
    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).

    • instances.0.console_url - The URL of the ActiveMQ Web Console or the RabbitMQ Management UI depending on engine_type.
    • instances.0.ip_address - IP Address of the broker.
    • instances.0.endpoints - 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
    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).

    • instances.0.console_url - The URL of the ActiveMQ Web Console or the RabbitMQ Management UI depending on engine_type.
    • instances.0.ip_address - IP Address of the broker.
    • instances.0.endpoints - 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
    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,
        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,
        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)
    Resource lookup is not supported in YAML
    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.

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

    • instances.0.console_url - The URL of the ActiveMQ Web Console or the RabbitMQ Management UI depending on engine_type.
    • instances.0.ip_address - IP Address of the broker.
    • instances.0.endpoints - 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
    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.

    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.

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

    • instances.0.console_url - The URL of the ActiveMQ Web Console or the RabbitMQ Management UI depending on engine_type.
    • instances.0.ip_address - IP Address of the broker.
    • instances.0.endpoints - 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
    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.

    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.

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

    • instances.0.console_url - The URL of the ActiveMQ Web Console or the RabbitMQ Management UI depending on engine_type.
    • instances.0.ip_address - IP Address of the broker.
    • instances.0.endpoints - 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
    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.

    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.

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

    • instances.0.console_url - The URL of the ActiveMQ Web Console or the RabbitMQ Management UI depending on engine_type.
    • instances.0.ip_address - IP Address of the broker.
    • instances.0.endpoints - 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
    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.

    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.

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

    • instances.0.console_url - The URL of the ActiveMQ Web Console or the RabbitMQ Management UI depending on engine_type.
    • instances.0.ip_address - IP Address of the broker.
    • instances.0.endpoints - 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
    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.

    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.

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

    • instances.0.console_url - The URL of the ActiveMQ Web Console or the RabbitMQ Management UI depending on engine_type.
    • instances.0.ip_address - IP Address of the broker.
    • instances.0.endpoints - 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
    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.

    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
    Endpoints List<string>
    IpAddress string
    ConsoleUrl string
    Endpoints []string
    IpAddress string
    consoleUrl String
    endpoints List<String>
    ipAddress String
    consoleUrl string
    endpoints string[]
    ipAddress string
    console_url str
    endpoints Sequence[str]
    ip_address str
    consoleUrl String
    endpoints List<String>
    ipAddress String

    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

    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

    Try AWS Native preview for resources not in the classic version.

    AWS Classic v6.13.0 published on Saturday, Dec 2, 2023 by Pulumi
    pulumi/pulumi-aws