AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the Amazon MQ CreateBroker API operation.

Syntax

New-MQBroker
-BrokerName <String>
-Logs_Audit <Boolean>
-AutoMinorVersionUpgrade <Boolean>
-Configuration <ConfigurationId>
-CreatorRequestId <String>
-DeploymentMode <DeploymentMode>
-EngineType <EngineType>
-EngineVersion <String>
-Logs_General <Boolean>
-HostInstanceType <String>
-MaintenanceWindowStartTime <WeeklyStartTime>
-PubliclyAccessible <Boolean>
-SecurityGroup <String[]>
-SubnetId <String[]>
-User <User[]>
-Force <SwitchParameter>

Description

Creates a broker. Note: This API is asynchronous.

Parameters

-AutoMinorVersionUpgrade <Boolean>
Required. Enables automatic upgrades to new minor versions for brokers, as Apache releases the versions. The automatic upgrades occur during the maintenance window of the broker or after a manual broker reboot.
Required?False
Position?Named
Accept pipeline input?False
-BrokerName <String>
Required. The name of the broker. This value must be unique in your AWS account, 1-50 characters long, must contain only letters, numbers, dashes, and underscores, and must not contain whitespaces, brackets, wildcard characters, or special characters.
Required?False
Position?1
Accept pipeline input?True (ByValue, )
-Configuration <ConfigurationId>
A list of information about the configuration.
Required?False
Position?Named
Accept pipeline input?False
-CreatorRequestId <String>
The unique ID that the requester receives for the created broker. Amazon MQ passes your ID with the API action. Note: We recommend using a Universally Unique Identifier (UUID) for the creatorRequestId. You may omit the creatorRequestId if your application doesn't require idempotency.
Required?False
Position?Named
Accept pipeline input?False
-DeploymentMode <DeploymentMode>
Required. The deployment mode of the broker.
Required?False
Position?Named
Accept pipeline input?False
-EngineType <EngineType>
Required. The type of broker engine. Note: Currently, Amazon MQ supports only ACTIVEMQ.
Required?False
Position?Named
Accept pipeline input?False
-EngineVersion <String>
Required. The version of the broker engine. Note: Currently, Amazon MQ supports only 5.15.0.
Required?False
Position?Named
Accept pipeline input?False
-Force <SwitchParameter>
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?False
-HostInstanceType <String>
Required. The broker's instance type.
Required?False
Position?Named
Accept pipeline input?False
-Logs_Audit <Boolean>
Enables audit logging. Every user management action made using JMX or the ActiveMQ Web Console is logged.
Required?False
Position?Named
Accept pipeline input?False
-Logs_General <Boolean>
Enables general logging.
Required?False
Position?Named
Accept pipeline input?False
-MaintenanceWindowStartTime <WeeklyStartTime>
The parameters that determine the WeeklyStartTime.
Required?False
Position?Named
Accept pipeline input?False
-PubliclyAccessible <Boolean>
Required. Enables connections from applications outside of the VPC that hosts the broker's subnets.
Required?False
Position?Named
Accept pipeline input?False
-SecurityGroup <String[]>
The list of rules (1 minimum, 125 maximum) that authorize connections to brokers.
Required?False
Position?Named
Accept pipeline input?False
-SubnetId <String[]>
The list of groups (2 maximum) that define which subnets and IP ranges the broker can use from different Availability Zones. A SINGLE_INSTANCE deployment requires one subnet (for example, the default subnet). An ACTIVE_STANDBY_MULTI_AZ deployment requires two subnets.
Required?False
Position?Named
Accept pipeline input?False
-User <User[]>
Required. The list of ActiveMQ users (persons or applications) who can access queues and topics. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.
Required?False
Position?Named
Accept pipeline input?False

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required? False
Position? Named
Accept pipeline input? False
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required? False
Position? Named
Accept pipeline input? False
-ProfileLocation <String>

Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)

If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials. Note that the encrypted credential file is not supported on all platforms. It will be skipped when searching for profiles on Windows Nano Server, Mac, and Linux platforms.

If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.

As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.

Required? False
Position? Named
Accept pipeline input? False
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required? False
Position? Named
Accept pipeline input? False
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required? False
Position? Named
Accept pipeline input? False
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required? False
Position? Named
Accept pipeline input? False
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required? False
Position? Named
Accept pipeline input? False
-Region <String>
The system name of the AWS region in which the operation should be invoked. For example, us-east-1, eu-west-1 etc.
Required? False
Position? Named
Accept pipeline input? False
-EndpointUrl <String>

The endpoint to make the call against.

Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.

Required? False
Position? Named
Accept pipeline input? False

Inputs

You can pipe a String object to this cmdlet for the BrokerName parameter.

Outputs

This cmdlet returns a Amazon.MQ.Model.CreateBrokerResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.

Supported Version

AWS Tools for PowerShell: 2.x.y.z