networks

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

Overview

Name	networks
Type	Resource
Id	aws.medialive.networks

Fields

The following fields are returned by SELECT queries:

describe_network

Name	Datatype	Description
arn	string	Placeholder documentation for __string
associated_cluster_ids	array	Placeholder documentation for __listOf__string
id	string	Placeholder documentation for __string
ip_pools	array	An array of IpPools in your organization's network that identify a collection of IP addresses in this network that are reserved for use in MediaLive Anywhere. MediaLive Anywhere uses these IP addresses for Push inputs (in both Bridge and NAT networks) and for output destinations (only in Bridge networks). Each IpPool specifies one CIDR block.
name	string	Placeholder documentation for __string
routes	array	An array of routes that MediaLive Anywhere needs to know about in order to route encoding traffic.
state	string	The current state of the Network. Only MediaLive Anywhere can change the state. (CREATING, CREATE_FAILED, ACTIVE, DELETING, IDLE, IN_USE, UPDATING, DELETE_FAILED, DELETED)

list_networks

Name	Datatype	Description
arn	string	Placeholder documentation for __string
associated_cluster_ids	array	Placeholder documentation for __listOf__string
id	string	Placeholder documentation for __string
ip_pools	array	An array of IpPools in your organization's network that identify a collection of IP addresses in your organization's network that are reserved for use in MediaLive Anywhere. MediaLive Anywhere uses these IP addresses for Push inputs (in both Bridge and NAT networks) and for output destinations (only in Bridge networks). Each IpPool specifies one CIDR block.
name	string	Placeholder documentation for __string
routes	array	An array of routes that MediaLive Anywhere needs to know about in order to route encoding traffic.
state	string	The current state of the Network. Only MediaLive Anywhere can change the state. (CREATING, CREATE_FAILED, ACTIVE, DELETING, IDLE, IN_USE, UPDATING, DELETE_FAILED, DELETED)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_network	select	network_id, region		Get details about a Network.
list_networks	select	region	maxResults, nextToken	Retrieve the list of Networks.
create_network	insert	region		Create as many Networks as you need. You will associate one or more Clusters with each Network.Each Network provides MediaLive Anywhere with required information about the network in your organization that you are using for video encoding using MediaLive.
update_network	update	network_id, region		Change the settings for a Network.
delete_network	delete	network_id, region		Delete a Network. The Network must have no resources associated with it.

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
network_id	string	The ID of the network.
region	string	AWS region (default: us-east-1)
maxResults	integer	The maximum number of items to return.
nextToken	string	The token to retrieve the next page of results.

SELECT examples

describe_network

Get details about a Network.

SELECT
arn,
associated_cluster_ids,
id,
ip_pools,
name,
routes,
state
FROM aws.medialive.networks
WHERE network_id = '{{ network_id }}' -- required
AND region = '{{ region }}' -- required
;

list_networks

Retrieve the list of Networks.

SELECT
arn,
associated_cluster_ids,
id,
ip_pools,
name,
routes,
state
FROM aws.medialive.networks
WHERE region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;

INSERT examples

create_network

Create as many Networks as you need. You will associate one or more Clusters with each Network.Each Network provides MediaLive Anywhere with required information about the network in your organization that you are using for video encoding using MediaLive.

INSERT INTO aws.medialive.networks (
IpPools,
Name,
RequestId,
Routes,
Tags,
region
)
SELECT 
'{{ IpPools }}',
'{{ Name }}',
'{{ RequestId }}',
'{{ Routes }}',
'{{ Tags }}',
'{{ region }}'
RETURNING
arn,
associated_cluster_ids,
id,
ip_pools,
name,
routes,
state
;

Manifest

# Description fields are for documentation purposes
- name: networks
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the networks resource.
  - name: IpPools
    description: |
      Placeholder documentation for __listOfIpPoolCreateRequest
    value:
      - Cidr: "{{ Cidr }}"
  - name: Name
    value: "{{ Name }}"
    description: |
      Placeholder documentation for __string
  - name: RequestId
    value: "{{ RequestId }}"
    description: |
      Placeholder documentation for __string
  - name: Routes
    description: |
      Placeholder documentation for __listOfRouteCreateRequest
    value:
      - Cidr: "{{ Cidr }}"
        Gateway: "{{ Gateway }}"
  - name: Tags
    value: "{{ Tags }}"
    description: |
      Placeholder documentation for Tags

UPDATE examples

update_network

Change the settings for a Network.

UPDATE aws.medialive.networks
SET 
IpPools = '{{ IpPools }}',
Name = '{{ Name }}',
Routes = '{{ Routes }}'
WHERE 
network_id = '{{ network_id }}' --required
AND region = '{{ region }}' --required
RETURNING
arn,
associated_cluster_ids,
id,
ip_pools,
name,
routes,
state;

DELETE examples

delete_network

Delete a Network. The Network must have no resources associated with it.

DELETE FROM aws.medialive.networks
WHERE network_id = '{{ network_id }}' --required
AND region = '{{ region }}' --required
;