networks

Creates, updates, deletes or gets a network resource or lists networks in a region

Overview

Name	networks
Type	Resource
Description	Resource schema for AWS::MediaLive::Network.
Id	awscc.medialive.networks

Fields

get (all properties)

Name	Datatype	Description
arn	string	The ARN of the Network.
associated_cluster_ids	array
id	string	The unique ID of the Network.
▶ip_pools	array	The list of IP address cidr pools for the network
name	string	The user-specified name of the Network to be created.
▶routes	array	The routes for the network
state	string	The current state of the Network.
▶tags	array	A collection of key-value pairs.
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
id	string	The unique ID of the Network.
region	string	AWS region.

For more information, see AWS::MediaLive::Network.

Methods

Name	Resource	Accessible by	Required Params
create_resource	networks	INSERT	Name, IpPools, region
delete_resource	networks	DELETE	Identifier, region
update_resource	networks	UPDATE	Identifier, PatchDocument, region
list_resources	networks_list_only	SELECT	region
get_resource	networks	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual network.

SELECT
  region,
  arn,
  associated_cluster_ids,
  id,
  ip_pools,
  name,
  routes,
  state,
  tags
FROM awscc.medialive.networks
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ id }}';

list (identifiers only)

Lists all networks in a region.

SELECT
  region,
  id
FROM awscc.medialive.networks_list_only
WHERE
  region = 'us-east-1';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.medialive.networks (
  IpPools,
  Name,
  region
)
SELECT
  '{{ ip_pools }}',
  '{{ name }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.medialive.networks (
  IpPools,
  Name,
  Routes,
  Tags,
  region
)
SELECT
  '{{ ip_pools }}',
  '{{ name }}',
  '{{ routes }}',
  '{{ tags }}',
  '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: network
    props:
      - name: ip_pools
        value:
          - cidr: '{{ cidr }}'
      - name: name
        value: '{{ name }}'
      - name: routes
        value:
          - cidr: '{{ cidr }}'
            gateway: '{{ gateway }}'
      - name: tags
        value:
          - key: '{{ key }}'
            value: '{{ value }}'

UPDATE example

Use the following StackQL query and manifest file to update a network resource, using stack-deploy.

/*+ update */
UPDATE awscc.medialive.networks
SET PatchDocument = string('{{ {
    "IpPools": ip_pools,
    "Name": name,
    "Routes": routes,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ id }}';

DELETE example

/*+ delete */
DELETE FROM awscc.medialive.networks
WHERE
  Identifier = '{{ id }}' AND
  region = 'us-east-1';

Permissions

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

Create

medialive:CreateNetwork,
medialive:CreateTags,
medialive:DescribeNetwork,
medialive:ListTagsForResource

Read

medialive:DescribeNetwork,
medialive:ListTagsForResource

Update

medialive:UpdateNetwork,
medialive:CreateTags,
medialive:DeleteTags,
medialive:DescribeNetwork,
medialive:ListTagsForResource

Delete

medialive:DeleteNetwork,
medialive:DescribeNetwork

List

medialive:ListNetworks