gateways

Creates, updates, deletes or gets a gateway resource or lists gateways in a region

Overview

Name	gateways
Type	Resource
Description	Resource schema for AWS::MediaConnect::Gateway
Id	aws.mediaconnect.gateways

Fields

Name	Datatype	Description
name	string	The name of the gateway. This name can not be modified after the gateway is created.
gateway_arn	string	The Amazon Resource Name (ARN) of the gateway.
gateway_state	string	The current status of the gateway.
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.
networks	array	The list of networks in the gateway.
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	Name, EgressCidrBlocks, Networks, region
delete_resource	DELETE	data__Identifier, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all gateways in a region.

SELECT
region,
name,
gateway_arn,
gateway_state,
egress_cidr_blocks,
networks
FROM aws.mediaconnect.gateways
WHERE region = 'us-east-1';

Gets all properties from an individual gateway.

SELECT
region,
name,
gateway_arn,
gateway_state,
egress_cidr_blocks,
networks
FROM aws.mediaconnect.gateways
WHERE region = 'us-east-1' AND data__Identifier = '<GatewayArn>';

INSERT example

Use the following StackQL query and manifest file to create a new gateway resource, using stack-deploy.

Required Properties

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

All Properties

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

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: gateway
    props:
      - name: Name
        value: '{{ Name }}'
      - name: EgressCidrBlocks
        value:
          - '{{ EgressCidrBlocks[0] }}'
      - name: Networks
        value:
          - Name: '{{ Name }}'
            CidrBlock: '{{ CidrBlock }}'

DELETE example

/*+ delete */
DELETE FROM aws.mediaconnect.gateways
WHERE data__Identifier = '<GatewayArn>'
AND region = 'us-east-1';

Permissions

To operate on the gateways resource, the following permissions are required:

Create

iam:CreateServiceLinkedRole,
mediaconnect:CreateGateway,
mediaconnect:DescribeGateway

Read

mediaconnect:DescribeGateway

Delete

iam:CreateServiceLinkedRole,
mediaconnect:DescribeGateway,
mediaconnect:DeleteGateway

List

mediaconnect:ListGateways