We recommend new projects start with resources from the AWS provider.
aws-native.amazonmq.getBroker
We recommend new projects start with resources from the AWS provider.
Resource type definition for AWS::AmazonMQ::Broker
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(id: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetBrokerResult
def get_broker_output(id: Optional[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-native:amazonmq:getBroker
arguments:
# arguments dictionaryThe following arguments are supported:
- Id string
- Id string
- id String
- id string
- id str
- id String
getBroker Result
The following output properties are available:
- Amqp
Endpoints List<string> The AMQP endpoints of each broker instance as a list of strings.
amqp+ssl://b-4aada85d-a80c-4be0-9d30-e344a01b921e-1.mq.eu-central-amazonaws.com:5671- Arn string
The Amazon Resource Name (ARN) of the Amazon MQ broker.
arn:aws:mq:us-east-2:123456789012:broker:MyBroker:b-1234a5b6-78cd-901e-2fgh-3i45j6k178l9- Auto
Minor boolVersion Upgrade Enables automatic upgrades to new patch versions for brokers as new versions are released and supported by Amazon MQ. Automatic upgrades occur during the scheduled maintenance window or after a manual broker reboot. Set to
trueby default, if no value is specified.Must be set to
truefor ActiveMQ brokers version 5.18 and above and for RabbitMQ brokers version 3.13 and above.- Configuration
Id string - The ID of the current actual configuration.
- Configuration
Revision string - The revision of the current actual configuration.
- Console
Urls List<string> - Data
Replication Pulumi.Mode Aws | stringNative. Amazon Mq. Broker Data Replication Mode - Defines whether this broker is a part of a data replication pair.
- Engine
Version stringCurrent - The version in use. This may have more precision than the specified EngineVersion.
- Host
Instance stringType - Required. The broker's instance type.
- Id string
- Ip
Addresses List<string> The IP addresses of each broker instance as a list of strings. Does not apply to RabbitMQ brokers.
['198.51.100.2', '203.0.113.9']- Ldap
Server Pulumi.Metadata Aws Native. Amazon Mq. Outputs. Broker Ldap Server Metadata - Optional. The metadata of the LDAP server used to authenticate and authorize connections to the broker. Does not apply to RabbitMQ brokers.
- Logs
Pulumi.
Aws Native. Amazon Mq. Outputs. Broker Log List - Enables Amazon CloudWatch logging for brokers.
- Maintenance
Window Pulumi.Start Time Aws Native. Amazon Mq. Outputs. Broker Maintenance Window - The parameters that determine the WeeklyStartTime.
- Mqtt
Endpoints List<string> The MQTT endpoints of each broker instance as a list of strings.
mqtt+ssl://b-4aada85d-a80c-4be0-9d30-e344a01b921e-1.mq.eu-central-amazonaws.com:8883- Open
Wire List<string>Endpoints The OpenWire endpoints of each broker instance as a list of strings.
ssl://b-4aada85d-a80c-4be0-9d30-e344a01b921e-1.mq.eu-central-amazonaws.com:61617- Security
Groups List<string> - The list of rules (1 minimum, 125 maximum) that authorize connections to brokers.
- Stomp
Endpoints List<string> The STOMP endpoints of each broker instance as a list of strings.
stomp+ssl://b-4aada85d-a80c-4be0-9d30-e344a01b921e-1.mq.eu-central-amazonaws.com:61614-
List<Pulumi.
Aws Native. Outputs. Tag> - Create tags when creating the broker.
- Wss
Endpoints List<string> The WSS endpoints of each broker instance as a list of strings.
wss://b-4aada85d-a80c-4be0-9d30-e344a01b921e-1.mq.eu-central-amazonaws.com:61619
- Amqp
Endpoints []string The AMQP endpoints of each broker instance as a list of strings.
amqp+ssl://b-4aada85d-a80c-4be0-9d30-e344a01b921e-1.mq.eu-central-amazonaws.com:5671- Arn string
The Amazon Resource Name (ARN) of the Amazon MQ broker.
arn:aws:mq:us-east-2:123456789012:broker:MyBroker:b-1234a5b6-78cd-901e-2fgh-3i45j6k178l9- Auto
Minor boolVersion Upgrade Enables automatic upgrades to new patch versions for brokers as new versions are released and supported by Amazon MQ. Automatic upgrades occur during the scheduled maintenance window or after a manual broker reboot. Set to
trueby default, if no value is specified.Must be set to
truefor ActiveMQ brokers version 5.18 and above and for RabbitMQ brokers version 3.13 and above.- Configuration
Id string - The ID of the current actual configuration.
- Configuration
Revision string - The revision of the current actual configuration.
- Console
Urls []string - Data
Replication BrokerMode Data | stringReplication Mode - Defines whether this broker is a part of a data replication pair.
- Engine
Version stringCurrent - The version in use. This may have more precision than the specified EngineVersion.
- Host
Instance stringType - Required. The broker's instance type.
- Id string
- Ip
Addresses []string The IP addresses of each broker instance as a list of strings. Does not apply to RabbitMQ brokers.
['198.51.100.2', '203.0.113.9']- Ldap
Server BrokerMetadata Ldap Server Metadata - Optional. The metadata of the LDAP server used to authenticate and authorize connections to the broker. Does not apply to RabbitMQ brokers.
- Logs
Broker
Log List - Enables Amazon CloudWatch logging for brokers.
- Maintenance
Window BrokerStart Time Maintenance Window - The parameters that determine the WeeklyStartTime.
- Mqtt
Endpoints []string The MQTT endpoints of each broker instance as a list of strings.
mqtt+ssl://b-4aada85d-a80c-4be0-9d30-e344a01b921e-1.mq.eu-central-amazonaws.com:8883- Open
Wire []stringEndpoints The OpenWire endpoints of each broker instance as a list of strings.
ssl://b-4aada85d-a80c-4be0-9d30-e344a01b921e-1.mq.eu-central-amazonaws.com:61617- Security
Groups []string - The list of rules (1 minimum, 125 maximum) that authorize connections to brokers.
- Stomp
Endpoints []string The STOMP endpoints of each broker instance as a list of strings.
stomp+ssl://b-4aada85d-a80c-4be0-9d30-e344a01b921e-1.mq.eu-central-amazonaws.com:61614- Tag
- Create tags when creating the broker.
- Wss
Endpoints []string The WSS endpoints of each broker instance as a list of strings.
wss://b-4aada85d-a80c-4be0-9d30-e344a01b921e-1.mq.eu-central-amazonaws.com:61619
- amqp
Endpoints List<String> The AMQP endpoints of each broker instance as a list of strings.
amqp+ssl://b-4aada85d-a80c-4be0-9d30-e344a01b921e-1.mq.eu-central-amazonaws.com:5671- arn String
The Amazon Resource Name (ARN) of the Amazon MQ broker.
arn:aws:mq:us-east-2:123456789012:broker:MyBroker:b-1234a5b6-78cd-901e-2fgh-3i45j6k178l9- auto
Minor BooleanVersion Upgrade Enables automatic upgrades to new patch versions for brokers as new versions are released and supported by Amazon MQ. Automatic upgrades occur during the scheduled maintenance window or after a manual broker reboot. Set to
trueby default, if no value is specified.Must be set to
truefor ActiveMQ brokers version 5.18 and above and for RabbitMQ brokers version 3.13 and above.- configuration
Id String - The ID of the current actual configuration.
- configuration
Revision String - The revision of the current actual configuration.
- console
Urls List<String> - data
Replication BrokerMode Data | StringReplication Mode - Defines whether this broker is a part of a data replication pair.
- engine
Version StringCurrent - The version in use. This may have more precision than the specified EngineVersion.
- host
Instance StringType - Required. The broker's instance type.
- id String
- ip
Addresses List<String> The IP addresses of each broker instance as a list of strings. Does not apply to RabbitMQ brokers.
['198.51.100.2', '203.0.113.9']- ldap
Server BrokerMetadata Ldap Server Metadata - Optional. The metadata of the LDAP server used to authenticate and authorize connections to the broker. Does not apply to RabbitMQ brokers.
- logs
Broker
Log List - Enables Amazon CloudWatch logging for brokers.
- maintenance
Window BrokerStart Time Maintenance Window - The parameters that determine the WeeklyStartTime.
- mqtt
Endpoints List<String> The MQTT endpoints of each broker instance as a list of strings.
mqtt+ssl://b-4aada85d-a80c-4be0-9d30-e344a01b921e-1.mq.eu-central-amazonaws.com:8883- open
Wire List<String>Endpoints The OpenWire endpoints of each broker instance as a list of strings.
ssl://b-4aada85d-a80c-4be0-9d30-e344a01b921e-1.mq.eu-central-amazonaws.com:61617- security
Groups List<String> - The list of rules (1 minimum, 125 maximum) that authorize connections to brokers.
- stomp
Endpoints List<String> The STOMP endpoints of each broker instance as a list of strings.
stomp+ssl://b-4aada85d-a80c-4be0-9d30-e344a01b921e-1.mq.eu-central-amazonaws.com:61614- List<Tag>
- Create tags when creating the broker.
- wss
Endpoints List<String> The WSS endpoints of each broker instance as a list of strings.
wss://b-4aada85d-a80c-4be0-9d30-e344a01b921e-1.mq.eu-central-amazonaws.com:61619
- amqp
Endpoints string[] The AMQP endpoints of each broker instance as a list of strings.
amqp+ssl://b-4aada85d-a80c-4be0-9d30-e344a01b921e-1.mq.eu-central-amazonaws.com:5671- arn string
The Amazon Resource Name (ARN) of the Amazon MQ broker.
arn:aws:mq:us-east-2:123456789012:broker:MyBroker:b-1234a5b6-78cd-901e-2fgh-3i45j6k178l9- auto
Minor booleanVersion Upgrade Enables automatic upgrades to new patch versions for brokers as new versions are released and supported by Amazon MQ. Automatic upgrades occur during the scheduled maintenance window or after a manual broker reboot. Set to
trueby default, if no value is specified.Must be set to
truefor ActiveMQ brokers version 5.18 and above and for RabbitMQ brokers version 3.13 and above.- configuration
Id string - The ID of the current actual configuration.
- configuration
Revision string - The revision of the current actual configuration.
- console
Urls string[] - data
Replication BrokerMode Data | stringReplication Mode - Defines whether this broker is a part of a data replication pair.
- engine
Version stringCurrent - The version in use. This may have more precision than the specified EngineVersion.
- host
Instance stringType - Required. The broker's instance type.
- id string
- ip
Addresses string[] The IP addresses of each broker instance as a list of strings. Does not apply to RabbitMQ brokers.
['198.51.100.2', '203.0.113.9']- ldap
Server BrokerMetadata Ldap Server Metadata - Optional. The metadata of the LDAP server used to authenticate and authorize connections to the broker. Does not apply to RabbitMQ brokers.
- logs
Broker
Log List - Enables Amazon CloudWatch logging for brokers.
- maintenance
Window BrokerStart Time Maintenance Window - The parameters that determine the WeeklyStartTime.
- mqtt
Endpoints string[] The MQTT endpoints of each broker instance as a list of strings.
mqtt+ssl://b-4aada85d-a80c-4be0-9d30-e344a01b921e-1.mq.eu-central-amazonaws.com:8883- open
Wire string[]Endpoints The OpenWire endpoints of each broker instance as a list of strings.
ssl://b-4aada85d-a80c-4be0-9d30-e344a01b921e-1.mq.eu-central-amazonaws.com:61617- security
Groups string[] - The list of rules (1 minimum, 125 maximum) that authorize connections to brokers.
- stomp
Endpoints string[] The STOMP endpoints of each broker instance as a list of strings.
stomp+ssl://b-4aada85d-a80c-4be0-9d30-e344a01b921e-1.mq.eu-central-amazonaws.com:61614- Tag[]
- Create tags when creating the broker.
- wss
Endpoints string[] The WSS endpoints of each broker instance as a list of strings.
wss://b-4aada85d-a80c-4be0-9d30-e344a01b921e-1.mq.eu-central-amazonaws.com:61619
- amqp_
endpoints Sequence[str] The AMQP endpoints of each broker instance as a list of strings.
amqp+ssl://b-4aada85d-a80c-4be0-9d30-e344a01b921e-1.mq.eu-central-amazonaws.com:5671- arn str
The Amazon Resource Name (ARN) of the Amazon MQ broker.
arn:aws:mq:us-east-2:123456789012:broker:MyBroker:b-1234a5b6-78cd-901e-2fgh-3i45j6k178l9- auto_
minor_ boolversion_ upgrade Enables automatic upgrades to new patch versions for brokers as new versions are released and supported by Amazon MQ. Automatic upgrades occur during the scheduled maintenance window or after a manual broker reboot. Set to
trueby default, if no value is specified.Must be set to
truefor ActiveMQ brokers version 5.18 and above and for RabbitMQ brokers version 3.13 and above.- configuration_
id str - The ID of the current actual configuration.
- configuration_
revision str - The revision of the current actual configuration.
- console_
urls Sequence[str] - data_
replication_ Brokermode Data | strReplication Mode - Defines whether this broker is a part of a data replication pair.
- engine_
version_ strcurrent - The version in use. This may have more precision than the specified EngineVersion.
- host_
instance_ strtype - Required. The broker's instance type.
- id str
- ip_
addresses Sequence[str] The IP addresses of each broker instance as a list of strings. Does not apply to RabbitMQ brokers.
['198.51.100.2', '203.0.113.9']- ldap_
server_ Brokermetadata Ldap Server Metadata - Optional. The metadata of the LDAP server used to authenticate and authorize connections to the broker. Does not apply to RabbitMQ brokers.
- logs
Broker
Log List - Enables Amazon CloudWatch logging for brokers.
- maintenance_
window_ Brokerstart_ time Maintenance Window - The parameters that determine the WeeklyStartTime.
- mqtt_
endpoints Sequence[str] The MQTT endpoints of each broker instance as a list of strings.
mqtt+ssl://b-4aada85d-a80c-4be0-9d30-e344a01b921e-1.mq.eu-central-amazonaws.com:8883- open_
wire_ Sequence[str]endpoints The OpenWire endpoints of each broker instance as a list of strings.
ssl://b-4aada85d-a80c-4be0-9d30-e344a01b921e-1.mq.eu-central-amazonaws.com:61617- security_
groups Sequence[str] - The list of rules (1 minimum, 125 maximum) that authorize connections to brokers.
- stomp_
endpoints Sequence[str] The STOMP endpoints of each broker instance as a list of strings.
stomp+ssl://b-4aada85d-a80c-4be0-9d30-e344a01b921e-1.mq.eu-central-amazonaws.com:61614- Sequence[root_Tag]
- Create tags when creating the broker.
- wss_
endpoints Sequence[str] The WSS endpoints of each broker instance as a list of strings.
wss://b-4aada85d-a80c-4be0-9d30-e344a01b921e-1.mq.eu-central-amazonaws.com:61619
- amqp
Endpoints List<String> The AMQP endpoints of each broker instance as a list of strings.
amqp+ssl://b-4aada85d-a80c-4be0-9d30-e344a01b921e-1.mq.eu-central-amazonaws.com:5671- arn String
The Amazon Resource Name (ARN) of the Amazon MQ broker.
arn:aws:mq:us-east-2:123456789012:broker:MyBroker:b-1234a5b6-78cd-901e-2fgh-3i45j6k178l9- auto
Minor BooleanVersion Upgrade Enables automatic upgrades to new patch versions for brokers as new versions are released and supported by Amazon MQ. Automatic upgrades occur during the scheduled maintenance window or after a manual broker reboot. Set to
trueby default, if no value is specified.Must be set to
truefor ActiveMQ brokers version 5.18 and above and for RabbitMQ brokers version 3.13 and above.- configuration
Id String - The ID of the current actual configuration.
- configuration
Revision String - The revision of the current actual configuration.
- console
Urls List<String> - data
Replication "NONE" | "CRDR" | StringMode - Defines whether this broker is a part of a data replication pair.
- engine
Version StringCurrent - The version in use. This may have more precision than the specified EngineVersion.
- host
Instance StringType - Required. The broker's instance type.
- id String
- ip
Addresses List<String> The IP addresses of each broker instance as a list of strings. Does not apply to RabbitMQ brokers.
['198.51.100.2', '203.0.113.9']- ldap
Server Property MapMetadata - Optional. The metadata of the LDAP server used to authenticate and authorize connections to the broker. Does not apply to RabbitMQ brokers.
- logs Property Map
- Enables Amazon CloudWatch logging for brokers.
- maintenance
Window Property MapStart Time - The parameters that determine the WeeklyStartTime.
- mqtt
Endpoints List<String> The MQTT endpoints of each broker instance as a list of strings.
mqtt+ssl://b-4aada85d-a80c-4be0-9d30-e344a01b921e-1.mq.eu-central-amazonaws.com:8883- open
Wire List<String>Endpoints The OpenWire endpoints of each broker instance as a list of strings.
ssl://b-4aada85d-a80c-4be0-9d30-e344a01b921e-1.mq.eu-central-amazonaws.com:61617- security
Groups List<String> - The list of rules (1 minimum, 125 maximum) that authorize connections to brokers.
- stomp
Endpoints List<String> The STOMP endpoints of each broker instance as a list of strings.
stomp+ssl://b-4aada85d-a80c-4be0-9d30-e344a01b921e-1.mq.eu-central-amazonaws.com:61614- List<Property Map>
- Create tags when creating the broker.
- wss
Endpoints List<String> The WSS endpoints of each broker instance as a list of strings.
wss://b-4aada85d-a80c-4be0-9d30-e344a01b921e-1.mq.eu-central-amazonaws.com:61619
Supporting Types
BrokerDataReplicationMode
BrokerLdapServerMetadata
- Hosts List<string>
- Role
Base string - Role
Search stringMatching - Service
Account stringUsername - User
Base string - User
Search stringMatching - Role
Name string - Role
Search boolSubtree - Service
Account stringPassword - User
Role stringName - User
Search boolSubtree
- Hosts []string
- Role
Base string - Role
Search stringMatching - Service
Account stringUsername - User
Base string - User
Search stringMatching - Role
Name string - Role
Search boolSubtree - Service
Account stringPassword - User
Role stringName - User
Search boolSubtree
- hosts List<String>
- role
Base String - role
Search StringMatching - service
Account StringUsername - user
Base String - user
Search StringMatching - role
Name String - role
Search BooleanSubtree - service
Account StringPassword - user
Role StringName - user
Search BooleanSubtree
- hosts string[]
- role
Base string - role
Search stringMatching - service
Account stringUsername - user
Base string - user
Search stringMatching - role
Name string - role
Search booleanSubtree - service
Account stringPassword - user
Role stringName - user
Search booleanSubtree
- hosts Sequence[str]
- role_
base str - role_
search_ strmatching - service_
account_ strusername - user_
base str - user_
search_ strmatching - role_
name str - role_
search_ boolsubtree - service_
account_ strpassword - user_
role_ strname - user_
search_ boolsubtree
- hosts List<String>
- role
Base String - role
Search StringMatching - service
Account StringUsername - user
Base String - user
Search StringMatching - role
Name String - role
Search BooleanSubtree - service
Account StringPassword - user
Role StringName - user
Search BooleanSubtree
BrokerLogList
BrokerMaintenanceWindow
- Day
Of Pulumi.Week Aws | stringNative. Amazon Mq. Broker Maintenance Window Day Of Week - Allowed Values: MONDAY | TUESDAY | WEDNESDAY | THURSDAY | FRIDAY | SATURDAY | SUNDAY
- Time
Of stringDay - The time, in 24-hour format, and use only numbers separated by a colon, HH:MM or HH:MM:SS. Example: 13:05. When writing YAML this may need to be quoted to prevent a timestamp being read and converted to a number of minutes or seconds.
- Time
Zone string - The time zone, UTC by default, in either the Country/City format, or the UTC offset format.
- Day
Of BrokerWeek Maintenance | stringWindow Day Of Week - Allowed Values: MONDAY | TUESDAY | WEDNESDAY | THURSDAY | FRIDAY | SATURDAY | SUNDAY
- Time
Of stringDay - The time, in 24-hour format, and use only numbers separated by a colon, HH:MM or HH:MM:SS. Example: 13:05. When writing YAML this may need to be quoted to prevent a timestamp being read and converted to a number of minutes or seconds.
- Time
Zone string - The time zone, UTC by default, in either the Country/City format, or the UTC offset format.
- day
Of BrokerWeek Maintenance | StringWindow Day Of Week - Allowed Values: MONDAY | TUESDAY | WEDNESDAY | THURSDAY | FRIDAY | SATURDAY | SUNDAY
- time
Of StringDay - The time, in 24-hour format, and use only numbers separated by a colon, HH:MM or HH:MM:SS. Example: 13:05. When writing YAML this may need to be quoted to prevent a timestamp being read and converted to a number of minutes or seconds.
- time
Zone String - The time zone, UTC by default, in either the Country/City format, or the UTC offset format.
- day
Of BrokerWeek Maintenance | stringWindow Day Of Week - Allowed Values: MONDAY | TUESDAY | WEDNESDAY | THURSDAY | FRIDAY | SATURDAY | SUNDAY
- time
Of stringDay - The time, in 24-hour format, and use only numbers separated by a colon, HH:MM or HH:MM:SS. Example: 13:05. When writing YAML this may need to be quoted to prevent a timestamp being read and converted to a number of minutes or seconds.
- time
Zone string - The time zone, UTC by default, in either the Country/City format, or the UTC offset format.
- day_
of_ Brokerweek Maintenance | strWindow Day Of Week - Allowed Values: MONDAY | TUESDAY | WEDNESDAY | THURSDAY | FRIDAY | SATURDAY | SUNDAY
- time_
of_ strday - The time, in 24-hour format, and use only numbers separated by a colon, HH:MM or HH:MM:SS. Example: 13:05. When writing YAML this may need to be quoted to prevent a timestamp being read and converted to a number of minutes or seconds.
- time_
zone str - The time zone, UTC by default, in either the Country/City format, or the UTC offset format.
- day
Of "MONDAY" | "TUESDAY" | "WEDNESDAY" | "THURSDAY" | "FRIDAY" | "SATURDAY" | "SUNDAY" | StringWeek - Allowed Values: MONDAY | TUESDAY | WEDNESDAY | THURSDAY | FRIDAY | SATURDAY | SUNDAY
- time
Of StringDay - The time, in 24-hour format, and use only numbers separated by a colon, HH:MM or HH:MM:SS. Example: 13:05. When writing YAML this may need to be quoted to prevent a timestamp being read and converted to a number of minutes or seconds.
- time
Zone String - The time zone, UTC by default, in either the Country/City format, or the UTC offset format.
BrokerMaintenanceWindowDayOfWeek
Tag
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.
