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	awscc.mediaconnect.gateways

Fields

get (all properties)

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.

list (identifiers only)

Name	Datatype	Description
gateway_arn	string	The Amazon Resource Name (ARN) of the gateway.
region	string	AWS region.

For more information, see AWS::MediaConnect::Gateway.

Methods

Name	Resource	Accessible by	Required Params
create_resource	gateways	INSERT	Name, EgressCidrBlocks, Networks, region
delete_resource	gateways	DELETE	Identifier, region
list_resources	gateways_list_only	SELECT	region
get_resource	gateways	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual gateway.

SELECT
  region,
  name,
  gateway_arn,
  gateway_state,
  egress_cidr_blocks,
  networks
FROM awscc.mediaconnect.gateways
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ gateway_arn }}';

list (identifiers only)

Lists all gateways in a region.

SELECT
  region,
  gateway_arn
FROM awscc.mediaconnect.gateways_list_only
WHERE
  region = 'us-east-1';

INSERT example

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

Required Properties

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

All Properties

/*+ create */
INSERT INTO awscc.mediaconnect.gateways (
  Name,
  EgressCidrBlocks,
  Networks,
  region
)
SELECT
  '{{ name }}',
  '{{ egress_cidr_blocks }}',
  '{{ 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: egress_cidr_blocks
        value:
          - '{{ egress_cidr_blocks[0] }}'
      - name: networks
        value:
          - name: '{{ name }}'
            cidr_block: '{{ cidr_block }}'

DELETE example

/*+ delete */
DELETE FROM awscc.mediaconnect.gateways
WHERE
  Identifier = '{{ gateway_arn }}' 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