shared_resources

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

Overview

Name	shared_resources
Type	Resource
Id	aws.mq.shared_resources

Fields

The following fields are returned by SELECT queries:

describe_shared_resources

Name	Datatype	Description
dns_names	array	The DNS names accessible by the broker.
error	object	Information on the error encountered by the resource.
resource_arn	string	The ARN of the shared resource.
resource_share_arns	array	The resource share ARNs to which the resource belongs.
status	string	The status of the shared resource. (AVAILABLE, SETUP_IN_PROGRESS, DELETION_IN_PROGRESS, PENDING_CREATE, PENDING_DELETE, ERROR)
type	string	The type of shared resource. (RESOURCE_SHARE, RESOURCE)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_shared_resources	select	broker-id, region	maxResults, nextToken	Returns the resources shared to a broker.

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
broker-id	string	The unique ID that Amazon MQ generates for the broker.
region	string	AWS region (default: us-east-1)
maxResults	integer	The maximum number of resources 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.

SELECT examples

describe_shared_resources

Returns the resources shared to a broker.

SELECT
dns_names,
error,
resource_arn,
resource_share_arns,
status,
type
FROM aws.mq.shared_resources
WHERE `broker-id` = '{{ broker-id }}' -- required
AND region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;