Optional. The authentication strategy used to secure the broker. The default is SIMPLE.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Enables automatic upgrades to new minor versions for brokers, as new 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.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
The unique ID that Amazon MQ generates for the broker.
Required? | True |
Position? | 1 |
Accept pipeline input? | True (ByValue, ByPropertyName) |
Amazon.PowerShell.Cmdlets.MQ.AmazonMQClientCmdlet.ClientConfig
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
A list of information about the configuration.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Defines whether this broker is a part of a data replication pair.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
The broker engine version. For a list of supported engine versions, see
Supported engines.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
The broker's host instance type to upgrade to. For a list of supported instance types, see
Broker instance types.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Specifies the location of the LDAP server such as Directory Service for Microsoft Active Directory. Optional failover server.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | LdapServerMetadata_Hosts |
-LdapServerMetadata_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.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
-LdapServerMetadata_RoleName <
String>
Specifies the LDAP attribute that identifies the group name attribute in the object returned from the group membership query.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
-LdapServerMetadata_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 roleBase.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
-LdapServerMetadata_RoleSearchSubtree <
Boolean>
The directory search scope for the role. If set to true, scope is to search the entire subtree.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
-LdapServerMetadata_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.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
-LdapServerMetadata_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,dc=corp, dc=example, dc=com.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
-LdapServerMetadata_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.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
-LdapServerMetadata_UserRoleName <
String>
Specifies the name of the LDAP attribute for the user group membership.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
-LdapServerMetadata_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.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
-LdapServerMetadata_UserSearchSubtree <
Boolean>
The directory search scope for the user. If set to true, scope is to search the entire subtree.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Enables audit logging. Every user management action made using JMX or the ActiveMQ Web Console is logged. Does not apply to RabbitMQ brokers.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Enables general logging.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
The parameters that determine the WeeklyStartTime.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Changes the cmdlet behavior to return the value passed to the BrokerId parameter. The -PassThru parameter is deprecated, use -Select '^BrokerId' instead. This parameter will be removed in a future version.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
The list of security groups (1 minimum, 5 maximum) that authorizes connections to brokers.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | SecurityGroups |
Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.MQ.Model.UpdateBrokerResponse). Specifying the name of a property of type Amazon.MQ.Model.UpdateBrokerResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |