gateway_instances

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

Overview

Name	gateway_instances
Type	Resource
Id	aws.mediaconnect.gateway_instances

Fields

The following fields are returned by SELECT queries:

describe_gateway_instance

Name	Datatype	Description
bridge_placement	string	The availability of the instance to host new bridges. The bridgePlacement property can be LOCKED or AVAILABLE. If it is LOCKED, no new bridges can be deployed to this instance. If it is AVAILABLE, new bridges can be deployed to this instance. (AVAILABLE, LOCKED)
connection_status	string	The connection state of the instance. (CONNECTED, DISCONNECTED)
gateway_arn	string	The Amazon Resource Name (ARN) of the instance.
gateway_instance_arn	string	The ARN of the gateway.
instance_id	string	The instance ID generated by the SSM install. This will begin with "mi-".
instance_messages	array	Messages with information about the gateway.
instance_state	string	The status of the instance. (REGISTERING, ACTIVE, DEREGISTERING, DEREGISTERED, REGISTRATION_ERROR, DEREGISTRATION_ERROR)
running_bridge_count	integer	The running bridge count.

list_gateway_instances

Name	Datatype	Description
gateway_arn	string	The Amazon Resource Name (ARN) of the gateway.
gateway_instance_arn	string	The Amazon Resource Name (ARN) of the instance.
instance_id	string	The managed instance ID generated by the SSM install. This will begin with "mi-".
instance_state	string	The status of the instance. (REGISTERING, ACTIVE, DEREGISTERING, DEREGISTERED, REGISTRATION_ERROR, DEREGISTRATION_ERROR)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_gateway_instance	select	gateway_instance_arn, region		Displays the details of an instance.
list_gateway_instances	select	region	filterArn, maxResults, nextToken	Displays a list of instances associated with the Amazon Web Services account. This request returns a paginated result. You can use the filterArn property to display only the instances associated with the selected Gateway Amazon Resource Name (ARN).
update_gateway_instance	update	gateway_instance_arn, region		Updates an existing gateway instance.
deregister_gateway_instance	delete	gateway_instance_arn, region	force	Deregisters an instance. Before you deregister an instance, all bridges running on the instance must be stopped. If you want to deregister an instance without stopping the bridges, you must use the --force option.

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
gateway_instance_arn	string	The Amazon Resource Name (ARN) of the gateway that contains the instance that you want to deregister.
region	string	AWS region (default: us-east-1)
filterArn	string	Filter the list results to display only the instances associated with the selected Gateway ARN.
force	boolean	Force the deregistration of an instance. Force will deregister an instance, even if there are bridges running on it.
maxResults	integer	The maximum number of results to return per API request. For example, you submit a ListInstances request with MaxResults set at 5. Although 20 items match your request, the service returns no more than the first 5 items. (The service also returns a NextToken value that you can use to fetch the next batch of results.) The service might return fewer results than the MaxResults value. If MaxResults is not included in the request, the service defaults to pagination with a maximum of 10 results per page.
nextToken	string	The token that identifies the batch of results that you want to see. For example, you submit a ListInstances request with MaxResults set at 5. The service returns the first batch of results (up to 5) and a NextToken value. To see the next batch of results, you can submit the ListInstances request a second time and specify the NextToken value.

SELECT examples

describe_gateway_instance

Displays the details of an instance.

SELECT
bridge_placement,
connection_status,
gateway_arn,
gateway_instance_arn,
instance_id,
instance_messages,
instance_state,
running_bridge_count
FROM aws.mediaconnect.gateway_instances
WHERE gateway_instance_arn = '{{ gateway_instance_arn }}' -- required
AND region = '{{ region }}' -- required
;

list_gateway_instances

Displays a list of instances associated with the Amazon Web Services account. This request returns a paginated result. You can use the filterArn property to display only the instances associated with the selected Gateway Amazon Resource Name (ARN).

SELECT
gateway_arn,
gateway_instance_arn,
instance_id,
instance_state
FROM aws.mediaconnect.gateway_instances
WHERE region = '{{ region }}' -- required
AND filterArn = '{{ filterArn }}'
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;

UPDATE examples

update_gateway_instance

Updates an existing gateway instance.

UPDATE aws.mediaconnect.gateway_instances
SET 
BridgePlacement = '{{ BridgePlacement }}'
WHERE 
gateway_instance_arn = '{{ gateway_instance_arn }}' --required
AND region = '{{ region }}' --required
RETURNING
bridge_placement,
gateway_instance_arn;

DELETE examples

deregister_gateway_instance

Deregisters an instance. Before you deregister an instance, all bridges running on the instance must be stopped. If you want to deregister an instance without stopping the bridges, you must use the --force option.

DELETE FROM aws.mediaconnect.gateway_instances
WHERE gateway_instance_arn = '{{ gateway_instance_arn }}' --required
AND region = '{{ region }}' --required
AND force = '{{ force }}'
;