router_outputs

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

Overview

Name	router_outputs
Type	Resource
Id	aws.mediaconnect.router_outputs

Fields

The following fields are returned by SELECT queries:

batch_get_router_output

Name	Datatype	Description
errors	array	An array of errors that occurred when retrieving the requested router outputs.
router_outputs	array	An array of router outputs that were successfully retrieved.

get_router_output

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) of the router output. (pattern: <code>arn:(aws[a-zA-Z-]*):mediaconnect:[a-z0-9-]+:[0-9]{12}:routerOutput:[a-z0-9]{12}</code>)
availability_zone	string	The Availability Zone of the router output.
configuration	object	The configuration settings for a router output.
created_at	string (date-time)	The timestamp when the router output was created.
fabric_configuration	object	The fabric configuration settings for the router output.
id	string	The unique identifier of the router output.
ip_address	string	The IP address of the router output.
maintenance_configuration	object	The maintenance configuration settings applied to this router output.
maintenance_schedule	object	The current maintenance schedule details for this router output.
maintenance_schedule_type	string	The type of maintenance schedule currently in effect for this router output. (WINDOW)
maintenance_type	string	The type of maintenance configuration applied to this router output. (PREFERRED_DAY_TIME, DEFAULT)
maximum_bitrate	integer (int64)	The maximum bitrate for the router output.
messages	array	The messages associated with the router output.
name	string	The name of the router output.
output_type	string	The type of the router output. (STANDARD, MEDIACONNECT_FLOW, MEDIALIVE_INPUT)
region_name	string	The Amazon Web Services Region where the router output is located.
routed_input_arn	string	The Amazon Resource Name (ARN) of the router input associated with the output. (pattern: <code>arn:(aws[a-zA-Z-]*):mediaconnect:[a-z0-9-]+:[0-9]{12}:routerInput:[a-z0-9]{12}</code>)
routed_state	string	The current state of the association between the router output and its input. (ROUTED, ROUTING, UNROUTED)
routing_scope	string	Indicates whether the router output is configured for Regional or global routing. (REGIONAL, GLOBAL)
state	string	The overall state of the router output. (CREATING, STANDBY, STARTING, ACTIVE, STOPPING, DELETING, UPDATING, ERROR, RECOVERING, MIGRATING)
stream_details	object	Information about the router output's stream, including connection state and destination details. The specific details provided vary based on the router output type.
tags	object	Key-value pairs that can be used to tag and organize this router output.
tier	string	The tier level of the router output. (OUTPUT_100, OUTPUT_50, OUTPUT_20)
updated_at	string (date-time)	The timestamp when the router output was last updated.

list_router_outputs

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) of the router output. (pattern: <code>arn:(aws[a-zA-Z-]*):mediaconnect:[a-z0-9-]+:[0-9]{12}:routerOutput:[a-z0-9]{12}</code>)
availability_zone	string	The Availability Zone of the router output.
created_at	string (date-time)	The timestamp when the router output was created.
id	string	The unique identifier of the router output.
maintenance_schedule	object	The details of the maintenance schedule for the listed router output.
maintenance_schedule_type	string	The type of maintenance schedule currently associated with the listed router output. (WINDOW)
maximum_bitrate	integer (int64)	The maximum bitrate of the router output.
message_count	integer	The number of messages associated with the router output.
name	string	The name of the router output.
network_interface_arn	string	The ARN of the network interface associated with the router output. (pattern: <code>arn:(aws[a-zA-Z-]*):mediaconnect:[a-z0-9-]+:[0-9]{12}:routerNetworkInterface:[a-z0-9]{12}</code>)
output_type	string	The type of the router output. (STANDARD, MEDIACONNECT_FLOW, MEDIALIVE_INPUT)
region_name	string	The AAmazon Web Services Region where the router output is located.
routed_input_arn	string	The ARN of the router input associated with the output. (pattern: <code>arn:(aws[a-zA-Z-]*):mediaconnect:[a-z0-9-]+:[0-9]{12}:routerInput:[a-z0-9]{12}</code>)
routed_state	string	The current state of the association between the router output and its input. (ROUTED, ROUTING, UNROUTED)
routing_scope	string	Indicates whether the router output is configured for Regional or global routing. (REGIONAL, GLOBAL)
state	string	The overall state of the router output. (CREATING, STANDBY, STARTING, ACTIVE, STOPPING, DELETING, UPDATING, ERROR, RECOVERING, MIGRATING)
updated_at	string (date-time)	The timestamp when the router output was last updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
batch_get_router_output	select	arns, region		Retrieves information about multiple router outputs in AWS Elemental MediaConnect.
get_router_output	select	arn, region		Retrieves information about a specific router output in AWS Elemental MediaConnect.
list_router_outputs	select	region	maxResults, nextToken	Retrieves a list of router outputs in AWS Elemental MediaConnect.
create_router_output	insert	region, Configuration, MaximumBitrate, RoutingScope, Tier		Creates a new router output in AWS Elemental MediaConnect.
update_router_output	update	arn, region		Updates the configuration of an existing router output in AWS Elemental MediaConnect.
delete_router_output	delete	arn, region		Deletes a router output from AWS Elemental MediaConnect.
take_router_input	exec	router_output_arn, region		Associates a router input with a router output in 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 output that you want to delete.
arns	array	The Amazon Resource Names (ARNs) of the router outputs you want to retrieve information about.
region	string	AWS region (default: us-east-1)
router_output_arn	string	The Amazon Resource Name (ARN) of the router output that you want to associate with a router input.
maxResults	integer	The maximum number of router outputs to return in the response.
nextToken	string	A token used to retrieve the next page of results.

SELECT examples

batch_get_router_output

Retrieves information about multiple router outputs in AWS Elemental MediaConnect.

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

get_router_output

Retrieves information about a specific router output in AWS Elemental MediaConnect.

SELECT
arn,
availability_zone,
configuration,
created_at,
fabric_configuration,
id,
ip_address,
maintenance_configuration,
maintenance_schedule,
maintenance_schedule_type,
maintenance_type,
maximum_bitrate,
messages,
name,
output_type,
region_name,
routed_input_arn,
routed_state,
routing_scope,
state,
stream_details,
tags,
tier,
updated_at
FROM aws.mediaconnect.router_outputs
WHERE arn = '{{ arn }}' -- required
AND region = '{{ region }}' -- required
;

list_router_outputs

Retrieves a list of router outputs in AWS Elemental MediaConnect.

SELECT
arn,
availability_zone,
created_at,
id,
maintenance_schedule,
maintenance_schedule_type,
maximum_bitrate,
message_count,
name,
network_interface_arn,
output_type,
region_name,
routed_input_arn,
routed_state,
routing_scope,
state,
updated_at
FROM aws.mediaconnect.router_outputs
WHERE region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;

INSERT examples

create_router_output

Creates a new router output in AWS Elemental MediaConnect.

INSERT INTO aws.mediaconnect.router_outputs (
Name,
Configuration,
MaximumBitrate,
RoutingScope,
Tier,
RegionName,
AvailabilityZone,
MaintenanceConfiguration,
Tags,
FabricConfiguration,
ClientToken,
region
)
SELECT 
'{{ Name }}',
'{{ Configuration }}' /* required */,
{{ MaximumBitrate }} /* required */,
'{{ RoutingScope }}' /* required */,
'{{ Tier }}' /* required */,
'{{ RegionName }}',
'{{ AvailabilityZone }}',
'{{ MaintenanceConfiguration }}',
'{{ Tags }}',
'{{ FabricConfiguration }}',
'{{ ClientToken }}',
'{{ region }}'
RETURNING
router_output
;

Manifest

# Description fields are for documentation purposes
- name: router_outputs
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the router_outputs resource.
  - name: Name
    value: "{{ Name }}"
  - name: Configuration
    description: |
      The configuration settings for a router output.
    value:
      Standard:
        NetworkInterfaceArn: "{{ NetworkInterfaceArn }}"
        ProtocolConfiguration:
          Rist:
            DestinationAddress: "{{ DestinationAddress }}"
            DestinationPort: {{ DestinationPort }}
          SrtListener:
            Port: {{ Port }}
            MinimumLatencyMilliseconds: {{ MinimumLatencyMilliseconds }}
            EncryptionConfiguration:
              EncryptionKey: "{{ EncryptionKey }}"
          SrtCaller:
            DestinationAddress: "{{ DestinationAddress }}"
            DestinationPort: {{ DestinationPort }}
            MinimumLatencyMilliseconds: {{ MinimumLatencyMilliseconds }}
            StreamId: "{{ StreamId }}"
            EncryptionConfiguration:
              EncryptionKey: "{{ EncryptionKey }}"
          Rtp:
            DestinationAddress: "{{ DestinationAddress }}"
            DestinationPort: {{ DestinationPort }}
            ForwardErrorCorrection: "{{ ForwardErrorCorrection }}"
        Protocol: "{{ Protocol }}"
      MediaConnectFlow:
        FlowArn: "{{ FlowArn }}"
        FlowSourceArn: "{{ FlowSourceArn }}"
        DestinationTransitEncryption:
          EncryptionKeyType: "{{ EncryptionKeyType }}"
          EncryptionKeyConfiguration:
            SecretsManager:
              SecretArn: "{{ SecretArn }}"
              RoleArn: "{{ RoleArn }}"
            Automatic: "{{ Automatic }}"
      MediaLiveInput:
        MediaLiveInputArn: "{{ MediaLiveInputArn }}"
        MediaLivePipelineId: "{{ MediaLivePipelineId }}"
        DestinationTransitEncryption:
          EncryptionKeyType: "{{ EncryptionKeyType }}"
          EncryptionKeyConfiguration:
            SecretsManager:
              SecretArn: "{{ SecretArn }}"
              RoleArn: "{{ RoleArn }}"
            Automatic: "{{ Automatic }}"
  - name: MaximumBitrate
    value: {{ MaximumBitrate }}
  - name: RoutingScope
    value: "{{ RoutingScope }}"
    valid_values: ['REGIONAL', 'GLOBAL']
  - name: Tier
    value: "{{ Tier }}"
    valid_values: ['OUTPUT_100', 'OUTPUT_50', 'OUTPUT_20']
  - name: RegionName
    value: "{{ RegionName }}"
  - name: AvailabilityZone
    value: "{{ AvailabilityZone }}"
  - name: MaintenanceConfiguration
    description: |
      The configuration settings for maintenance operations, including preferred maintenance windows and schedules.
    value:
      PreferredDayTime:
        Day: "{{ Day }}"
        Time: "{{ Time }}"
      Default: "{{ Default }}"
  - name: Tags
    value: "{{ Tags }}"
  - name: FabricConfiguration
    description: |
      The fabric configuration settings for the router output.
    value:
      RecoveryLatencyMode: "{{ RecoveryLatencyMode }}"
  - name: ClientToken
    value: "{{ ClientToken }}"

UPDATE examples

update_router_output

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

UPDATE aws.mediaconnect.router_outputs
SET 
Name = '{{ Name }}',
Configuration = '{{ Configuration }}',
MaximumBitrate = {{ MaximumBitrate }},
RoutingScope = '{{ RoutingScope }}',
Tier = '{{ Tier }}',
MaintenanceConfiguration = '{{ MaintenanceConfiguration }}',
FabricConfiguration = '{{ FabricConfiguration }}'
WHERE 
arn = '{{ arn }}' --required
AND region = '{{ region }}' --required
RETURNING
router_output;

DELETE examples

delete_router_output

Deletes a router output from AWS Elemental MediaConnect.

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

Lifecycle Methods

take_router_input

Associates a router input with a router output in AWS Elemental MediaConnect.

EXEC aws.mediaconnect.router_outputs.take_router_input 
@router_output_arn='{{ router_output_arn }}' --required, 
@region='{{ region }}' --required 
@@json=
'{
"RouterInputArn": "{{ RouterInputArn }}"
}'
;