1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. amazonmq
  5. getBroker

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.37.0 published on Wednesday, Oct 15, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.amazonmq.getBroker

Deploy with Pulumi
aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.37.0 published on Wednesday, Oct 15, 2025 by Pulumi
pulumi/pulumi-aws-native

    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 dictionary

    The following arguments are supported:

    Id string
    Required. The unique ID that Amazon MQ generates for the configuration.
    Id string
    Required. The unique ID that Amazon MQ generates for the configuration.
    id String
    Required. The unique ID that Amazon MQ generates for the configuration.
    id string
    Required. The unique ID that Amazon MQ generates for the configuration.
    id str
    Required. The unique ID that Amazon MQ generates for the configuration.
    id String
    Required. The unique ID that Amazon MQ generates for the configuration.

    getBroker Result

    The following output properties are available:

    AmqpEndpoints 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

    AutoMinorVersionUpgrade bool
    Enables automatic upgrades to new minor versions for brokers, as new broker engine versions are released and supported by Amazon MQ. Automatic upgrades occur during the scheduled maintenance window of the broker or after a manual broker reboot.
    ConfigurationId string
    The ID of the current actual configuration.
    ConfigurationRevision string
    The revision of the current actual configuration.
    ConsoleUrls List<string>
    DataReplicationMode Pulumi.AwsNative.AmazonMq.BrokerDataReplicationMode | string
    Defines whether this broker is a part of a data replication pair.
    EngineVersionCurrent string
    The version in use. This may have more precision than the specified EngineVersion.
    HostInstanceType string
    The broker's instance type.
    Id string
    Required. The unique ID that Amazon MQ generates for the configuration.
    IpAddresses 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']

    LdapServerMetadata Pulumi.AwsNative.AmazonMq.Outputs.BrokerLdapServerMetadata
    Optional. The metadata of the LDAP server used to authenticate and authorize connections to the broker. Does not apply to RabbitMQ brokers.
    Logs Pulumi.AwsNative.AmazonMq.Outputs.BrokerLogList
    Enables Amazon CloudWatch logging for brokers.
    MaintenanceWindowStartTime Pulumi.AwsNative.AmazonMq.Outputs.BrokerMaintenanceWindow
    The scheduled time period relative to UTC during which Amazon MQ begins to apply pending updates or patches to the broker.
    MqttEndpoints 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

    OpenWireEndpoints List<string>

    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

    SecurityGroups List<string>
    The list of rules (1 minimum, 125 maximum) that authorize connections to brokers.
    StompEndpoints 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

    Tags List<Pulumi.AwsNative.Outputs.Tag>
    An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Billing and Cost Management User Guide .
    WssEndpoints 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

    AmqpEndpoints []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

    AutoMinorVersionUpgrade bool
    Enables automatic upgrades to new minor versions for brokers, as new broker engine versions are released and supported by Amazon MQ. Automatic upgrades occur during the scheduled maintenance window of the broker or after a manual broker reboot.
    ConfigurationId string
    The ID of the current actual configuration.
    ConfigurationRevision string
    The revision of the current actual configuration.
    ConsoleUrls []string
    DataReplicationMode BrokerDataReplicationMode | string
    Defines whether this broker is a part of a data replication pair.
    EngineVersionCurrent string
    The version in use. This may have more precision than the specified EngineVersion.
    HostInstanceType string
    The broker's instance type.
    Id string
    Required. The unique ID that Amazon MQ generates for the configuration.
    IpAddresses []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']

    LdapServerMetadata BrokerLdapServerMetadata
    Optional. The metadata of the LDAP server used to authenticate and authorize connections to the broker. Does not apply to RabbitMQ brokers.
    Logs BrokerLogList
    Enables Amazon CloudWatch logging for brokers.
    MaintenanceWindowStartTime BrokerMaintenanceWindow
    The scheduled time period relative to UTC during which Amazon MQ begins to apply pending updates or patches to the broker.
    MqttEndpoints []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

    OpenWireEndpoints []string

    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

    SecurityGroups []string
    The list of rules (1 minimum, 125 maximum) that authorize connections to brokers.
    StompEndpoints []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

    Tags Tag
    An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Billing and Cost Management User Guide .
    WssEndpoints []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

    amqpEndpoints 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

    autoMinorVersionUpgrade Boolean
    Enables automatic upgrades to new minor versions for brokers, as new broker engine versions are released and supported by Amazon MQ. Automatic upgrades occur during the scheduled maintenance window of the broker or after a manual broker reboot.
    configurationId String
    The ID of the current actual configuration.
    configurationRevision String
    The revision of the current actual configuration.
    consoleUrls List<String>
    dataReplicationMode BrokerDataReplicationMode | String
    Defines whether this broker is a part of a data replication pair.
    engineVersionCurrent String
    The version in use. This may have more precision than the specified EngineVersion.
    hostInstanceType String
    The broker's instance type.
    id String
    Required. The unique ID that Amazon MQ generates for the configuration.
    ipAddresses 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']

    ldapServerMetadata BrokerLdapServerMetadata
    Optional. The metadata of the LDAP server used to authenticate and authorize connections to the broker. Does not apply to RabbitMQ brokers.
    logs BrokerLogList
    Enables Amazon CloudWatch logging for brokers.
    maintenanceWindowStartTime BrokerMaintenanceWindow
    The scheduled time period relative to UTC during which Amazon MQ begins to apply pending updates or patches to the broker.
    mqttEndpoints 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

    openWireEndpoints List<String>

    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

    securityGroups List<String>
    The list of rules (1 minimum, 125 maximum) that authorize connections to brokers.
    stompEndpoints 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

    tags List<Tag>
    An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Billing and Cost Management User Guide .
    wssEndpoints 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

    amqpEndpoints 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

    autoMinorVersionUpgrade boolean
    Enables automatic upgrades to new minor versions for brokers, as new broker engine versions are released and supported by Amazon MQ. Automatic upgrades occur during the scheduled maintenance window of the broker or after a manual broker reboot.
    configurationId string
    The ID of the current actual configuration.
    configurationRevision string
    The revision of the current actual configuration.
    consoleUrls string[]
    dataReplicationMode BrokerDataReplicationMode | string
    Defines whether this broker is a part of a data replication pair.
    engineVersionCurrent string
    The version in use. This may have more precision than the specified EngineVersion.
    hostInstanceType string
    The broker's instance type.
    id string
    Required. The unique ID that Amazon MQ generates for the configuration.
    ipAddresses 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']

    ldapServerMetadata BrokerLdapServerMetadata
    Optional. The metadata of the LDAP server used to authenticate and authorize connections to the broker. Does not apply to RabbitMQ brokers.
    logs BrokerLogList
    Enables Amazon CloudWatch logging for brokers.
    maintenanceWindowStartTime BrokerMaintenanceWindow
    The scheduled time period relative to UTC during which Amazon MQ begins to apply pending updates or patches to the broker.
    mqttEndpoints 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

    openWireEndpoints string[]

    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

    securityGroups string[]
    The list of rules (1 minimum, 125 maximum) that authorize connections to brokers.
    stompEndpoints 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

    tags Tag[]
    An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Billing and Cost Management User Guide .
    wssEndpoints 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_version_upgrade bool
    Enables automatic upgrades to new minor versions for brokers, as new broker engine versions are released and supported by Amazon MQ. Automatic upgrades occur during the scheduled maintenance window of the broker or after a manual broker reboot.
    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_mode BrokerDataReplicationMode | str
    Defines whether this broker is a part of a data replication pair.
    engine_version_current str
    The version in use. This may have more precision than the specified EngineVersion.
    host_instance_type str
    The broker's instance type.
    id str
    Required. The unique ID that Amazon MQ generates for the configuration.
    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_metadata BrokerLdapServerMetadata
    Optional. The metadata of the LDAP server used to authenticate and authorize connections to the broker. Does not apply to RabbitMQ brokers.
    logs BrokerLogList
    Enables Amazon CloudWatch logging for brokers.
    maintenance_window_start_time BrokerMaintenanceWindow
    The scheduled time period relative to UTC during which Amazon MQ begins to apply pending updates or patches to the broker.
    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_endpoints Sequence[str]

    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

    tags Sequence[root_Tag]
    An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Billing and Cost Management User Guide .
    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

    amqpEndpoints 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

    autoMinorVersionUpgrade Boolean
    Enables automatic upgrades to new minor versions for brokers, as new broker engine versions are released and supported by Amazon MQ. Automatic upgrades occur during the scheduled maintenance window of the broker or after a manual broker reboot.
    configurationId String
    The ID of the current actual configuration.
    configurationRevision String
    The revision of the current actual configuration.
    consoleUrls List<String>
    dataReplicationMode "NONE" | "CRDR" | String
    Defines whether this broker is a part of a data replication pair.
    engineVersionCurrent String
    The version in use. This may have more precision than the specified EngineVersion.
    hostInstanceType String
    The broker's instance type.
    id String
    Required. The unique ID that Amazon MQ generates for the configuration.
    ipAddresses 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']

    ldapServerMetadata Property Map
    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.
    maintenanceWindowStartTime Property Map
    The scheduled time period relative to UTC during which Amazon MQ begins to apply pending updates or patches to the broker.
    mqttEndpoints 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

    openWireEndpoints List<String>

    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

    securityGroups List<String>
    The list of rules (1 minimum, 125 maximum) that authorize connections to brokers.
    stompEndpoints 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

    tags List<Property Map>
    An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Billing and Cost Management User Guide .
    wssEndpoints 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>
    Specifies the location of the LDAP server such as AWS Directory Service for Microsoft Active Directory . Optional failover server.
    RoleBase string
    The distinguished name of the node in the directory information tree (DIT) to search for roles or groups. For example, ou=group , ou=corp , dc=corp , dc=example , dc=com .
    RoleSearchMatching string
    The LDAP search filter used to find roles within the roleBase. The distinguished name of the user matched by userSearchMatching is substituted into the {0} placeholder in the search filter. The client's username is substituted into the {1} placeholder. For example, if you set this option to (member=uid={1}) for the user janedoe, the search filter becomes (member=uid=janedoe) after string substitution. It matches all role entries that have a member attribute equal to uid=janedoe under the subtree selected by the RoleBases .
    ServiceAccountUsername string
    Service account username. A service account is an account in your LDAP server that has access to initiate a connection. For example, cn=admin , ou=corp , dc=corp , dc=example , dc=com .
    UserBase string
    Select a particular subtree of the directory information tree (DIT) to search for user entries. The subtree is specified by a DN, which specifies the base node of the subtree. For example, by setting this option to ou=Users , ou=corp , dc=corp , dc=example , dc=com , the search for user entries is restricted to the subtree beneath ou=Users , ou=corp , dc=corp , dc=example , dc=com .
    UserSearchMatching string
    The LDAP search filter used to find users within the userBase . The client's username is substituted into the {0} placeholder in the search filter. For example, if this option is set to (uid={0}) and the received username is janedoe , the search filter becomes (uid=janedoe) after string substitution. It will result in matching an entry like uid=janedoe , ou=Users , ou=corp , dc=corp , dc=example , dc=com .
    RoleName string
    The group name attribute in a role entry whose value is the name of that role. For example, you can specify cn for a group entry's common name. If authentication succeeds, then the user is assigned the the value of the cn attribute for each role entry that they are a member of.
    RoleSearchSubtree bool
    The directory search scope for the role. If set to true, scope is to search the entire subtree.
    ServiceAccountPassword string
    Service account password. A service account is an account in your LDAP server that has access to initiate a connection. For example, cn=admin , dc=corp , dc=example , dc=com .
    UserRoleName string
    The name of the LDAP attribute in the user's directory entry for the user's group membership. In some cases, user roles may be identified by the value of an attribute in the user's directory entry. The UserRoleName option allows you to provide the name of this attribute.
    UserSearchSubtree bool
    The directory search scope for the user. If set to true, scope is to search the entire subtree.
    Hosts []string
    Specifies the location of the LDAP server such as AWS Directory Service for Microsoft Active Directory . Optional failover server.
    RoleBase string
    The distinguished name of the node in the directory information tree (DIT) to search for roles or groups. For example, ou=group , ou=corp , dc=corp , dc=example , dc=com .
    RoleSearchMatching string
    The LDAP search filter used to find roles within the roleBase. The distinguished name of the user matched by userSearchMatching is substituted into the {0} placeholder in the search filter. The client's username is substituted into the {1} placeholder. For example, if you set this option to (member=uid={1}) for the user janedoe, the search filter becomes (member=uid=janedoe) after string substitution. It matches all role entries that have a member attribute equal to uid=janedoe under the subtree selected by the RoleBases .
    ServiceAccountUsername string
    Service account username. A service account is an account in your LDAP server that has access to initiate a connection. For example, cn=admin , ou=corp , dc=corp , dc=example , dc=com .
    UserBase string
    Select a particular subtree of the directory information tree (DIT) to search for user entries. The subtree is specified by a DN, which specifies the base node of the subtree. For example, by setting this option to ou=Users , ou=corp , dc=corp , dc=example , dc=com , the search for user entries is restricted to the subtree beneath ou=Users , ou=corp , dc=corp , dc=example , dc=com .
    UserSearchMatching string
    The LDAP search filter used to find users within the userBase . The client's username is substituted into the {0} placeholder in the search filter. For example, if this option is set to (uid={0}) and the received username is janedoe , the search filter becomes (uid=janedoe) after string substitution. It will result in matching an entry like uid=janedoe , ou=Users , ou=corp , dc=corp , dc=example , dc=com .
    RoleName string
    The group name attribute in a role entry whose value is the name of that role. For example, you can specify cn for a group entry's common name. If authentication succeeds, then the user is assigned the the value of the cn attribute for each role entry that they are a member of.
    RoleSearchSubtree bool
    The directory search scope for the role. If set to true, scope is to search the entire subtree.
    ServiceAccountPassword string
    Service account password. A service account is an account in your LDAP server that has access to initiate a connection. For example, cn=admin , dc=corp , dc=example , dc=com .
    UserRoleName string
    The name of the LDAP attribute in the user's directory entry for the user's group membership. In some cases, user roles may be identified by the value of an attribute in the user's directory entry. The UserRoleName option allows you to provide the name of this attribute.
    UserSearchSubtree bool
    The directory search scope for the user. If set to true, scope is to search the entire subtree.
    hosts List<String>
    Specifies the location of the LDAP server such as AWS Directory Service for Microsoft Active Directory . Optional failover server.
    roleBase String
    The distinguished name of the node in the directory information tree (DIT) to search for roles or groups. For example, ou=group , ou=corp , dc=corp , dc=example , dc=com .
    roleSearchMatching String
    The LDAP search filter used to find roles within the roleBase. The distinguished name of the user matched by userSearchMatching is substituted into the {0} placeholder in the search filter. The client's username is substituted into the {1} placeholder. For example, if you set this option to (member=uid={1}) for the user janedoe, the search filter becomes (member=uid=janedoe) after string substitution. It matches all role entries that have a member attribute equal to uid=janedoe under the subtree selected by the RoleBases .
    serviceAccountUsername String
    Service account username. A service account is an account in your LDAP server that has access to initiate a connection. For example, cn=admin , ou=corp , dc=corp , dc=example , dc=com .
    userBase String
    Select a particular subtree of the directory information tree (DIT) to search for user entries. The subtree is specified by a DN, which specifies the base node of the subtree. For example, by setting this option to ou=Users , ou=corp , dc=corp , dc=example , dc=com , the search for user entries is restricted to the subtree beneath ou=Users , ou=corp , dc=corp , dc=example , dc=com .
    userSearchMatching String
    The LDAP search filter used to find users within the userBase . The client's username is substituted into the {0} placeholder in the search filter. For example, if this option is set to (uid={0}) and the received username is janedoe , the search filter becomes (uid=janedoe) after string substitution. It will result in matching an entry like uid=janedoe , ou=Users , ou=corp , dc=corp , dc=example , dc=com .
    roleName String
    The group name attribute in a role entry whose value is the name of that role. For example, you can specify cn for a group entry's common name. If authentication succeeds, then the user is assigned the the value of the cn attribute for each role entry that they are a member of.
    roleSearchSubtree Boolean
    The directory search scope for the role. If set to true, scope is to search the entire subtree.
    serviceAccountPassword String
    Service account password. A service account is an account in your LDAP server that has access to initiate a connection. For example, cn=admin , dc=corp , dc=example , dc=com .
    userRoleName String
    The name of the LDAP attribute in the user's directory entry for the user's group membership. In some cases, user roles may be identified by the value of an attribute in the user's directory entry. The UserRoleName option allows you to provide the name of this attribute.
    userSearchSubtree Boolean
    The directory search scope for the user. If set to true, scope is to search the entire subtree.
    hosts string[]
    Specifies the location of the LDAP server such as AWS Directory Service for Microsoft Active Directory . Optional failover server.
    roleBase string
    The distinguished name of the node in the directory information tree (DIT) to search for roles or groups. For example, ou=group , ou=corp , dc=corp , dc=example , dc=com .
    roleSearchMatching string
    The LDAP search filter used to find roles within the roleBase. The distinguished name of the user matched by userSearchMatching is substituted into the {0} placeholder in the search filter. The client's username is substituted into the {1} placeholder. For example, if you set this option to (member=uid={1}) for the user janedoe, the search filter becomes (member=uid=janedoe) after string substitution. It matches all role entries that have a member attribute equal to uid=janedoe under the subtree selected by the RoleBases .
    serviceAccountUsername string
    Service account username. A service account is an account in your LDAP server that has access to initiate a connection. For example, cn=admin , ou=corp , dc=corp , dc=example , dc=com .
    userBase string
    Select a particular subtree of the directory information tree (DIT) to search for user entries. The subtree is specified by a DN, which specifies the base node of the subtree. For example, by setting this option to ou=Users , ou=corp , dc=corp , dc=example , dc=com , the search for user entries is restricted to the subtree beneath ou=Users , ou=corp , dc=corp , dc=example , dc=com .
    userSearchMatching string
    The LDAP search filter used to find users within the userBase . The client's username is substituted into the {0} placeholder in the search filter. For example, if this option is set to (uid={0}) and the received username is janedoe , the search filter becomes (uid=janedoe) after string substitution. It will result in matching an entry like uid=janedoe , ou=Users , ou=corp , dc=corp , dc=example , dc=com .
    roleName string
    The group name attribute in a role entry whose value is the name of that role. For example, you can specify cn for a group entry's common name. If authentication succeeds, then the user is assigned the the value of the cn attribute for each role entry that they are a member of.
    roleSearchSubtree boolean
    The directory search scope for the role. If set to true, scope is to search the entire subtree.
    serviceAccountPassword string
    Service account password. A service account is an account in your LDAP server that has access to initiate a connection. For example, cn=admin , dc=corp , dc=example , dc=com .
    userRoleName string
    The name of the LDAP attribute in the user's directory entry for the user's group membership. In some cases, user roles may be identified by the value of an attribute in the user's directory entry. The UserRoleName option allows you to provide the name of this attribute.
    userSearchSubtree boolean
    The directory search scope for the user. If set to true, scope is to search the entire subtree.
    hosts Sequence[str]
    Specifies the location of the LDAP server such as AWS Directory Service for Microsoft Active Directory . Optional failover server.
    role_base str
    The distinguished name of the node in the directory information tree (DIT) to search for roles or groups. For example, ou=group , ou=corp , dc=corp , dc=example , dc=com .
    role_search_matching str
    The LDAP search filter used to find roles within the roleBase. The distinguished name of the user matched by userSearchMatching is substituted into the {0} placeholder in the search filter. The client's username is substituted into the {1} placeholder. For example, if you set this option to (member=uid={1}) for the user janedoe, the search filter becomes (member=uid=janedoe) after string substitution. It matches all role entries that have a member attribute equal to uid=janedoe under the subtree selected by the RoleBases .
    service_account_username str
    Service account username. A service account is an account in your LDAP server that has access to initiate a connection. For example, cn=admin , ou=corp , dc=corp , dc=example , dc=com .
    user_base str
    Select a particular subtree of the directory information tree (DIT) to search for user entries. The subtree is specified by a DN, which specifies the base node of the subtree. For example, by setting this option to ou=Users , ou=corp , dc=corp , dc=example , dc=com , the search for user entries is restricted to the subtree beneath ou=Users , ou=corp , dc=corp , dc=example , dc=com .
    user_search_matching str
    The LDAP search filter used to find users within the userBase . The client's username is substituted into the {0} placeholder in the search filter. For example, if this option is set to (uid={0}) and the received username is janedoe , the search filter becomes (uid=janedoe) after string substitution. It will result in matching an entry like uid=janedoe , ou=Users , ou=corp , dc=corp , dc=example , dc=com .
    role_name str
    The group name attribute in a role entry whose value is the name of that role. For example, you can specify cn for a group entry's common name. If authentication succeeds, then the user is assigned the the value of the cn attribute for each role entry that they are a member of.
    role_search_subtree bool
    The directory search scope for the role. If set to true, scope is to search the entire subtree.
    service_account_password str
    Service account password. A service account is an account in your LDAP server that has access to initiate a connection. For example, cn=admin , dc=corp , dc=example , dc=com .
    user_role_name str
    The name of the LDAP attribute in the user's directory entry for the user's group membership. In some cases, user roles may be identified by the value of an attribute in the user's directory entry. The UserRoleName option allows you to provide the name of this attribute.
    user_search_subtree bool
    The directory search scope for the user. If set to true, scope is to search the entire subtree.
    hosts List<String>
    Specifies the location of the LDAP server such as AWS Directory Service for Microsoft Active Directory . Optional failover server.
    roleBase String
    The distinguished name of the node in the directory information tree (DIT) to search for roles or groups. For example, ou=group , ou=corp , dc=corp , dc=example , dc=com .
    roleSearchMatching String
    The LDAP search filter used to find roles within the roleBase. The distinguished name of the user matched by userSearchMatching is substituted into the {0} placeholder in the search filter. The client's username is substituted into the {1} placeholder. For example, if you set this option to (member=uid={1}) for the user janedoe, the search filter becomes (member=uid=janedoe) after string substitution. It matches all role entries that have a member attribute equal to uid=janedoe under the subtree selected by the RoleBases .
    serviceAccountUsername String
    Service account username. A service account is an account in your LDAP server that has access to initiate a connection. For example, cn=admin , ou=corp , dc=corp , dc=example , dc=com .
    userBase String
    Select a particular subtree of the directory information tree (DIT) to search for user entries. The subtree is specified by a DN, which specifies the base node of the subtree. For example, by setting this option to ou=Users , ou=corp , dc=corp , dc=example , dc=com , the search for user entries is restricted to the subtree beneath ou=Users , ou=corp , dc=corp , dc=example , dc=com .
    userSearchMatching String
    The LDAP search filter used to find users within the userBase . The client's username is substituted into the {0} placeholder in the search filter. For example, if this option is set to (uid={0}) and the received username is janedoe , the search filter becomes (uid=janedoe) after string substitution. It will result in matching an entry like uid=janedoe , ou=Users , ou=corp , dc=corp , dc=example , dc=com .
    roleName String
    The group name attribute in a role entry whose value is the name of that role. For example, you can specify cn for a group entry's common name. If authentication succeeds, then the user is assigned the the value of the cn attribute for each role entry that they are a member of.
    roleSearchSubtree Boolean
    The directory search scope for the role. If set to true, scope is to search the entire subtree.
    serviceAccountPassword String
    Service account password. A service account is an account in your LDAP server that has access to initiate a connection. For example, cn=admin , dc=corp , dc=example , dc=com .
    userRoleName String
    The name of the LDAP attribute in the user's directory entry for the user's group membership. In some cases, user roles may be identified by the value of an attribute in the user's directory entry. The UserRoleName option allows you to provide the name of this attribute.
    userSearchSubtree Boolean
    The directory search scope for the user. If set to true, scope is to search the entire subtree.

    BrokerLogList

    Audit bool
    Enables audit logging. Every user management action made using JMX or the ActiveMQ Web Console is logged. Does not apply to RabbitMQ brokers.
    General bool
    Enables general logging.
    Audit bool
    Enables audit logging. Every user management action made using JMX or the ActiveMQ Web Console is logged. Does not apply to RabbitMQ brokers.
    General bool
    Enables general logging.
    audit Boolean
    Enables audit logging. Every user management action made using JMX or the ActiveMQ Web Console is logged. Does not apply to RabbitMQ brokers.
    general Boolean
    Enables general logging.
    audit boolean
    Enables audit logging. Every user management action made using JMX or the ActiveMQ Web Console is logged. Does not apply to RabbitMQ brokers.
    general boolean
    Enables general logging.
    audit bool
    Enables audit logging. Every user management action made using JMX or the ActiveMQ Web Console is logged. Does not apply to RabbitMQ brokers.
    general bool
    Enables general logging.
    audit Boolean
    Enables audit logging. Every user management action made using JMX or the ActiveMQ Web Console is logged. Does not apply to RabbitMQ brokers.
    general Boolean
    Enables general logging.

    BrokerMaintenanceWindow

    DayOfWeek Pulumi.AwsNative.AmazonMq.BrokerMaintenanceWindowDayOfWeek | string
    Allowed Values: MONDAY | TUESDAY | WEDNESDAY | THURSDAY | FRIDAY | SATURDAY | SUNDAY
    TimeOfDay string
    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.
    TimeZone string
    The time zone, UTC by default, in either the Country/City format, or the UTC offset format.
    DayOfWeek BrokerMaintenanceWindowDayOfWeek | string
    Allowed Values: MONDAY | TUESDAY | WEDNESDAY | THURSDAY | FRIDAY | SATURDAY | SUNDAY
    TimeOfDay string
    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.
    TimeZone string
    The time zone, UTC by default, in either the Country/City format, or the UTC offset format.
    dayOfWeek BrokerMaintenanceWindowDayOfWeek | String
    Allowed Values: MONDAY | TUESDAY | WEDNESDAY | THURSDAY | FRIDAY | SATURDAY | SUNDAY
    timeOfDay String
    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.
    timeZone String
    The time zone, UTC by default, in either the Country/City format, or the UTC offset format.
    dayOfWeek BrokerMaintenanceWindowDayOfWeek | string
    Allowed Values: MONDAY | TUESDAY | WEDNESDAY | THURSDAY | FRIDAY | SATURDAY | SUNDAY
    timeOfDay string
    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.
    timeZone string
    The time zone, UTC by default, in either the Country/City format, or the UTC offset format.
    day_of_week BrokerMaintenanceWindowDayOfWeek | str
    Allowed Values: MONDAY | TUESDAY | WEDNESDAY | THURSDAY | FRIDAY | SATURDAY | SUNDAY
    time_of_day str
    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.
    dayOfWeek "MONDAY" | "TUESDAY" | "WEDNESDAY" | "THURSDAY" | "FRIDAY" | "SATURDAY" | "SUNDAY" | String
    Allowed Values: MONDAY | TUESDAY | WEDNESDAY | THURSDAY | FRIDAY | SATURDAY | SUNDAY
    timeOfDay String
    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.
    timeZone String
    The time zone, UTC by default, in either the Country/City format, or the UTC offset format.

    BrokerMaintenanceWindowDayOfWeek

    Tag

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.37.0 published on Wednesday, Oct 15, 2025 by Pulumi
    pulumi/pulumi-aws-native
      Meet Neo: Your AI Platform Teammate