AWS v6.77.1 published on Friday, Apr 18, 2025 by Pulumi
aws.mq.getBroker
Explore with Pulumi AI
Provides information about a MQ Broker.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const config = new pulumi.Config();
const brokerId = config.get("brokerId") || "";
const brokerName = config.get("brokerName") || "";
const byId = aws.mq.getBroker({
    brokerId: brokerId,
});
const byName = aws.mq.getBroker({
    brokerName: brokerName,
});
import pulumi
import pulumi_aws as aws
config = pulumi.Config()
broker_id = config.get("brokerId")
if broker_id is None:
    broker_id = ""
broker_name = config.get("brokerName")
if broker_name is None:
    broker_name = ""
by_id = aws.mq.get_broker(broker_id=broker_id)
by_name = aws.mq.get_broker(broker_name=broker_name)
package main
import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/mq"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		cfg := config.New(ctx, "")
		brokerId := ""
		if param := cfg.Get("brokerId"); param != "" {
			brokerId = param
		}
		brokerName := ""
		if param := cfg.Get("brokerName"); param != "" {
			brokerName = param
		}
		_, err := mq.LookupBroker(ctx, &mq.LookupBrokerArgs{
			BrokerId: pulumi.StringRef(brokerId),
		}, nil)
		if err != nil {
			return err
		}
		_, err = mq.LookupBroker(ctx, &mq.LookupBrokerArgs{
			BrokerName: pulumi.StringRef(brokerName),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() => 
{
    var config = new Config();
    var brokerId = config.Get("brokerId") ?? "";
    var brokerName = config.Get("brokerName") ?? "";
    var byId = Aws.Mq.GetBroker.Invoke(new()
    {
        BrokerId = brokerId,
    });
    var byName = Aws.Mq.GetBroker.Invoke(new()
    {
        BrokerName = brokerName,
    });
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.mq.MqFunctions;
import com.pulumi.aws.mq.inputs.GetBrokerArgs;
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) {
        final var config = ctx.config();
        final var brokerId = config.get("brokerId").orElse("");
        final var brokerName = config.get("brokerName").orElse("");
        final var byId = MqFunctions.getBroker(GetBrokerArgs.builder()
            .brokerId(brokerId)
            .build());
        final var byName = MqFunctions.getBroker(GetBrokerArgs.builder()
            .brokerName(brokerName)
            .build());
    }
}
configuration:
  brokerId:
    type: string
    default: ""
  brokerName:
    type: string
    default: ""
variables:
  byId:
    fn::invoke:
      function: aws:mq:getBroker
      arguments:
        brokerId: ${brokerId}
  byName:
    fn::invoke:
      function: aws:mq:getBroker
      arguments:
        brokerName: ${brokerName}
Using getBroker
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getBroker(args: GetBrokerArgs, opts?: InvokeOptions): Promise<GetBrokerResult>
function getBrokerOutput(args: GetBrokerOutputArgs, opts?: InvokeOptions): Output<GetBrokerResult>def get_broker(broker_id: Optional[str] = None,
               broker_name: Optional[str] = None,
               tags: Optional[Mapping[str, str]] = None,
               opts: Optional[InvokeOptions] = None) -> GetBrokerResult
def get_broker_output(broker_id: Optional[pulumi.Input[str]] = None,
               broker_name: Optional[pulumi.Input[str]] = None,
               tags: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
               opts: Optional[InvokeOptions] = None) -> Output[GetBrokerResult]func LookupBroker(ctx *Context, args *LookupBrokerArgs, opts ...InvokeOption) (*LookupBrokerResult, error)
func LookupBrokerOutput(ctx *Context, args *LookupBrokerOutputArgs, opts ...InvokeOption) LookupBrokerResultOutput> Note: This function is named LookupBroker in the Go SDK.
public static class GetBroker 
{
    public static Task<GetBrokerResult> InvokeAsync(GetBrokerArgs args, InvokeOptions? opts = null)
    public static Output<GetBrokerResult> Invoke(GetBrokerInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetBrokerResult> getBroker(GetBrokerArgs args, InvokeOptions options)
public static Output<GetBrokerResult> getBroker(GetBrokerArgs args, InvokeOptions options)
fn::invoke:
  function: aws:mq/getBroker:getBroker
  arguments:
    # arguments dictionaryThe following arguments are supported:
- Broker
Id string - Unique id of the mq broker.
 - Broker
Name string - Unique name of the mq broker.
 - Dictionary<string, string>
 
- Broker
Id string - Unique id of the mq broker.
 - Broker
Name string - Unique name of the mq broker.
 - map[string]string
 
- broker
Id String - Unique id of the mq broker.
 - broker
Name String - Unique name of the mq broker.
 - Map<String,String>
 
- broker
Id string - Unique id of the mq broker.
 - broker
Name string - Unique name of the mq broker.
 - {[key: string]: string}
 
- broker_
id str - Unique id of the mq broker.
 - broker_
name str - Unique name of the mq broker.
 - Mapping[str, str]
 
- broker
Id String - Unique id of the mq broker.
 - broker
Name String - Unique name of the mq broker.
 - Map<String>
 
getBroker Result
The following output properties are available:
- Arn string
 - Authentication
Strategy string - Auto
Minor boolVersion Upgrade  - Broker
Id string - Broker
Name string - Configuration
Get
Broker Configuration  - Deployment
Mode string - Encryption
Options List<GetBroker Encryption Option>  - Engine
Type string - Engine
Version string - Host
Instance stringType  - Id string
 - The provider-assigned unique ID for this managed resource.
 - Instances
List<Get
Broker Instance>  - Ldap
Server List<GetMetadatas Broker Ldap Server Metadata>  - Logs
Get
Broker Logs  - Maintenance
Window GetStart Time Broker Maintenance Window Start Time  - Publicly
Accessible bool - Security
Groups List<string> - Storage
Type string - Subnet
Ids List<string> - Dictionary<string, string>
 - Users
List<Get
Broker User>  
- Arn string
 - Authentication
Strategy string - Auto
Minor boolVersion Upgrade  - Broker
Id string - Broker
Name string - Configuration
Get
Broker Configuration  - Deployment
Mode string - Encryption
Options []GetBroker Encryption Option  - Engine
Type string - Engine
Version string - Host
Instance stringType  - Id string
 - The provider-assigned unique ID for this managed resource.
 - Instances
[]Get
Broker Instance  - Ldap
Server []GetMetadatas Broker Ldap Server Metadata  - Logs
Get
Broker Logs  - Maintenance
Window GetStart Time Broker Maintenance Window Start Time  - Publicly
Accessible bool - Security
Groups []string - Storage
Type string - Subnet
Ids []string - map[string]string
 - Users
[]Get
Broker User  
- arn String
 - authentication
Strategy String - auto
Minor BooleanVersion Upgrade  - broker
Id String - broker
Name String - configuration
Get
Broker Configuration  - deployment
Mode String - encryption
Options List<GetBroker Encryption Option>  - engine
Type String - engine
Version String - host
Instance StringType  - id String
 - The provider-assigned unique ID for this managed resource.
 - instances
List<Get
Broker Instance>  - ldap
Server List<GetMetadatas Broker Ldap Server Metadata>  - logs
Get
Broker Logs  - maintenance
Window GetStart Time Broker Maintenance Window Start Time  - publicly
Accessible Boolean - security
Groups List<String> - storage
Type String - subnet
Ids List<String> - Map<String,String>
 - users
List<Get
Broker User>  
- arn string
 - authentication
Strategy string - auto
Minor booleanVersion Upgrade  - broker
Id string - broker
Name string - configuration
Get
Broker Configuration  - deployment
Mode string - encryption
Options GetBroker Encryption Option[]  - engine
Type string - engine
Version string - host
Instance stringType  - id string
 - The provider-assigned unique ID for this managed resource.
 - instances
Get
Broker Instance[]  - ldap
Server GetMetadatas Broker Ldap Server Metadata[]  - logs
Get
Broker Logs  - maintenance
Window GetStart Time Broker Maintenance Window Start Time  - publicly
Accessible boolean - security
Groups string[] - storage
Type string - subnet
Ids string[] - {[key: string]: string}
 - users
Get
Broker User[]  
- arn str
 - authentication_
strategy str - auto_
minor_ boolversion_ upgrade  - broker_
id str - broker_
name str - configuration
Get
Broker Configuration  - deployment_
mode str - encryption_
options Sequence[GetBroker Encryption Option]  - engine_
type str - engine_
version str - host_
instance_ strtype  - id str
 - The provider-assigned unique ID for this managed resource.
 - instances
Sequence[Get
Broker Instance]  - ldap_
server_ Sequence[Getmetadatas Broker Ldap Server Metadata]  - logs
Get
Broker Logs  - maintenance_
window_ Getstart_ time Broker Maintenance Window Start Time  - publicly_
accessible bool - security_
groups Sequence[str] - storage_
type str - subnet_
ids Sequence[str] - Mapping[str, str]
 - users
Sequence[Get
Broker User]  
- arn String
 - authentication
Strategy String - auto
Minor BooleanVersion Upgrade  - broker
Id String - broker
Name String - configuration Property Map
 - deployment
Mode String - encryption
Options List<Property Map> - engine
Type String - engine
Version String - host
Instance StringType  - id String
 - The provider-assigned unique ID for this managed resource.
 - instances List<Property Map>
 - ldap
Server List<Property Map>Metadatas  - logs Property Map
 - maintenance
Window Property MapStart Time  - publicly
Accessible Boolean - security
Groups List<String> - storage
Type String - subnet
Ids List<String> - Map<String>
 - users List<Property Map>
 
Supporting Types
GetBrokerConfiguration  
GetBrokerEncryptionOption   
- Kms
Key stringId  - Use
Aws boolOwned Key  
- Kms
Key stringId  - Use
Aws boolOwned Key  
- kms
Key StringId  - use
Aws BooleanOwned Key  
- kms
Key stringId  - use
Aws booleanOwned Key  
- kms_
key_ strid  - use_
aws_ boolowned_ key  
- kms
Key StringId  - use
Aws BooleanOwned Key  
GetBrokerInstance  
- 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 
GetBrokerLdapServerMetadata    
- Hosts List<string>
 - Role
Base string - Role
Name string - Role
Search stringMatching  - Role
Search boolSubtree  - Service
Account stringPassword  - Service
Account stringUsername  - User
Base string - User
Role stringName  - User
Search stringMatching  - User
Search boolSubtree  
- Hosts []string
 - Role
Base string - Role
Name string - Role
Search stringMatching  - Role
Search boolSubtree  - Service
Account stringPassword  - Service
Account stringUsername  - User
Base string - User
Role stringName  - User
Search stringMatching  - User
Search boolSubtree  
- hosts List<String>
 - role
Base String - role
Name String - role
Search StringMatching  - role
Search BooleanSubtree  - service
Account StringPassword  - service
Account StringUsername  - user
Base String - user
Role StringName  - user
Search StringMatching  - user
Search BooleanSubtree  
- hosts string[]
 - role
Base string - role
Name string - role
Search stringMatching  - role
Search booleanSubtree  - service
Account stringPassword  - service
Account stringUsername  - user
Base string - user
Role stringName  - user
Search stringMatching  - user
Search booleanSubtree  
- hosts Sequence[str]
 - role_
base str - role_
name str - role_
search_ strmatching  - role_
search_ boolsubtree  - service_
account_ strpassword  - service_
account_ strusername  - user_
base str - user_
role_ strname  - user_
search_ strmatching  - user_
search_ boolsubtree  
- hosts List<String>
 - role
Base String - role
Name String - role
Search StringMatching  - role
Search BooleanSubtree  - service
Account StringPassword  - service
Account StringUsername  - user
Base String - user
Role StringName  - user
Search StringMatching  - user
Search BooleanSubtree  
GetBrokerLogs  
GetBrokerMaintenanceWindowStartTime     
- day_
of_ strweek  - time_
of_ strday  - time_
zone str 
GetBrokerUser  
- Console
Access bool - Groups List<string>
 - Replication
User bool - Username string
 
- Console
Access bool - Groups []string
 - Replication
User bool - Username string
 
- console
Access Boolean - groups List<String>
 - replication
User Boolean - username String
 
- console
Access boolean - groups string[]
 - replication
User boolean - username string
 
- console_
access bool - groups Sequence[str]
 - replication_
user bool - username str
 
- console
Access Boolean - groups List<String>
 - replication
User Boolean - username String
 
Package Details
- Repository
 - AWS Classic pulumi/pulumi-aws
 - License
 - Apache-2.0
 - Notes
 - This Pulumi package is based on the 
awsTerraform Provider.