Skip to content

Describe available broker instance options

Description

Describe available broker instance options.

Usage

mq_describe_broker_instance_options(EngineType, HostInstanceType,
  MaxResults, NextToken, StorageType)

Arguments

  • EngineType

    Filter response by engine type.

  • HostInstanceType

    Filter response by host instance type.

  • MaxResults

    The maximum number of brokers that Amazon MQ can return per page (20 by default). This value must be an integer from 5 to 100.

  • NextToken

    The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.

  • StorageType

    Filter response by storage type.

Value

A list with the following syntax:

list(
  BrokerInstanceOptions = list(
    list(
      AvailabilityZones = list(
        list(
          Name = "string"
        )
      ),
      EngineType = "ACTIVEMQ"|"RABBITMQ",
      HostInstanceType = "string",
      StorageType = "EBS"|"EFS",
      SupportedDeploymentModes = list(
        "SINGLE_INSTANCE"|"ACTIVE_STANDBY_MULTI_AZ"|"CLUSTER_MULTI_AZ"
      ),
      SupportedEngineVersions = list(
        "string"
      )
    )
  ),
  MaxResults = 123,
  NextToken = "string"
)

Request syntax

svc$describe_broker_instance_options(
  EngineType = "string",
  HostInstanceType = "string",
  MaxResults = 123,
  NextToken = "string",
  StorageType = "string"
)