router_inputs

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

Overview

Name	router_inputs
Type	Resource
Id	aws.mediaconnect.router_inputs

Fields

The following fields are returned by SELECT queries:

batch_get_router_input

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

get_router_input

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) of the router input. (pattern: <code>arn:(aws[a-zA-Z-]*):mediaconnect:[a-z0-9-]+:[0-9]{12}:routerInput:[a-z0-9]{12}</code>)
availability_zone	string	The Availability Zone of the router input.
configuration	object	The configuration settings for a router input.
content_quality_analysis_configuration	object	The content quality analysis configuration for the router input.
content_quality_analysis_type	string	The type of content quality analysis applied to the router input. (CONTENT_LEVEL)
created_at	string (date-time)	The timestamp when the router input was created.
id	string	The unique identifier of the router input.
input_type	string	The type of the router input. (STANDARD, FAILOVER, MERGE, MEDIACONNECT_FLOW, MEDIALIVE_CHANNEL)
ip_address	string	The IP address of the router input.
maintenance_configuration	object	The maintenance configuration settings applied to this router input.
maintenance_schedule	object	The current maintenance schedule details for this router input.
maintenance_schedule_type	string	The type of maintenance schedule currently in effect for this router input. (WINDOW)
maintenance_type	string	The type of maintenance configuration applied to this router input. (PREFERRED_DAY_TIME, DEFAULT)
maximum_bitrate	integer (int64)	The maximum bitrate for the router input.
maximum_routed_outputs	integer	The maximum number of outputs that can be simultaneously routed to this input.
messages	array	The messages associated with the router input.
name	string	The name of the router input.
region_name	string	The Amazon Web Services Region where the router input is located.
routed_outputs	integer	The number of router outputs associated with the router input.
routing_scope	string	Indicates whether the router input is configured for Regional or global routing. (REGIONAL, GLOBAL)
state	string	The current state of the router input. (CREATING, STANDBY, STARTING, ACTIVE, STOPPING, DELETING, UPDATING, ERROR, RECOVERING, MIGRATING)
stream_details	object	Configuration details for the router input stream.
tags	object	Key-value pairs that can be used to tag and organize this router input.
tier	string	The tier level of the router input. (INPUT_100, INPUT_50, INPUT_20)
transit_encryption	object	The transit encryption settings for a router input.
updated_at	string (date-time)	The timestamp when the router input was last updated.

list_router_inputs

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

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
batch_get_router_input	select	arns, region		Retrieves information about multiple router inputs in AWS Elemental MediaConnect.
get_router_input	select	arn, region		Retrieves information about a specific router input in AWS Elemental MediaConnect.
list_router_inputs	select	region	maxResults, nextToken	Retrieves a list of router inputs in AWS Elemental MediaConnect.
create_router_input	insert	region, Configuration, MaximumBitrate, RoutingScope, Tier		Creates a new router input in AWS Elemental MediaConnect.
update_router_input	update	arn, region		Updates the configuration of an existing router input in AWS Elemental MediaConnect.
delete_router_input	delete	arn, region		Deletes a router input 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 input that you want to delete.
arns	array	The Amazon Resource Names (ARNs) of the router inputs you want to retrieve information about.
region	string	AWS region (default: us-east-1)
maxResults	integer	The maximum number of router inputs to return in the response.
nextToken	string	A token used to retrieve the next page of results.

SELECT examples

batch_get_router_input

Retrieves information about multiple router inputs in AWS Elemental MediaConnect.

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

get_router_input

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

SELECT
arn,
availability_zone,
configuration,
content_quality_analysis_configuration,
content_quality_analysis_type,
created_at,
id,
input_type,
ip_address,
maintenance_configuration,
maintenance_schedule,
maintenance_schedule_type,
maintenance_type,
maximum_bitrate,
maximum_routed_outputs,
messages,
name,
region_name,
routed_outputs,
routing_scope,
state,
stream_details,
tags,
tier,
transit_encryption,
updated_at
FROM aws.mediaconnect.router_inputs
WHERE arn = '{{ arn }}' -- required
AND region = '{{ region }}' -- required
;

list_router_inputs

Retrieves a list of router inputs in AWS Elemental MediaConnect.

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

INSERT examples

create_router_input

Creates a new router input in AWS Elemental MediaConnect.

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

Manifest

# Description fields are for documentation purposes
- name: router_inputs
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the router_inputs resource.
  - name: Name
    value: "{{ Name }}"
  - name: Configuration
    description: |
      The configuration settings for a router input.
    value:
      Standard:
        NetworkInterfaceArn: "{{ NetworkInterfaceArn }}"
        ProtocolConfiguration:
          Rist:
            Port: {{ Port }}
            RecoveryLatencyMilliseconds: {{ RecoveryLatencyMilliseconds }}
          SrtListener:
            Port: {{ Port }}
            MinimumLatencyMilliseconds: {{ MinimumLatencyMilliseconds }}
            DecryptionConfiguration:
              EncryptionKey: "{{ EncryptionKey }}"
          SrtCaller:
            SourceAddress: "{{ SourceAddress }}"
            SourcePort: {{ SourcePort }}
            MinimumLatencyMilliseconds: {{ MinimumLatencyMilliseconds }}
            StreamId: "{{ StreamId }}"
            DecryptionConfiguration:
              EncryptionKey: "{{ EncryptionKey }}"
          Rtp:
            Port: {{ Port }}
            ForwardErrorCorrection: "{{ ForwardErrorCorrection }}"
        Protocol: "{{ Protocol }}"
      MediaLiveChannel:
        MediaLiveChannelArn: "{{ MediaLiveChannelArn }}"
        MediaLivePipelineId: "{{ MediaLivePipelineId }}"
        MediaLiveChannelOutputName: "{{ MediaLiveChannelOutputName }}"
        SourceTransitDecryption:
          EncryptionKeyType: "{{ EncryptionKeyType }}"
          EncryptionKeyConfiguration:
            SecretsManager:
              SecretArn: "{{ SecretArn }}"
              RoleArn: "{{ RoleArn }}"
            Automatic: "{{ Automatic }}"
      Failover:
        NetworkInterfaceArn: "{{ NetworkInterfaceArn }}"
        ProtocolConfigurations:
          - Rist:
              Port: {{ Port }}
              RecoveryLatencyMilliseconds: {{ RecoveryLatencyMilliseconds }}
            SrtListener:
              Port: {{ Port }}
              MinimumLatencyMilliseconds: {{ MinimumLatencyMilliseconds }}
              DecryptionConfiguration:
                EncryptionKey: "{{ EncryptionKey }}"
            SrtCaller:
              SourceAddress: "{{ SourceAddress }}"
              SourcePort: {{ SourcePort }}
              MinimumLatencyMilliseconds: {{ MinimumLatencyMilliseconds }}
              StreamId: "{{ StreamId }}"
              DecryptionConfiguration:
                EncryptionKey: "{{ EncryptionKey }}"
            Rtp:
              Port: {{ Port }}
              ForwardErrorCorrection: "{{ ForwardErrorCorrection }}"
        SourcePriorityMode: "{{ SourcePriorityMode }}"
        PrimarySourceIndex: {{ PrimarySourceIndex }}
      MediaConnectFlow:
        FlowArn: "{{ FlowArn }}"
        FlowOutputArn: "{{ FlowOutputArn }}"
        SourceTransitDecryption:
          EncryptionKeyType: "{{ EncryptionKeyType }}"
          EncryptionKeyConfiguration:
            SecretsManager:
              SecretArn: "{{ SecretArn }}"
              RoleArn: "{{ RoleArn }}"
            Automatic: "{{ Automatic }}"
      Merge:
        NetworkInterfaceArn: "{{ NetworkInterfaceArn }}"
        ProtocolConfigurations:
          - Rtp:
              Port: {{ Port }}
              ForwardErrorCorrection: "{{ ForwardErrorCorrection }}"
            Rist:
              Port: {{ Port }}
              RecoveryLatencyMilliseconds: {{ RecoveryLatencyMilliseconds }}
        MergeRecoveryWindowMilliseconds: {{ MergeRecoveryWindowMilliseconds }}
  - name: MaximumBitrate
    value: {{ MaximumBitrate }}
  - name: RoutingScope
    value: "{{ RoutingScope }}"
    valid_values: ['REGIONAL', 'GLOBAL']
  - name: Tier
    value: "{{ Tier }}"
    valid_values: ['INPUT_100', 'INPUT_50', 'INPUT_20']
  - name: RegionName
    value: "{{ RegionName }}"
  - name: AvailabilityZone
    value: "{{ AvailabilityZone }}"
  - name: TransitEncryption
    description: |
      The transit encryption settings for a router input.
    value:
      EncryptionKeyType: "{{ EncryptionKeyType }}"
      EncryptionKeyConfiguration:
        SecretsManager:
          SecretArn: "{{ SecretArn }}"
          RoleArn: "{{ RoleArn }}"
        Automatic: "{{ Automatic }}"
  - 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: ClientToken
    value: "{{ ClientToken }}"
  - name: ContentQualityAnalysisConfiguration
    description: |
      The content quality analysis configuration for the router input. The content quality analysis feature only monitors the first video stream and the first audio stream it encounters within the router input source.
    value:
      ContentLevel:
        BlackFrames:
          State: "{{ State }}"
          ThresholdSeconds: {{ ThresholdSeconds }}
        FrozenFrames:
          State: "{{ State }}"
          ThresholdSeconds: {{ ThresholdSeconds }}
        SilentAudio:
          State: "{{ State }}"
          ThresholdSeconds: {{ ThresholdSeconds }}

UPDATE examples

update_router_input

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

UPDATE aws.mediaconnect.router_inputs
SET 
Name = '{{ Name }}',
Configuration = '{{ Configuration }}',
MaximumBitrate = {{ MaximumBitrate }},
RoutingScope = '{{ RoutingScope }}',
Tier = '{{ Tier }}',
TransitEncryption = '{{ TransitEncryption }}',
MaintenanceConfiguration = '{{ MaintenanceConfiguration }}',
ContentQualityAnalysisConfiguration = '{{ ContentQualityAnalysisConfiguration }}'
WHERE 
arn = '{{ arn }}' --required
AND region = '{{ region }}' --required
RETURNING
router_input;

DELETE examples

delete_router_input

Deletes a router input from AWS Elemental MediaConnect.

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