GetBroker

Provides information about a MQ Broker.

Example Usage

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
    public MyStack()
    {
        var config = new Config();
        var brokerId = config.Get("brokerId") ?? "";
        var brokerName = config.Get("brokerName") ?? "";
        var byId = Output.Create(Aws.Mq.GetBroker.InvokeAsync(new Aws.Mq.GetBrokerArgs
        {
            BrokerId = brokerId,
        }));
        var byName = Output.Create(Aws.Mq.GetBroker.InvokeAsync(new Aws.Mq.GetBrokerArgs
        {
            BrokerName = brokerName,
        }));
    }

}
package main

import (
    "github.com/pulumi/pulumi-aws/sdk/v2/go/aws/mq"
    "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        opt0 := brokerId
        _, err := mq.LookupBroker(ctx, &mq.LookupBrokerArgs{
            BrokerId: &opt0,
        }, nil)
        if err != nil {
            return err
        }
        opt1 := brokerName
        _, err = mq.LookupBroker(ctx, &mq.LookupBrokerArgs{
            BrokerName: &opt1,
        }, nil)
        if err != nil {
            return err
        }
        return nil
    })
}
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)
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 = pulumi.output(aws.mq.getBroker({
    brokerId: brokerId,
}, { async: true }));
const byName = pulumi.output(aws.mq.getBroker({
    brokerName: brokerName,
}, { async: true }));

Using GetBroker

function getBroker(args: GetBrokerArgs, opts?: InvokeOptions): Promise<GetBrokerResult>
function  get_broker(broker_id=None, broker_name=None, logs=None, tags=None, opts=None)
func LookupBroker(ctx *Context, args *LookupBrokerArgs, opts ...InvokeOption) (*LookupBrokerResult, error)

Note: This function is named LookupBroker in the Go SDK.

public static class GetBroker {
    public static Task<GetBrokerResult> InvokeAsync(GetBrokerArgs args, InvokeOptions? opts = null)
}

The following arguments are supported:

BrokerId string

The unique id of the mq broker.

BrokerName string

The unique name of the mq broker.

Logs GetBrokerLogsArgs
Tags Dictionary<string, string>
BrokerId string

The unique id of the mq broker.

BrokerName string

The unique name of the mq broker.

Logs GetBrokerLogs
Tags map[string]string
brokerId string

The unique id of the mq broker.

brokerName string

The unique name of the mq broker.

logs GetBrokerLogs
tags {[key: string]: string}
broker_id str

The unique id of the mq broker.

broker_name str

The unique name of the mq broker.

logs Dict[GetBrokerLogs]
tags Dict[str, str]

GetBroker Result

The following output properties are available:

Arn string
AutoMinorVersionUpgrade bool
BrokerId string
BrokerName string
Configuration GetBrokerConfiguration
DeploymentMode string
EncryptionOptions List<GetBrokerEncryptionOption>
EngineType string
EngineVersion string
HostInstanceType string
Id string

The provider-assigned unique ID for this managed resource.

Instances List<GetBrokerInstance>
MaintenanceWindowStartTime GetBrokerMaintenanceWindowStartTime
PubliclyAccessible bool
SecurityGroups List<string>
SubnetIds List<string>
Tags Dictionary<string, string>
Users List<GetBrokerUser>
Logs GetBrokerLogs
Arn string
AutoMinorVersionUpgrade bool
BrokerId string
BrokerName string
Configuration GetBrokerConfiguration
DeploymentMode string
EncryptionOptions []GetBrokerEncryptionOption
EngineType string
EngineVersion string
HostInstanceType string
Id string

The provider-assigned unique ID for this managed resource.

Instances []GetBrokerInstance
MaintenanceWindowStartTime GetBrokerMaintenanceWindowStartTime
PubliclyAccessible bool
SecurityGroups []string
SubnetIds []string
Tags map[string]string
Users []GetBrokerUser
Logs GetBrokerLogs
arn string
autoMinorVersionUpgrade boolean
brokerId string
brokerName string
configuration GetBrokerConfiguration
deploymentMode string
encryptionOptions GetBrokerEncryptionOption[]
engineType string
engineVersion string
hostInstanceType string
id string

The provider-assigned unique ID for this managed resource.

instances GetBrokerInstance[]
maintenanceWindowStartTime GetBrokerMaintenanceWindowStartTime
publiclyAccessible boolean
securityGroups string[]
subnetIds string[]
tags {[key: string]: string}
users GetBrokerUser[]
logs GetBrokerLogs
arn str
auto_minor_version_upgrade bool
broker_id str
broker_name str
configuration Dict[GetBrokerConfiguration]
deployment_mode str
encryption_options List[GetBrokerEncryptionOption]
engine_type str
engine_version str
host_instance_type str
id str

The provider-assigned unique ID for this managed resource.

instances List[GetBrokerInstance]
maintenance_window_start_time Dict[GetBrokerMaintenanceWindowStartTime]
publicly_accessible bool
security_groups List[str]
subnet_ids List[str]
tags Dict[str, str]
users List[GetBrokerUser]
logs Dict[GetBrokerLogs]

Supporting Types

GetBrokerConfiguration

See the output API doc for this type.

See the output API doc for this type.

See the output API doc for this type.

Id string
Revision int
Id string
Revision int
id string
revision number
id str
revision float

GetBrokerEncryptionOption

See the output API doc for this type.

See the output API doc for this type.

See the output API doc for this type.

KmsKeyId string
UseAwsOwnedKey bool
KmsKeyId string
UseAwsOwnedKey bool
kmsKeyId string
useAwsOwnedKey boolean
kms_key_id str
useAwsOwnedKey bool

GetBrokerInstance

See the output API doc for this type.

See the output API doc for this type.

See the output API doc for this type.

ConsoleUrl string
Endpoints List<string>
IpAddress string
ConsoleUrl string
Endpoints []string
IpAddress string
consoleUrl string
endpoints string[]
ipAddress string
consoleUrl str
endpoints List[str]
ip_address str

GetBrokerLogs

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

Audit bool
General bool
Audit bool
General bool
audit boolean
general boolean
audit bool
general bool

GetBrokerMaintenanceWindowStartTime

See the output API doc for this type.

See the output API doc for this type.

See the output API doc for this type.

DayOfWeek string
TimeOfDay string
TimeZone string
DayOfWeek string
TimeOfDay string
TimeZone string
dayOfWeek string
timeOfDay string
timeZone string
dayOfWeek str
timeOfDay str
timeZone str

GetBrokerUser

See the output API doc for this type.

See the output API doc for this type.

See the output API doc for this type.

ConsoleAccess bool
Groups List<string>
Username string
ConsoleAccess bool
Groups []string
Username string
consoleAccess boolean
groups string[]
username string
consoleAccess bool
groups List[str]
username str

Package Details

Repository
https://github.com/pulumi/pulumi-aws
License
Apache-2.0
Notes
This Pulumi package is based on the aws Terraform Provider.