AWS Classic v5.41.0, May 15 23
AWS Classic v5.41.0, May 15 23
aws.mq.Broker
Explore with Pulumi AI
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
, audit logging, orconfiguration
blocks. 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
oruser
, 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 theapply_immediately
flag to instruct the service to apply the change immediately (see documentation below). Usingapply_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.15.9",
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/v5/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.15.9"),
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.15.9")
.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.15.9",
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.15.9",
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.15.9
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.15.9",
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/v5/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.15.9"),
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.15.9")
.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.15.9",
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.15.9",
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.15.9
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:
- Engine
Type string Type of broker engine. Valid values are
ActiveMQ
andRabbitMQ
.- Engine
Version string Version of the broker engine. See the AmazonMQ Broker Engine docs for supported versions. For example,
5.15.0
.- Host
Instance stringType Broker's instance type. For example,
mq.t3.micro
,mq.m5.large
.- Users
List<Broker
User Args> Configuration block for broker users. For
engine_type
ofRabbitMQ
, Amazon MQ does not return broker users preventing this resource from making user updates and drift detection. Detailed below.- Apply
Immediately bool Specifies whether any broker modifications are applied immediately, or during the next maintenance window. Default is
false
.- Authentication
Strategy string Authentication strategy used to secure the broker. Valid values are
simple
andldap
.ldap
is not supported forengine_type
RabbitMQ
.- Auto
Minor boolVersion Upgrade Whether to automatically upgrade to new minor versions of brokers as Amazon MQ makes releases available.
- Broker
Name string Name of the broker.
- Configuration
Broker
Configuration Args Configuration block for broker configuration. Applies to
engine_type
ofActiveMQ
only. Detailed below.- Deployment
Mode string Deployment mode of the broker. Valid values are
SINGLE_INSTANCE
,ACTIVE_STANDBY_MULTI_AZ
, andCLUSTER_MULTI_AZ
. Default isSINGLE_INSTANCE
.- Encryption
Options BrokerEncryption Options Args Configuration block containing encryption options. Detailed below.
- Ldap
Server BrokerMetadata Ldap Server Metadata Args 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
Broker
Logs Args Configuration block for the logging configuration of the broker. Detailed below.
- Maintenance
Window BrokerStart Time Maintenance Window Start Time Args 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 List<string> List of security group IDs assigned to the broker.
- Storage
Type string Storage type of the broker. For
engine_type
ActiveMQ
, the valid values areefs
andebs
, and the AWS-default isefs
. Forengine_type
RabbitMQ
, onlyebs
is supported. When usingebs
, only themq.m5
broker instance type family is supported.- Subnet
Ids List<string> List of subnet IDs in which to launch the broker. A
SINGLE_INSTANCE
deployment requires one subnet. AnACTIVE_STANDBY_MULTI_AZ
deployment requires multiple subnets.- 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.
- Engine
Type string Type of broker engine. Valid values are
ActiveMQ
andRabbitMQ
.- Engine
Version string Version of the broker engine. See the AmazonMQ Broker Engine docs for supported versions. For example,
5.15.0
.- Host
Instance stringType Broker's instance type. For example,
mq.t3.micro
,mq.m5.large
.- Users
[]Broker
User Args Configuration block for broker users. For
engine_type
ofRabbitMQ
, Amazon MQ does not return broker users preventing this resource from making user updates and drift detection. Detailed below.- Apply
Immediately bool Specifies whether any broker modifications are applied immediately, or during the next maintenance window. Default is
false
.- Authentication
Strategy string Authentication strategy used to secure the broker. Valid values are
simple
andldap
.ldap
is not supported forengine_type
RabbitMQ
.- Auto
Minor boolVersion Upgrade Whether to automatically upgrade to new minor versions of brokers as Amazon MQ makes releases available.
- Broker
Name string Name of the broker.
- Configuration
Broker
Configuration Args Configuration block for broker configuration. Applies to
engine_type
ofActiveMQ
only. Detailed below.- Deployment
Mode string Deployment mode of the broker. Valid values are
SINGLE_INSTANCE
,ACTIVE_STANDBY_MULTI_AZ
, andCLUSTER_MULTI_AZ
. Default isSINGLE_INSTANCE
.- Encryption
Options BrokerEncryption Options Args Configuration block containing encryption options. Detailed below.
- Ldap
Server BrokerMetadata Ldap Server Metadata Args 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
Broker
Logs Args Configuration block for the logging configuration of the broker. Detailed below.
- Maintenance
Window BrokerStart Time Maintenance Window Start Time Args 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 []string List of security group IDs assigned to the broker.
- Storage
Type string Storage type of the broker. For
engine_type
ActiveMQ
, the valid values areefs
andebs
, and the AWS-default isefs
. Forengine_type
RabbitMQ
, onlyebs
is supported. When usingebs
, only themq.m5
broker instance type family is supported.- Subnet
Ids []string List of subnet IDs in which to launch the broker. A
SINGLE_INSTANCE
deployment requires one subnet. AnACTIVE_STANDBY_MULTI_AZ
deployment requires multiple subnets.- 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.
- engine
Type String Type of broker engine. Valid values are
ActiveMQ
andRabbitMQ
.- engine
Version String Version of the broker engine. See the AmazonMQ Broker Engine docs for supported versions. For example,
5.15.0
.- host
Instance StringType Broker's instance type. For example,
mq.t3.micro
,mq.m5.large
.- users
List<Broker
User Args> Configuration block for broker users. For
engine_type
ofRabbitMQ
, Amazon MQ does not return broker users preventing this resource from making user updates and drift detection. Detailed below.- apply
Immediately Boolean Specifies whether any broker modifications are applied immediately, or during the next maintenance window. Default is
false
.- authentication
Strategy String Authentication strategy used to secure the broker. Valid values are
simple
andldap
.ldap
is not supported forengine_type
RabbitMQ
.- auto
Minor BooleanVersion Upgrade Whether to automatically upgrade to new minor versions of brokers as Amazon MQ makes releases available.
- broker
Name String Name of the broker.
- configuration
Broker
Configuration Args Configuration block for broker configuration. Applies to
engine_type
ofActiveMQ
only. Detailed below.- deployment
Mode String Deployment mode of the broker. Valid values are
SINGLE_INSTANCE
,ACTIVE_STANDBY_MULTI_AZ
, andCLUSTER_MULTI_AZ
. Default isSINGLE_INSTANCE
.- encryption
Options BrokerEncryption Options Args Configuration block containing encryption options. Detailed below.
- ldap
Server BrokerMetadata Ldap Server Metadata Args 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
Broker
Logs Args Configuration block for the logging configuration of the broker. Detailed below.
- maintenance
Window BrokerStart Time Maintenance Window Start Time Args Configuration block for the maintenance window start time. Detailed below.
- publicly
Accessible Boolean Whether to enable connections from applications outside of the VPC that hosts the broker's subnets.
- security
Groups List<String> List of security group IDs assigned to the broker.
- storage
Type String Storage type of the broker. For
engine_type
ActiveMQ
, the valid values areefs
andebs
, and the AWS-default isefs
. Forengine_type
RabbitMQ
, onlyebs
is supported. When usingebs
, only themq.m5
broker instance type family is supported.- subnet
Ids List<String> List of subnet IDs in which to launch the broker. A
SINGLE_INSTANCE
deployment requires one subnet. AnACTIVE_STANDBY_MULTI_AZ
deployment requires multiple subnets.- 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.
- engine
Type string Type of broker engine. Valid values are
ActiveMQ
andRabbitMQ
.- engine
Version string Version of the broker engine. See the AmazonMQ Broker Engine docs for supported versions. For example,
5.15.0
.- host
Instance stringType Broker's instance type. For example,
mq.t3.micro
,mq.m5.large
.- users
Broker
User Args[] Configuration block for broker users. For
engine_type
ofRabbitMQ
, Amazon MQ does not return broker users preventing this resource from making user updates and drift detection. Detailed below.- apply
Immediately boolean Specifies whether any broker modifications are applied immediately, or during the next maintenance window. Default is
false
.- authentication
Strategy string Authentication strategy used to secure the broker. Valid values are
simple
andldap
.ldap
is not supported forengine_type
RabbitMQ
.- auto
Minor booleanVersion Upgrade Whether to automatically upgrade to new minor versions of brokers as Amazon MQ makes releases available.
- broker
Name string Name of the broker.
- configuration
Broker
Configuration Args Configuration block for broker configuration. Applies to
engine_type
ofActiveMQ
only. Detailed below.- deployment
Mode string Deployment mode of the broker. Valid values are
SINGLE_INSTANCE
,ACTIVE_STANDBY_MULTI_AZ
, andCLUSTER_MULTI_AZ
. Default isSINGLE_INSTANCE
.- encryption
Options BrokerEncryption Options Args Configuration block containing encryption options. Detailed below.
- ldap
Server BrokerMetadata Ldap Server Metadata Args 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
Broker
Logs Args Configuration block for the logging configuration of the broker. Detailed below.
- maintenance
Window BrokerStart Time Maintenance Window Start Time Args Configuration block for the maintenance window start time. Detailed below.
- publicly
Accessible boolean Whether to enable connections from applications outside of the VPC that hosts the broker's subnets.
- security
Groups string[] List of security group IDs assigned to the broker.
- storage
Type string Storage type of the broker. For
engine_type
ActiveMQ
, the valid values areefs
andebs
, and the AWS-default isefs
. Forengine_type
RabbitMQ
, onlyebs
is supported. When usingebs
, only themq.m5
broker instance type family is supported.- subnet
Ids string[] List of subnet IDs in which to launch the broker. A
SINGLE_INSTANCE
deployment requires one subnet. AnACTIVE_STANDBY_MULTI_AZ
deployment requires multiple subnets.- {[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
andRabbitMQ
.- engine_
version str Version of the broker engine. See the AmazonMQ Broker Engine docs for supported versions. For example,
5.15.0
.- host_
instance_ strtype Broker's instance type. For example,
mq.t3.micro
,mq.m5.large
.- users
Sequence[Broker
User Args] Configuration block for broker users. For
engine_type
ofRabbitMQ
, Amazon MQ does not return broker users preventing this resource from making user updates and drift detection. Detailed below.- 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
andldap
.ldap
is not supported forengine_type
RabbitMQ
.- auto_
minor_ boolversion_ upgrade Whether to automatically upgrade to new minor versions of brokers as Amazon MQ makes releases available.
- broker_
name str Name of the broker.
- configuration
Broker
Configuration Args Configuration block for broker configuration. Applies to
engine_type
ofActiveMQ
only. Detailed below.- deployment_
mode str Deployment mode of the broker. Valid values are
SINGLE_INSTANCE
,ACTIVE_STANDBY_MULTI_AZ
, andCLUSTER_MULTI_AZ
. Default isSINGLE_INSTANCE
.- encryption_
options BrokerEncryption Options Args Configuration block containing encryption options. Detailed below.
- ldap_
server_ Brokermetadata Ldap Server Metadata Args 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
Broker
Logs Args Configuration block for the logging configuration of the broker. Detailed below.
- maintenance_
window_ Brokerstart_ time Maintenance Window Start Time Args 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 areefs
andebs
, and the AWS-default isefs
. Forengine_type
RabbitMQ
, onlyebs
is supported. When usingebs
, only themq.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. AnACTIVE_STANDBY_MULTI_AZ
deployment requires multiple subnets.- 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.
- engine
Type String Type of broker engine. Valid values are
ActiveMQ
andRabbitMQ
.- engine
Version String Version of the broker engine. See the AmazonMQ Broker Engine docs for supported versions. For example,
5.15.0
.- host
Instance StringType Broker's instance type. For example,
mq.t3.micro
,mq.m5.large
.- users List<Property Map>
Configuration block for broker users. For
engine_type
ofRabbitMQ
, Amazon MQ does not return broker users preventing this resource from making user updates and drift detection. Detailed below.- apply
Immediately Boolean Specifies whether any broker modifications are applied immediately, or during the next maintenance window. Default is
false
.- authentication
Strategy String Authentication strategy used to secure the broker. Valid values are
simple
andldap
.ldap
is not supported forengine_type
RabbitMQ
.- auto
Minor BooleanVersion Upgrade Whether to automatically upgrade to new minor versions of brokers as Amazon MQ makes releases available.
- broker
Name String Name of the broker.
- configuration Property Map
Configuration block for broker configuration. Applies to
engine_type
ofActiveMQ
only. Detailed below.- deployment
Mode String Deployment mode of the broker. Valid values are
SINGLE_INSTANCE
,ACTIVE_STANDBY_MULTI_AZ
, andCLUSTER_MULTI_AZ
. Default isSINGLE_INSTANCE
.- encryption
Options Property Map Configuration block containing encryption options. Detailed below.
- ldap
Server Property MapMetadata 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.
- maintenance
Window Property MapStart Time Configuration block for the maintenance window start time. Detailed below.
- publicly
Accessible Boolean Whether to enable connections from applications outside of the VPC that hosts the broker's subnets.
- security
Groups List<String> List of security group IDs assigned to the broker.
- storage
Type String Storage type of the broker. For
engine_type
ActiveMQ
, the valid values areefs
andebs
, and the AWS-default isefs
. Forengine_type
RabbitMQ
, onlyebs
is supported. When usingebs
, only themq.m5
broker instance type family is supported.- subnet
Ids List<String> List of subnet IDs in which to launch the broker. A
SINGLE_INSTANCE
deployment requires one subnet. AnACTIVE_STANDBY_MULTI_AZ
deployment requires multiple subnets.- 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<Broker
Instance> 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 onengine_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., asinstances.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
- Dictionary<string, string>
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- Arn string
ARN of the broker.
- Id string
The provider-assigned unique ID for this managed resource.
- Instances
[]Broker
Instance 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 onengine_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., asinstances.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
- map[string]string
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- arn String
ARN of the broker.
- id String
The provider-assigned unique ID for this managed resource.
- instances
List<Broker
Instance> 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 onengine_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., asinstances.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
- Map<String,String>
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- arn string
ARN of the broker.
- id string
The provider-assigned unique ID for this managed resource.
- instances
Broker
Instance[] 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 onengine_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., asinstances.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
- {[key: string]: string}
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- arn str
ARN of the broker.
- id str
The provider-assigned unique ID for this managed resource.
- instances
Sequence[Broker
Instance] 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 onengine_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., asinstances.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
- Mapping[str, str]
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- 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 onengine_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., asinstances.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
- Map<String>
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
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.
- Apply
Immediately bool Specifies whether any broker modifications are applied immediately, or during the next maintenance window. Default is
false
.- Arn string
ARN of the broker.
- Authentication
Strategy string Authentication strategy used to secure the broker. Valid values are
simple
andldap
.ldap
is not supported forengine_type
RabbitMQ
.- Auto
Minor boolVersion Upgrade Whether to automatically upgrade to new minor versions of brokers as Amazon MQ makes releases available.
- Broker
Name string Name of the broker.
- Configuration
Broker
Configuration Args Configuration block for broker configuration. Applies to
engine_type
ofActiveMQ
only. Detailed below.- Deployment
Mode string Deployment mode of the broker. Valid values are
SINGLE_INSTANCE
,ACTIVE_STANDBY_MULTI_AZ
, andCLUSTER_MULTI_AZ
. Default isSINGLE_INSTANCE
.- Encryption
Options BrokerEncryption Options Args Configuration block containing encryption options. Detailed below.
- Engine
Type string Type of broker engine. Valid values are
ActiveMQ
andRabbitMQ
.- Engine
Version string Version of the broker engine. See the AmazonMQ Broker Engine docs for supported versions. For example,
5.15.0
.- Host
Instance stringType Broker's instance type. For example,
mq.t3.micro
,mq.m5.large
.- Instances
List<Broker
Instance Args> 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 onengine_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., asinstances.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 BrokerMetadata Ldap Server Metadata Args 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
Broker
Logs Args Configuration block for the logging configuration of the broker. Detailed below.
- Maintenance
Window BrokerStart Time Maintenance Window Start Time Args 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 List<string> List of security group IDs assigned to the broker.
- Storage
Type string Storage type of the broker. For
engine_type
ActiveMQ
, the valid values areefs
andebs
, and the AWS-default isefs
. Forengine_type
RabbitMQ
, onlyebs
is supported. When usingebs
, only themq.m5
broker instance type family is supported.- Subnet
Ids List<string> List of subnet IDs in which to launch the broker. A
SINGLE_INSTANCE
deployment requires one subnet. AnACTIVE_STANDBY_MULTI_AZ
deployment requires multiple subnets.- 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.- Dictionary<string, string>
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.- Users
List<Broker
User Args> Configuration block for broker users. For
engine_type
ofRabbitMQ
, Amazon MQ does not return broker users preventing this resource from making user updates and drift detection. Detailed below.
- Apply
Immediately bool Specifies whether any broker modifications are applied immediately, or during the next maintenance window. Default is
false
.- Arn string
ARN of the broker.
- Authentication
Strategy string Authentication strategy used to secure the broker. Valid values are
simple
andldap
.ldap
is not supported forengine_type
RabbitMQ
.- Auto
Minor boolVersion Upgrade Whether to automatically upgrade to new minor versions of brokers as Amazon MQ makes releases available.
- Broker
Name string Name of the broker.
- Configuration
Broker
Configuration Args Configuration block for broker configuration. Applies to
engine_type
ofActiveMQ
only. Detailed below.- Deployment
Mode string Deployment mode of the broker. Valid values are
SINGLE_INSTANCE
,ACTIVE_STANDBY_MULTI_AZ
, andCLUSTER_MULTI_AZ
. Default isSINGLE_INSTANCE
.- Encryption
Options BrokerEncryption Options Args Configuration block containing encryption options. Detailed below.
- Engine
Type string Type of broker engine. Valid values are
ActiveMQ
andRabbitMQ
.- Engine
Version string Version of the broker engine. See the AmazonMQ Broker Engine docs for supported versions. For example,
5.15.0
.- Host
Instance stringType Broker's instance type. For example,
mq.t3.micro
,mq.m5.large
.- Instances
[]Broker
Instance Args 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 onengine_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., asinstances.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 BrokerMetadata Ldap Server Metadata Args 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
Broker
Logs Args Configuration block for the logging configuration of the broker. Detailed below.
- Maintenance
Window BrokerStart Time Maintenance Window Start Time Args 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 []string List of security group IDs assigned to the broker.
- Storage
Type string Storage type of the broker. For
engine_type
ActiveMQ
, the valid values areefs
andebs
, and the AWS-default isefs
. Forengine_type
RabbitMQ
, onlyebs
is supported. When usingebs
, only themq.m5
broker instance type family is supported.- Subnet
Ids []string List of subnet IDs in which to launch the broker. A
SINGLE_INSTANCE
deployment requires one subnet. AnACTIVE_STANDBY_MULTI_AZ
deployment requires multiple subnets.- 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.- map[string]string
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.- Users
[]Broker
User Args Configuration block for broker users. For
engine_type
ofRabbitMQ
, Amazon MQ does not return broker users preventing this resource from making user updates and drift detection. Detailed below.
- apply
Immediately Boolean Specifies whether any broker modifications are applied immediately, or during the next maintenance window. Default is
false
.- arn String
ARN of the broker.
- authentication
Strategy String Authentication strategy used to secure the broker. Valid values are
simple
andldap
.ldap
is not supported forengine_type
RabbitMQ
.- auto
Minor BooleanVersion Upgrade Whether to automatically upgrade to new minor versions of brokers as Amazon MQ makes releases available.
- broker
Name String Name of the broker.
- configuration
Broker
Configuration Args Configuration block for broker configuration. Applies to
engine_type
ofActiveMQ
only. Detailed below.- deployment
Mode String Deployment mode of the broker. Valid values are
SINGLE_INSTANCE
,ACTIVE_STANDBY_MULTI_AZ
, andCLUSTER_MULTI_AZ
. Default isSINGLE_INSTANCE
.- encryption
Options BrokerEncryption Options Args Configuration block containing encryption options. Detailed below.
- engine
Type String Type of broker engine. Valid values are
ActiveMQ
andRabbitMQ
.- engine
Version String Version of the broker engine. See the AmazonMQ Broker Engine docs for supported versions. For example,
5.15.0
.- host
Instance StringType Broker's instance type. For example,
mq.t3.micro
,mq.m5.large
.- instances
List<Broker
Instance Args> 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 onengine_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., asinstances.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 BrokerMetadata Ldap Server Metadata Args 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
Broker
Logs Args Configuration block for the logging configuration of the broker. Detailed below.
- maintenance
Window BrokerStart Time Maintenance Window Start Time Args Configuration block for the maintenance window start time. Detailed below.
- publicly
Accessible Boolean Whether to enable connections from applications outside of the VPC that hosts the broker's subnets.
- security
Groups List<String> List of security group IDs assigned to the broker.
- storage
Type String Storage type of the broker. For
engine_type
ActiveMQ
, the valid values areefs
andebs
, and the AWS-default isefs
. Forengine_type
RabbitMQ
, onlyebs
is supported. When usingebs
, only themq.m5
broker instance type family is supported.- subnet
Ids List<String> List of subnet IDs in which to launch the broker. A
SINGLE_INSTANCE
deployment requires one subnet. AnACTIVE_STANDBY_MULTI_AZ
deployment requires multiple subnets.- 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.- Map<String,String>
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.- users
List<Broker
User Args> Configuration block for broker users. For
engine_type
ofRabbitMQ
, Amazon MQ does not return broker users preventing this resource from making user updates and drift detection. Detailed below.
- apply
Immediately boolean Specifies whether any broker modifications are applied immediately, or during the next maintenance window. Default is
false
.- arn string
ARN of the broker.
- authentication
Strategy string Authentication strategy used to secure the broker. Valid values are
simple
andldap
.ldap
is not supported forengine_type
RabbitMQ
.- auto
Minor booleanVersion Upgrade Whether to automatically upgrade to new minor versions of brokers as Amazon MQ makes releases available.
- broker
Name string Name of the broker.
- configuration
Broker
Configuration Args Configuration block for broker configuration. Applies to
engine_type
ofActiveMQ
only. Detailed below.- deployment
Mode string Deployment mode of the broker. Valid values are
SINGLE_INSTANCE
,ACTIVE_STANDBY_MULTI_AZ
, andCLUSTER_MULTI_AZ
. Default isSINGLE_INSTANCE
.- encryption
Options BrokerEncryption Options Args Configuration block containing encryption options. Detailed below.
- engine
Type string Type of broker engine. Valid values are
ActiveMQ
andRabbitMQ
.- engine
Version string Version of the broker engine. See the AmazonMQ Broker Engine docs for supported versions. For example,
5.15.0
.- host
Instance stringType Broker's instance type. For example,
mq.t3.micro
,mq.m5.large
.- instances
Broker
Instance Args[] 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 onengine_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., asinstances.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 BrokerMetadata Ldap Server Metadata Args 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
Broker
Logs Args Configuration block for the logging configuration of the broker. Detailed below.
- maintenance
Window BrokerStart Time Maintenance Window Start Time Args Configuration block for the maintenance window start time. Detailed below.
- publicly
Accessible boolean Whether to enable connections from applications outside of the VPC that hosts the broker's subnets.
- security
Groups string[] List of security group IDs assigned to the broker.
- storage
Type string Storage type of the broker. For
engine_type
ActiveMQ
, the valid values areefs
andebs
, and the AWS-default isefs
. Forengine_type
RabbitMQ
, onlyebs
is supported. When usingebs
, only themq.m5
broker instance type family is supported.- subnet
Ids string[] List of subnet IDs in which to launch the broker. A
SINGLE_INSTANCE
deployment requires one subnet. AnACTIVE_STANDBY_MULTI_AZ
deployment requires multiple subnets.- {[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.- {[key: string]: string}
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.- users
Broker
User Args[] Configuration block for broker users. For
engine_type
ofRabbitMQ
, Amazon MQ does not return broker users preventing this resource from making user updates and drift detection. Detailed below.
- 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
andldap
.ldap
is not supported forengine_type
RabbitMQ
.- auto_
minor_ boolversion_ upgrade Whether to automatically upgrade to new minor versions of brokers as Amazon MQ makes releases available.
- broker_
name str Name of the broker.
- configuration
Broker
Configuration Args Configuration block for broker configuration. Applies to
engine_type
ofActiveMQ
only. Detailed below.- deployment_
mode str Deployment mode of the broker. Valid values are
SINGLE_INSTANCE
,ACTIVE_STANDBY_MULTI_AZ
, andCLUSTER_MULTI_AZ
. Default isSINGLE_INSTANCE
.- encryption_
options BrokerEncryption Options Args Configuration block containing encryption options. Detailed below.
- engine_
type str Type of broker engine. Valid values are
ActiveMQ
andRabbitMQ
.- engine_
version str Version of the broker engine. See the AmazonMQ Broker Engine docs for supported versions. For example,
5.15.0
.- host_
instance_ strtype Broker's instance type. For example,
mq.t3.micro
,mq.m5.large
.- instances
Sequence[Broker
Instance Args] 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 onengine_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., asinstances.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_ Brokermetadata Ldap Server Metadata Args 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
Broker
Logs Args Configuration block for the logging configuration of the broker. Detailed below.
- maintenance_
window_ Brokerstart_ time Maintenance Window Start Time Args 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 areefs
andebs
, and the AWS-default isefs
. Forengine_type
RabbitMQ
, onlyebs
is supported. When usingebs
, only themq.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. AnACTIVE_STANDBY_MULTI_AZ
deployment requires multiple subnets.- 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.- Mapping[str, str]
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.- users
Sequence[Broker
User Args] Configuration block for broker users. For
engine_type
ofRabbitMQ
, Amazon MQ does not return broker users preventing this resource from making user updates and drift detection. Detailed below.
- apply
Immediately Boolean Specifies whether any broker modifications are applied immediately, or during the next maintenance window. Default is
false
.- arn String
ARN of the broker.
- authentication
Strategy String Authentication strategy used to secure the broker. Valid values are
simple
andldap
.ldap
is not supported forengine_type
RabbitMQ
.- auto
Minor BooleanVersion Upgrade Whether to automatically upgrade to new minor versions of brokers as Amazon MQ makes releases available.
- broker
Name String Name of the broker.
- configuration Property Map
Configuration block for broker configuration. Applies to
engine_type
ofActiveMQ
only. Detailed below.- deployment
Mode String Deployment mode of the broker. Valid values are
SINGLE_INSTANCE
,ACTIVE_STANDBY_MULTI_AZ
, andCLUSTER_MULTI_AZ
. Default isSINGLE_INSTANCE
.- encryption
Options Property Map Configuration block containing encryption options. Detailed below.
- engine
Type String Type of broker engine. Valid values are
ActiveMQ
andRabbitMQ
.- engine
Version String Version of the broker engine. See the AmazonMQ Broker Engine docs for supported versions. For example,
5.15.0
.- host
Instance StringType 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 onengine_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., asinstances.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 Property MapMetadata 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.
- maintenance
Window Property MapStart Time Configuration block for the maintenance window start time. Detailed below.
- publicly
Accessible Boolean Whether to enable connections from applications outside of the VPC that hosts the broker's subnets.
- security
Groups List<String> List of security group IDs assigned to the broker.
- storage
Type String Storage type of the broker. For
engine_type
ActiveMQ
, the valid values areefs
andebs
, and the AWS-default isefs
. Forengine_type
RabbitMQ
, onlyebs
is supported. When usingebs
, only themq.m5
broker instance type family is supported.- subnet
Ids List<String> List of subnet IDs in which to launch the broker. A
SINGLE_INSTANCE
deployment requires one subnet. AnACTIVE_STANDBY_MULTI_AZ
deployment requires multiple subnets.- 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.- Map<String>
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.- users List<Property Map>
Configuration block for broker users. For
engine_type
ofRabbitMQ
, Amazon MQ does not return broker users preventing this resource from making user updates and drift detection. Detailed below.
Supporting Types
BrokerConfiguration
BrokerEncryptionOptions
- Kms
Key stringId 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
tofalse
. To perform drift detection when AWS-managed CMKs or customer-managed CMKs are in use, this value must be configured.- Use
Aws boolOwned Key Whether to enable an AWS-owned KMS CMK that is not in your account. Defaults to
true
. Setting tofalse
without configuringkms_key_id
will create an AWS-managed CMK aliased toaws/mq
in your account.
- Kms
Key stringId 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
tofalse
. To perform drift detection when AWS-managed CMKs or customer-managed CMKs are in use, this value must be configured.- Use
Aws boolOwned Key Whether to enable an AWS-owned KMS CMK that is not in your account. Defaults to
true
. Setting tofalse
without configuringkms_key_id
will create an AWS-managed CMK aliased toaws/mq
in your account.
- kms
Key StringId 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
tofalse
. To perform drift detection when AWS-managed CMKs or customer-managed CMKs are in use, this value must be configured.- use
Aws BooleanOwned Key Whether to enable an AWS-owned KMS CMK that is not in your account. Defaults to
true
. Setting tofalse
without configuringkms_key_id
will create an AWS-managed CMK aliased toaws/mq
in your account.
- kms
Key stringId 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
tofalse
. To perform drift detection when AWS-managed CMKs or customer-managed CMKs are in use, this value must be configured.- use
Aws booleanOwned Key Whether to enable an AWS-owned KMS CMK that is not in your account. Defaults to
true
. Setting tofalse
without configuringkms_key_id
will create an AWS-managed CMK aliased toaws/mq
in your account.
- kms_
key_ strid 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
tofalse
. To perform drift detection when AWS-managed CMKs or customer-managed CMKs are in use, this value must be configured.- use_
aws_ boolowned_ key Whether to enable an AWS-owned KMS CMK that is not in your account. Defaults to
true
. Setting tofalse
without configuringkms_key_id
will create an AWS-managed CMK aliased toaws/mq
in your account.
- kms
Key StringId 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
tofalse
. To perform drift detection when AWS-managed CMKs or customer-managed CMKs are in use, this value must be configured.- use
Aws BooleanOwned Key Whether to enable an AWS-owned KMS CMK that is not in your account. Defaults to
true
. Setting tofalse
without configuringkms_key_id
will create an AWS-managed CMK aliased toaws/mq
in your account.
BrokerInstance
- Console
Url string - Endpoints List<string>
- Ip
Address string
- Console
Url string - Endpoints []string
- Ip
Address string
- console
Url String - endpoints List<String>
- ip
Address String
- console
Url string - endpoints string[]
- ip
Address string
- console_
url str - endpoints Sequence[str]
- ip_
address str
- console
Url String - endpoints List<String>
- ip
Address String
BrokerLdapServerMetadata
- Hosts List<string>
List of a fully qualified domain name of the LDAP server and an optional failover server.
- Role
Base string Fully qualified name of the directory to search for a user’s groups.
- Role
Name string Specifies the LDAP attribute that identifies the group name attribute in the object returned from the group membership query.
- Role
Search stringMatching Search criteria for groups.
- Role
Search boolSubtree Whether the directory search scope is the entire sub-tree.
- Service
Account stringPassword Service account password.
- Service
Account stringUsername Service account username.
- User
Base string Fully qualified name of the directory where you want to search for users.
- User
Role stringName Specifies the name of the LDAP attribute for the user group membership.
- User
Search stringMatching Search criteria for users.
- User
Search boolSubtree 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.
- Role
Base string Fully qualified name of the directory to search for a user’s groups.
- Role
Name string Specifies the LDAP attribute that identifies the group name attribute in the object returned from the group membership query.
- Role
Search stringMatching Search criteria for groups.
- Role
Search boolSubtree Whether the directory search scope is the entire sub-tree.
- Service
Account stringPassword Service account password.
- Service
Account stringUsername Service account username.
- User
Base string Fully qualified name of the directory where you want to search for users.
- User
Role stringName Specifies the name of the LDAP attribute for the user group membership.
- User
Search stringMatching Search criteria for users.
- User
Search boolSubtree 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.
- role
Base String Fully qualified name of the directory to search for a user’s groups.
- role
Name String Specifies the LDAP attribute that identifies the group name attribute in the object returned from the group membership query.
- role
Search StringMatching Search criteria for groups.
- role
Search BooleanSubtree Whether the directory search scope is the entire sub-tree.
- service
Account StringPassword Service account password.
- service
Account StringUsername Service account username.
- user
Base String Fully qualified name of the directory where you want to search for users.
- user
Role StringName Specifies the name of the LDAP attribute for the user group membership.
- user
Search StringMatching Search criteria for users.
- user
Search BooleanSubtree 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.
- role
Base string Fully qualified name of the directory to search for a user’s groups.
- role
Name string Specifies the LDAP attribute that identifies the group name attribute in the object returned from the group membership query.
- role
Search stringMatching Search criteria for groups.
- role
Search booleanSubtree Whether the directory search scope is the entire sub-tree.
- service
Account stringPassword Service account password.
- service
Account stringUsername Service account username.
- user
Base string Fully qualified name of the directory where you want to search for users.
- user
Role stringName Specifies the name of the LDAP attribute for the user group membership.
- user
Search stringMatching Search criteria for users.
- user
Search booleanSubtree 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_ strmatching Search criteria for groups.
- role_
search_ boolsubtree Whether the directory search scope is the entire sub-tree.
- service_
account_ strpassword Service account password.
- service_
account_ strusername Service account username.
- user_
base str Fully qualified name of the directory where you want to search for users.
- user_
role_ strname Specifies the name of the LDAP attribute for the user group membership.
- user_
search_ strmatching Search criteria for users.
- user_
search_ boolsubtree 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.
- role
Base String Fully qualified name of the directory to search for a user’s groups.
- role
Name String Specifies the LDAP attribute that identifies the group name attribute in the object returned from the group membership query.
- role
Search StringMatching Search criteria for groups.
- role
Search BooleanSubtree Whether the directory search scope is the entire sub-tree.
- service
Account StringPassword Service account password.
- service
Account StringUsername Service account username.
- user
Base String Fully qualified name of the directory where you want to search for users.
- user
Role StringName Specifies the name of the LDAP attribute for the user group membership.
- user
Search StringMatching Search criteria for users.
- user
Search BooleanSubtree Whether the directory search scope is the entire sub-tree.
BrokerLogs
BrokerMaintenanceWindowStartTime
- day_
of_ strweek Day of the week, e.g.,
MONDAY
,TUESDAY
, orWEDNESDAY
.- time_
of_ strday 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
.
BrokerUser
- 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.
- Console
Access bool Whether to enable access to the ActiveMQ Web Console for the user. Applies to
engine_type
ofActiveMQ
only.- Groups List<string>
List of groups (20 maximum) to which the ActiveMQ user belongs. Applies to
engine_type
ofActiveMQ
only.
- 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.
- Console
Access bool Whether to enable access to the ActiveMQ Web Console for the user. Applies to
engine_type
ofActiveMQ
only.- Groups []string
List of groups (20 maximum) to which the ActiveMQ user belongs. Applies to
engine_type
ofActiveMQ
only.
- 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.
- console
Access Boolean Whether to enable access to the ActiveMQ Web Console for the user. Applies to
engine_type
ofActiveMQ
only.- groups List<String>
List of groups (20 maximum) to which the ActiveMQ user belongs. Applies to
engine_type
ofActiveMQ
only.
- 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.
- console
Access boolean Whether to enable access to the ActiveMQ Web Console for the user. Applies to
engine_type
ofActiveMQ
only.- groups string[]
List of groups (20 maximum) to which the ActiveMQ user belongs. Applies to
engine_type
ofActiveMQ
only.
- 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.
- console_
access bool Whether to enable access to the ActiveMQ Web Console for the user. Applies to
engine_type
ofActiveMQ
only.- groups Sequence[str]
List of groups (20 maximum) to which the ActiveMQ user belongs. Applies to
engine_type
ofActiveMQ
only.
- 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.
- console
Access Boolean Whether to enable access to the ActiveMQ Web Console for the user. Applies to
engine_type
ofActiveMQ
only.- groups List<String>
List of groups (20 maximum) to which the ActiveMQ user belongs. Applies to
engine_type
ofActiveMQ
only.
Import
MQ Brokers can be imported using their broker id, e.g.,
$ 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.