router_network_interfaces

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

Overview

Name	router_network_interfaces
Type	Resource
Id	aws.mediaconnect.router_network_interfaces

Fields

The following fields are returned by SELECT queries:

batch_get_router_network_interface

Name	Datatype	Description
errors	array	An array of errors that occurred when retrieving the requested router network interfaces.
router_network_interfaces	array	An array of router network interfaces that were successfully retrieved.

get_router_network_interface

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) of the router network interface. (pattern: <code>arn:(aws[a-zA-Z-]*):mediaconnect:[a-z0-9-]+:[0-9]{12}:routerNetworkInterface:[a-z0-9]{12}</code>)
associated_input_count	integer	The number of router inputs associated with the network interface.
associated_output_count	integer	The number of router outputs associated with the network interface.
configuration	object	The configuration settings for a router network interface.
created_at	string (date-time)	The timestamp when the router network interface was created.
id	string	The unique identifier of the router network interface.
name	string	The name of the router network interface.
network_interface_type	string	The type of the router network interface. (PUBLIC, VPC)
region_name	string	The Amazon Web Services Region where the router network interface is located.
state	string	The current state of the router network interface. (CREATING, ACTIVE, UPDATING, DELETING, ERROR, RECOVERING)
tags	object	Key-value pairs that can be used to tag and organize this router network interface.
updated_at	string (date-time)	The timestamp when the router network interface was last updated.

list_router_network_interfaces

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) of the router network interface. (pattern: <code>arn:(aws[a-zA-Z-]*):mediaconnect:[a-z0-9-]+:[0-9]{12}:routerNetworkInterface:[a-z0-9]{12}</code>)
associated_input_count	integer	The number of router inputs associated with the network interface.
associated_output_count	integer	The number of router outputs associated with the network interface.
created_at	string (date-time)	The timestamp when the network interface was created.
id	string	The unique identifier of the router network interface.
name	string	The name of the router network interface.
network_interface_type	string	The type of the router network interface. (PUBLIC, VPC)
region_name	string	The Amazon Web Services Region where the router network interface is located.
state	string	The current state of the router network interface. (CREATING, ACTIVE, UPDATING, DELETING, ERROR, RECOVERING)
updated_at	string (date-time)	The timestamp when the router network interface was last updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
batch_get_router_network_interface	select	arns, region		Retrieves information about multiple router network interfaces in AWS Elemental MediaConnect.
get_router_network_interface	select	arn, region		Retrieves information about a specific router network interface in AWS Elemental MediaConnect.
list_router_network_interfaces	select	region	maxResults, nextToken	Retrieves a list of router network interfaces in AWS Elemental MediaConnect.
create_router_network_interface	insert	region, Configuration		Creates a new router network interface in AWS Elemental MediaConnect.
update_router_network_interface	update	arn, region		Updates the configuration of an existing router network interface in AWS Elemental MediaConnect.
delete_router_network_interface	delete	arn, region		Deletes a router network interface from AWS Elemental MediaConnect.

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
arn	string	The Amazon Resource Name (ARN) of the router network interface that you want to delete.
arns	array	The Amazon Resource Names (ARNs) of the router network interfaces you want to retrieve information about.
region	string	AWS region (default: us-east-1)
maxResults	integer	The maximum number of router network interfaces to return in the response.
nextToken	string	A token used to retrieve the next page of results.

SELECT examples

batch_get_router_network_interface

Retrieves information about multiple router network interfaces in AWS Elemental MediaConnect.

SELECT
errors,
router_network_interfaces
FROM aws.mediaconnect.router_network_interfaces
WHERE arns = '{{ arns }}' -- required
AND region = '{{ region }}' -- required
;

get_router_network_interface

Retrieves information about a specific router network interface in AWS Elemental MediaConnect.

SELECT
arn,
associated_input_count,
associated_output_count,
configuration,
created_at,
id,
name,
network_interface_type,
region_name,
state,
tags,
updated_at
FROM aws.mediaconnect.router_network_interfaces
WHERE arn = '{{ arn }}' -- required
AND region = '{{ region }}' -- required
;

list_router_network_interfaces

Retrieves a list of router network interfaces in AWS Elemental MediaConnect.

SELECT
arn,
associated_input_count,
associated_output_count,
created_at,
id,
name,
network_interface_type,
region_name,
state,
updated_at
FROM aws.mediaconnect.router_network_interfaces
WHERE region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;

INSERT examples

create_router_network_interface

Creates a new router network interface in AWS Elemental MediaConnect.

INSERT INTO aws.mediaconnect.router_network_interfaces (
Name,
Configuration,
RegionName,
Tags,
ClientToken,
region
)
SELECT 
'{{ Name }}',
'{{ Configuration }}' /* required */,
'{{ RegionName }}',
'{{ Tags }}',
'{{ ClientToken }}',
'{{ region }}'
RETURNING
router_network_interface
;

Manifest

# Description fields are for documentation purposes
- name: router_network_interfaces
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the router_network_interfaces resource.
  - name: Name
    value: "{{ Name }}"
  - name: Configuration
    description: |
      The configuration settings for a router network interface.
    value:
      Public:
        AllowRules:
          - Cidr: "{{ Cidr }}"
      Vpc:
        SecurityGroupIds:
          - "{{ SecurityGroupIds }}"
        SubnetId: "{{ SubnetId }}"
  - name: RegionName
    value: "{{ RegionName }}"
  - name: Tags
    value: "{{ Tags }}"
  - name: ClientToken
    value: "{{ ClientToken }}"

UPDATE examples

update_router_network_interface

Updates the configuration of an existing router network interface in AWS Elemental MediaConnect.

UPDATE aws.mediaconnect.router_network_interfaces
SET 
Name = '{{ Name }}',
Configuration = '{{ Configuration }}'
WHERE 
arn = '{{ arn }}' --required
AND region = '{{ region }}' --required
RETURNING
router_network_interface;

DELETE examples

delete_router_network_interface

Deletes a router network interface from AWS Elemental MediaConnect.

DELETE FROM aws.mediaconnect.router_network_interfaces
WHERE arn = '{{ arn }}' --required
AND region = '{{ region }}' --required
;