AWS::AmazonMQ::Broker

AmazonMQ Broker

Resource type definition for AWS::AmazonMQ::Broker

Properties

20 configurable properties. 5 required. Click a row to see details.

Filter:

Property	Type	Flags
`BrokerName`	`string`	RequiredCreate-only
`DeploymentMode`	`string \| Any \| Any \| Any`	RequiredCreate-only
`EngineType`	`string \| Any \| Any`	RequiredCreate-only
`HostInstanceType`	`string`	Required
`PubliclyAccessible`	`boolean`	RequiredCreate-only
`AuthenticationStrategy`	`string`	Create-only
`AutoMinorVersionUpgrade`	`boolean`
`Configuration`	`ConfigurationId`	Write-only
`DataReplicationMode`	`string \| Any \| Any`
`DataReplicationPrimaryBrokerArn`	`string`	Write-only
`EncryptionOptions`	`EncryptionOptions`	Create-only
`EngineVersion`	`string`	Write-only
`LdapServerMetadata`	`LdapServerMetadata`
`Logs`	`LogList`
`MaintenanceWindowStartTime`	`MaintenanceWindow`
`SecurityGroups`	`Array<string>`
`StorageType`	`string \| Any`	Create-only
`SubnetIds`	`Array<string>`	Create-only
`Tags`	`Array<TagsEntry>`
`Users`	`Array<User>`	Write-only

Return Values

Values returned after the resource is created. Access these with Fn::GetAtt.

Attribute	Type	Description
`AmqpEndpoints`	`Array<string>`	-
`Arn`	`string`	-
`ConfigurationId`	`string`	The ID of the current actual configuration.
`ConfigurationRevision`	`string`	The revision of the current actual configuration.
`ConsoleURLs`	`Array<string>`	-
`EngineVersionCurrent`	`string`	The version in use. This may have more precision than the specified EngineVersion.
`Id`	`string`	-
`IpAddresses`	`Array<string>`	-
`MqttEndpoints`	`Array<string>`	-
`OpenWireEndpoints`	`Array<string>`	-
`StompEndpoints`	`Array<string>`	-
`WssEndpoints`	`Array<string>`	-

Sample CloudFormation Template

A minimal template with required properties and common optional ones.

template.yaml

AWSTemplateFormatVersion: "2010-09-09"
Description: Sample template for AWS::AmazonMQ::Broker

Resources:
  MyResource:
    Type: AWS::AmazonMQ::Broker
    Properties:
      BrokerName: "my-brokername"
      EngineType: "value"
      DeploymentMode: "value"
      HostInstanceType: "value"
      PubliclyAccessible: true
      Tags:
        - Key: Environment
          Value: Production

Required IAM Permissions

Permissions CloudFormation needs in your IAM role to manage this resource.

create

mq:CreateBrokermq:CreateReplicaBrokermq:DescribeBrokermq:CreateTagskms:CreateGrantkms:DescribeKeyec2:CreateNetworkInterfaceec2:CreateNetworkInterfacePermission

read

mq:DescribeBroker

update

mq:DescribeBrokermq:UpdateBrokermq:RebootBrokermq:DescribeUsermq:CreateUsermq:UpdateUsermq:DeleteUsermq:CreateTags

delete

mq:DeleteBrokermq:DescribeBrokerec2:DeleteNetworkInterfaceec2:DeleteNetworkInterfacePermissionec2:DeleteVpcEndpointsec2:DetachNetworkInterface

list

mq:ListBrokers

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

ServiceAmazonMQ

Properties32

Required5

TaggingSupported

Primary IDId

Supported Operations

CreateReadUpdateDeleteList

Immutable After Creation

These properties cannot be changed after the resource is created. Updating them triggers a replacement.

BrokerNameStorageTypeDeploymentModeEngineTypeSubnetIdsAuthenticationStrategyEncryptionOptionsPubliclyAccessible

Related Resources

External Links

AWS Documentation