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	aws.medialive.networks

Fields

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.

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

Methods

Name	Accessible by	Required Params
create_resource	INSERT	Name, IpPools, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all networks in a region.

SELECT
region,
arn,
associated_cluster_ids,
id,
ip_pools,
name,
routes,
state,
tags
FROM aws.medialive.networks
WHERE region = 'us-east-1';

Gets all properties from an individual network.

SELECT
region,
arn,
associated_cluster_ids,
id,
ip_pools,
name,
routes,
state,
tags
FROM aws.medialive.networks
WHERE region = 'us-east-1' AND data__Identifier = '<Id>';

INSERT example

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

Required Properties

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

All Properties

/*+ create */
INSERT INTO aws.medialive.networks (
 IpPools,
 Name,
 Routes,
 Tags,
 region
)
SELECT 
 '{{ IpPools }}',
 '{{ 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: IpPools
        value:
          - Cidr: '{{ Cidr }}'
      - name: Name
        value: '{{ Name }}'
      - name: Routes
        value:
          - Cidr: '{{ Cidr }}'
            Gateway: '{{ Gateway }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

/*+ delete */
DELETE FROM aws.medialive.networks
WHERE data__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