gateways

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

Overview

Name	gateways
Type	Resource
Id	aws.mediaconnect.gateways

Fields

The following fields are returned by SELECT queries:

describe_gateway

Name	Datatype	Description
egress_cidr_blocks	array	The range of IP addresses that contribute content or initiate output requests for flows communicating with this gateway. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
gateway_arn	string	The Amazon Resource Name (ARN) of the gateway.
gateway_messages	array	Messages with information about the gateway.
gateway_state	string	The current status of the gateway. (CREATING, ACTIVE, UPDATING, ERROR, DELETING, DELETED)
name	string	The name of the gateway. This name can not be modified after the gateway is created.
networks	array	The list of networks in the gateway.

list_gateways

Name	Datatype	Description
gateway_arn	string	The Amazon Resource Name (ARN) of the gateway.
gateway_state	string	The status of the gateway. (CREATING, ACTIVE, UPDATING, ERROR, DELETING, DELETED)
name	string	The name of the gateway.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_gateway	select	gateway_arn, region		Displays the details of a gateway. The response includes the gateway Amazon Resource Name (ARN), name, and CIDR blocks, as well as details about the networks.
list_gateways	select	region	maxResults, nextToken	Displays a list of gateways that are associated with this account. This request returns a paginated result.
create_gateway	insert	region, EgressCidrBlocks, Networks		Creates a new gateway. The request must include at least one network (up to four).
delete_gateway	delete	gateway_arn, region		Deletes a gateway. Before you can delete a gateway, you must deregister its instances and delete its bridges.

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_arn	string	The Amazon Resource Name (ARN) of the gateway that you want to delete.
region	string	AWS region (default: us-east-1)
maxResults	integer	The maximum number of results to return per API request. For example, you submit a ListGateways 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 ListGateways 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 ListGateways request a second time and specify the NextToken value.

SELECT examples

describe_gateway

Displays the details of a gateway. The response includes the gateway Amazon Resource Name (ARN), name, and CIDR blocks, as well as details about the networks.

SELECT
egress_cidr_blocks,
gateway_arn,
gateway_messages,
gateway_state,
name,
networks
FROM aws.mediaconnect.gateways
WHERE gateway_arn = '{{ gateway_arn }}' -- required
AND region = '{{ region }}' -- required
;

list_gateways

Displays a list of gateways that are associated with this account. This request returns a paginated result.

SELECT
gateway_arn,
gateway_state,
name
FROM aws.mediaconnect.gateways
WHERE region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;

INSERT examples

create_gateway

Creates a new gateway. The request must include at least one network (up to four).

INSERT INTO aws.mediaconnect.gateways (
EgressCidrBlocks,
Name,
Networks,
region
)
SELECT 
'{{ EgressCidrBlocks }}' /* required */,
'{{ Name }}',
'{{ Networks }}' /* required */,
'{{ region }}'
RETURNING
gateway
;

Manifest

# Description fields are for documentation purposes
- name: gateways
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the gateways resource.
  - name: EgressCidrBlocks
    value:
      - "{{ EgressCidrBlocks }}"
  - name: Name
    value: "{{ Name }}"
  - name: Networks
    value:
      - CidrBlock: "{{ CidrBlock }}"
        Name: "{{ Name }}"

DELETE examples

delete_gateway

Deletes a gateway. Before you can delete a gateway, you must deregister its instances and delete its bridges.

DELETE FROM aws.mediaconnect.gateways
WHERE gateway_arn = '{{ gateway_arn }}' --required
AND region = '{{ region }}' --required
;