broker_instance_options

Creates, updates, deletes, gets or lists a broker_instance_options resource.

Overview

Name	broker_instance_options
Type	Resource
Id	aws.mq.broker_instance_options

Fields

The following fields are returned by SELECT queries:

describe_broker_instance_options

Name	Datatype	Description
broker_instance_options	array	List of available broker instance options.
max_results	integer	Required. The maximum number of instance options that can be returned per page (20 by default). This value must be an integer from 5 to 100.
next_token	string	The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_broker_instance_options	select	region	engineType, hostInstanceType, maxResults, nextToken, storageType	Describe available broker instance options.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)
engineType	string	Filter response by engine type.
hostInstanceType	string	Filter response by host instance type.
maxResults	integer	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	string	The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.
storageType	string	Filter response by storage type.

SELECT examples

describe_broker_instance_options

Describe available broker instance options.

SELECT
broker_instance_options,
max_results,
next_token
FROM aws.mq.broker_instance_options
WHERE region = '{{ region }}' -- required
AND engineType = '{{ engineType }}'
AND hostInstanceType = '{{ hostInstanceType }}'
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
AND storageType = '{{ storageType }}'
;