aws.mq.getBroker
Explore with Pulumi AI
Provides details about an existing Amazon MQ broker. Use this data source to retrieve configuration and metadata for an Amazon MQ broker by ID or name.
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,
region: 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,
region: 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 dictionary
The following arguments are supported:
- Broker
Id string - Unique ID of the MQ broker.
- Broker
Name string - Unique name of the MQ broker.
- Region string
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
Note: Either
broker_id
orbroker_name
must be specified.- Dictionary<string, string>
- Map of tags assigned to the broker.
- Broker
Id string - Unique ID of the MQ broker.
- Broker
Name string - Unique name of the MQ broker.
- Region string
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
Note: Either
broker_id
orbroker_name
must be specified.- map[string]string
- Map of tags assigned to the broker.
- broker
Id String - Unique ID of the MQ broker.
- broker
Name String - Unique name of the MQ broker.
- region String
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
Note: Either
broker_id
orbroker_name
must be specified.- Map<String,String>
- Map of tags assigned to the broker.
- broker
Id string - Unique ID of the MQ broker.
- broker
Name string - Unique name of the MQ broker.
- region string
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
Note: Either
broker_id
orbroker_name
must be specified.- {[key: string]: string}
- Map of tags assigned to the broker.
- broker_
id str - Unique ID of the MQ broker.
- broker_
name str - Unique name of the MQ broker.
- region str
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
Note: Either
broker_id
orbroker_name
must be specified.- Mapping[str, str]
- Map of tags assigned to the broker.
- broker
Id String - Unique ID of the MQ broker.
- broker
Name String - Unique name of the MQ broker.
- region String
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
Note: Either
broker_id
orbroker_name
must be specified.- Map<String>
- Map of tags assigned to the broker.
getBroker Result
The following output properties are available:
- Arn string
- ARN of the broker.
- Authentication
Strategy string - Authentication strategy used to secure the broker.
- Auto
Minor boolVersion Upgrade - Whether to automatically upgrade to new minor versions of brokers as Amazon MQ makes releases available.
- Broker
Id string - Broker
Name string - Configuration
Get
Broker Configuration - Configuration block for broker configuration. See Configuration below.
- Deployment
Mode string - Deployment mode of the broker.
- Encryption
Options List<GetBroker Encryption Option> - Configuration block containing encryption options. See Encryption Options below.
- Engine
Type string - Type of broker engine.
- Engine
Version string - Version of the broker engine.
- Host
Instance stringType - Broker's instance type.
- Id string
- The provider-assigned unique ID for this managed resource.
- Instances
List<Get
Broker Instance> - List of information about allocated brokers (both active & standby). See Instances below.
- Ldap
Server List<GetMetadatas Broker Ldap Server Metadata> - Configuration block for the LDAP server used to authenticate and authorize connections to the broker. See LDAP Server Metadata below.
- Logs
Get
Broker Logs - Configuration block for the logging configuration of the broker. See Logs below.
- Maintenance
Window GetStart Time Broker Maintenance Window Start Time - Configuration block for the maintenance window start time. See Maintenance Window Start Time below.
- Publicly
Accessible bool - Whether to enable connections from applications outside of the VPC that hosts the broker's subnets.
- Region string
- Security
Groups List<string> - List of security group IDs assigned to the broker.
- Storage
Type string - Storage type of the broker.
- Subnet
Ids List<string> - List of subnet IDs in which to launch the broker.
- Dictionary<string, string>
- Map of tags assigned to the broker.
- Users
List<Get
Broker User> - Configuration block for broker users. See User below.
- Arn string
- ARN of the broker.
- Authentication
Strategy string - Authentication strategy used to secure the broker.
- Auto
Minor boolVersion Upgrade - Whether to automatically upgrade to new minor versions of brokers as Amazon MQ makes releases available.
- Broker
Id string - Broker
Name string - Configuration
Get
Broker Configuration - Configuration block for broker configuration. See Configuration below.
- Deployment
Mode string - Deployment mode of the broker.
- Encryption
Options []GetBroker Encryption Option - Configuration block containing encryption options. See Encryption Options below.
- Engine
Type string - Type of broker engine.
- Engine
Version string - Version of the broker engine.
- Host
Instance stringType - Broker's instance type.
- Id string
- The provider-assigned unique ID for this managed resource.
- Instances
[]Get
Broker Instance - List of information about allocated brokers (both active & standby). See Instances below.
- Ldap
Server []GetMetadatas Broker Ldap Server Metadata - Configuration block for the LDAP server used to authenticate and authorize connections to the broker. See LDAP Server Metadata below.
- Logs
Get
Broker Logs - Configuration block for the logging configuration of the broker. See Logs below.
- Maintenance
Window GetStart Time Broker Maintenance Window Start Time - Configuration block for the maintenance window start time. See Maintenance Window Start Time below.
- Publicly
Accessible bool - Whether to enable connections from applications outside of the VPC that hosts the broker's subnets.
- Region string
- Security
Groups []string - List of security group IDs assigned to the broker.
- Storage
Type string - Storage type of the broker.
- Subnet
Ids []string - List of subnet IDs in which to launch the broker.
- map[string]string
- Map of tags assigned to the broker.
- Users
[]Get
Broker User - Configuration block for broker users. See User below.
- arn String
- ARN of the broker.
- authentication
Strategy String - Authentication strategy used to secure the broker.
- auto
Minor BooleanVersion Upgrade - Whether to automatically upgrade to new minor versions of brokers as Amazon MQ makes releases available.
- broker
Id String - broker
Name String - configuration
Get
Broker Configuration - Configuration block for broker configuration. See Configuration below.
- deployment
Mode String - Deployment mode of the broker.
- encryption
Options List<GetBroker Encryption Option> - Configuration block containing encryption options. See Encryption Options below.
- engine
Type String - Type of broker engine.
- engine
Version String - Version of the broker engine.
- host
Instance StringType - Broker's instance type.
- id String
- The provider-assigned unique ID for this managed resource.
- instances
List<Get
Broker Instance> - List of information about allocated brokers (both active & standby). See Instances below.
- ldap
Server List<GetMetadatas Broker Ldap Server Metadata> - Configuration block for the LDAP server used to authenticate and authorize connections to the broker. See LDAP Server Metadata below.
- logs
Get
Broker Logs - Configuration block for the logging configuration of the broker. See Logs below.
- maintenance
Window GetStart Time Broker Maintenance Window Start Time - Configuration block for the maintenance window start time. See Maintenance Window Start Time below.
- publicly
Accessible Boolean - Whether to enable connections from applications outside of the VPC that hosts the broker's subnets.
- region String
- security
Groups List<String> - List of security group IDs assigned to the broker.
- storage
Type String - Storage type of the broker.
- subnet
Ids List<String> - List of subnet IDs in which to launch the broker.
- Map<String,String>
- Map of tags assigned to the broker.
- users
List<Get
Broker User> - Configuration block for broker users. See User below.
- arn string
- ARN of the broker.
- authentication
Strategy string - Authentication strategy used to secure the broker.
- auto
Minor booleanVersion Upgrade - Whether to automatically upgrade to new minor versions of brokers as Amazon MQ makes releases available.
- broker
Id string - broker
Name string - configuration
Get
Broker Configuration - Configuration block for broker configuration. See Configuration below.
- deployment
Mode string - Deployment mode of the broker.
- encryption
Options GetBroker Encryption Option[] - Configuration block containing encryption options. See Encryption Options below.
- engine
Type string - Type of broker engine.
- engine
Version string - Version of the broker engine.
- host
Instance stringType - Broker's instance type.
- id string
- The provider-assigned unique ID for this managed resource.
- instances
Get
Broker Instance[] - List of information about allocated brokers (both active & standby). See Instances below.
- ldap
Server GetMetadatas Broker Ldap Server Metadata[] - Configuration block for the LDAP server used to authenticate and authorize connections to the broker. See LDAP Server Metadata below.
- logs
Get
Broker Logs - Configuration block for the logging configuration of the broker. See Logs below.
- maintenance
Window GetStart Time Broker Maintenance Window Start Time - Configuration block for the maintenance window start time. See Maintenance Window Start Time below.
- publicly
Accessible boolean - Whether to enable connections from applications outside of the VPC that hosts the broker's subnets.
- region string
- security
Groups string[] - List of security group IDs assigned to the broker.
- storage
Type string - Storage type of the broker.
- subnet
Ids string[] - List of subnet IDs in which to launch the broker.
- {[key: string]: string}
- Map of tags assigned to the broker.
- users
Get
Broker User[] - Configuration block for broker users. See User below.
- arn str
- ARN of the broker.
- authentication_
strategy str - Authentication strategy used to secure the broker.
- auto_
minor_ boolversion_ upgrade - Whether to automatically upgrade to new minor versions of brokers as Amazon MQ makes releases available.
- broker_
id str - broker_
name str - configuration
Get
Broker Configuration - Configuration block for broker configuration. See Configuration below.
- deployment_
mode str - Deployment mode of the broker.
- encryption_
options Sequence[GetBroker Encryption Option] - Configuration block containing encryption options. See Encryption Options below.
- engine_
type str - Type of broker engine.
- engine_
version str - Version of the broker engine.
- host_
instance_ strtype - Broker's instance type.
- id str
- The provider-assigned unique ID for this managed resource.
- instances
Sequence[Get
Broker Instance] - List of information about allocated brokers (both active & standby). See Instances below.
- ldap_
server_ Sequence[Getmetadatas Broker Ldap Server Metadata] - Configuration block for the LDAP server used to authenticate and authorize connections to the broker. See LDAP Server Metadata below.
- logs
Get
Broker Logs - Configuration block for the logging configuration of the broker. See Logs below.
- maintenance_
window_ Getstart_ time Broker Maintenance Window Start Time - Configuration block for the maintenance window start time. See Maintenance Window Start Time below.
- publicly_
accessible bool - Whether to enable connections from applications outside of the VPC that hosts the broker's subnets.
- region str
- security_
groups Sequence[str] - List of security group IDs assigned to the broker.
- storage_
type str - Storage type of the broker.
- subnet_
ids Sequence[str] - List of subnet IDs in which to launch the broker.
- Mapping[str, str]
- Map of tags assigned to the broker.
- users
Sequence[Get
Broker User] - Configuration block for broker users. See User below.
- arn String
- ARN of the broker.
- authentication
Strategy String - Authentication strategy used to secure the broker.
- auto
Minor BooleanVersion Upgrade - Whether to automatically upgrade to new minor versions of brokers as Amazon MQ makes releases available.
- broker
Id String - broker
Name String - configuration Property Map
- Configuration block for broker configuration. See Configuration below.
- deployment
Mode String - Deployment mode of the broker.
- encryption
Options List<Property Map> - Configuration block containing encryption options. See Encryption Options below.
- engine
Type String - Type of broker engine.
- engine
Version String - Version of the broker engine.
- host
Instance StringType - Broker's instance type.
- id String
- The provider-assigned unique ID for this managed resource.
- instances List<Property Map>
- List of information about allocated brokers (both active & standby). See Instances below.
- ldap
Server List<Property Map>Metadatas - Configuration block for the LDAP server used to authenticate and authorize connections to the broker. See LDAP Server Metadata below.
- logs Property Map
- Configuration block for the logging configuration of the broker. See Logs below.
- maintenance
Window Property MapStart Time - Configuration block for the maintenance window start time. See Maintenance Window Start Time below.
- publicly
Accessible Boolean - Whether to enable connections from applications outside of the VPC that hosts the broker's subnets.
- region String
- security
Groups List<String> - List of security group IDs assigned to the broker.
- storage
Type String - Storage type of the broker.
- subnet
Ids List<String> - List of subnet IDs in which to launch the broker.
- Map<String>
- Map of tags assigned to the broker.
- users List<Property Map>
- Configuration block for broker users. See User below.
Supporting Types
GetBrokerConfiguration
GetBrokerEncryptionOption
- Kms
Key stringId - Amazon Resource Name (ARN) of Key Management Service (KMS) Customer Master Key (CMK) to use for encryption at rest.
- Use
Aws boolOwned Key - Whether to enable an AWS-owned KMS CMK that is not 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.
- Use
Aws boolOwned Key - Whether to enable an AWS-owned KMS CMK that is not 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.
- use
Aws BooleanOwned Key - Whether to enable an AWS-owned KMS CMK that is not 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.
- use
Aws booleanOwned Key - Whether to enable an AWS-owned KMS CMK that is not 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.
- use_
aws_ boolowned_ key - Whether to enable an AWS-owned KMS CMK that is not 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.
- use
Aws BooleanOwned Key - Whether to enable an AWS-owned KMS CMK that is not in your account.
GetBrokerInstance
- Console
Url string - URL of the ActiveMQ Web Console or the RabbitMQ Management UI depending on
engine_type
. - Endpoints List<string>
- Broker's wire-level protocol endpoints.
- Ip
Address string - IP Address of the broker.
- Console
Url string - URL of the ActiveMQ Web Console or the RabbitMQ Management UI depending on
engine_type
. - Endpoints []string
- Broker's wire-level protocol endpoints.
- Ip
Address string - IP Address of the broker.
- console
Url String - URL of the ActiveMQ Web Console or the RabbitMQ Management UI depending on
engine_type
. - endpoints List<String>
- Broker's wire-level protocol endpoints.
- ip
Address String - IP Address of the broker.
- console
Url string - URL of the ActiveMQ Web Console or the RabbitMQ Management UI depending on
engine_type
. - endpoints string[]
- Broker's wire-level protocol endpoints.
- ip
Address string - IP Address of the broker.
- console_
url str - URL of the ActiveMQ Web Console or the RabbitMQ Management UI depending on
engine_type
. - endpoints Sequence[str]
- Broker's wire-level protocol endpoints.
- ip_
address str - IP Address of the broker.
- console
Url String - URL of the ActiveMQ Web Console or the RabbitMQ Management UI depending on
engine_type
. - endpoints List<String>
- Broker's wire-level protocol endpoints.
- ip
Address String - IP Address of the broker.
GetBrokerLdapServerMetadata
- 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 - 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 - 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 - 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 - 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 - 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 - 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 - 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 - 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 - 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 - 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 - 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 - 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.
GetBrokerLogs
GetBrokerMaintenanceWindowStartTime
- day_
of_ strweek - Day of the week.
- time_
of_ strday - Time, in 24-hour format.
- time_
zone str - Time zone in either the Country/City format or the UTC offset format.
GetBrokerUser
- Console
Access bool - Whether to enable access to the ActiveMQ Web Console for the user.
- Groups List<string>
- List of groups to which the ActiveMQ user belongs.
- Replication
User bool - Whether to set replication user.
- Username string
- Username of the user.
- Console
Access bool - Whether to enable access to the ActiveMQ Web Console for the user.
- Groups []string
- List of groups to which the ActiveMQ user belongs.
- Replication
User bool - Whether to set replication user.
- Username string
- Username of the user.
- console
Access Boolean - Whether to enable access to the ActiveMQ Web Console for the user.
- groups List<String>
- List of groups to which the ActiveMQ user belongs.
- replication
User Boolean - Whether to set replication user.
- username String
- Username of the user.
- console
Access boolean - Whether to enable access to the ActiveMQ Web Console for the user.
- groups string[]
- List of groups to which the ActiveMQ user belongs.
- replication
User boolean - Whether to set replication user.
- username string
- Username of the user.
- console_
access bool - Whether to enable access to the ActiveMQ Web Console for the user.
- groups Sequence[str]
- List of groups to which the ActiveMQ user belongs.
- replication_
user bool - Whether to set replication user.
- username str
- Username of the user.
- console
Access Boolean - Whether to enable access to the ActiveMQ Web Console for the user.
- groups List<String>
- List of groups to which the ActiveMQ user belongs.
- replication
User Boolean - Whether to set replication user.
- username String
- Username of the user.
Package Details
- Repository
- AWS Classic pulumi/pulumi-aws
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
aws
Terraform Provider.