Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . mediaconnect ]

update-router-output¶

Description¶

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

Synopsis¶

  update-router-output
--arn <value>
[--name <value>]
[--configuration <value>]
[--maximum-bitrate <value>]
[--routing-scope <value>]
[--tier <value>]
[--maintenance-configuration <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--v2-debug]

Options¶

--arn (string)

The Amazon Resource Name (ARN) of the router output that you want to update.

--name (string)

The updated name for the router output.

--configuration (tagged union structure)

The updated configuration settings for the router output. Changing the type of the configuration is not supported.

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: Standard, MediaConnectFlow, MediaLiveInput.

Standard -> (structure)

The configuration settings for a standard router output, including the protocol, protocol-specific configuration, network interface, and availability zone.

NetworkInterfaceArn -> (string)

The Amazon Resource Name (ARN) of the network interface associated with the standard router output.

ProtocolConfiguration -> (tagged union structure)

The configuration settings for the protocol used by the standard router output.

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: Rtp, Rist, SrtListener, SrtCaller.

Rtp -> (structure)

The configuration settings for a router output using the RTP (Real-Time Transport Protocol) protocol, including the destination address and port, and forward error correction state.

DestinationAddress -> (string)

The destination IP address for the RTP protocol in the router output configuration.

DestinationPort -> (integer)

The destination port number for the RTP protocol in the router output configuration.

ForwardErrorCorrection -> (string)

The state of forward error correction for the RTP protocol in the router output configuration.

Rist -> (structure)

The configuration settings for a router output using the RIST (Reliable Internet Stream Transport) protocol, including the destination address and port.

DestinationAddress -> (string)

The destination IP address for the RIST protocol in the router output configuration.

DestinationPort -> (integer)

The destination port number for the RIST protocol in the router output configuration.

SrtListener -> (structure)

The configuration settings for a router output using the SRT (Secure Reliable Transport) protocol in listener mode, including the port, minimum latency, and encryption key configuration.

Port -> (integer)

The port number for the SRT protocol in listener mode.

MinimumLatencyMilliseconds -> (long)

The minimum latency in milliseconds for the SRT protocol in listener mode.

EncryptionConfiguration -> (structure)

Defines the encryption settings for an SRT listener output, including the encryption key configuration and associated parameters.

EncryptionKey -> (structure)

Specifies the encryption key configuration used for encrypting SRT streams, including the key source and associated credentials.

SecretArn -> (string)

The ARN of the AWS Secrets Manager secret used for transit encryption.

RoleArn -> (string)

The ARN of the IAM role assumed by MediaConnect to access the AWS Secrets Manager secret.

SrtCaller -> (structure)

The configuration settings for a router output using the SRT (Secure Reliable Transport) protocol in caller mode, including the destination address and port, minimum latency, stream ID, and encryption key configuration.

DestinationAddress -> (string)

The destination IP address for the SRT protocol in caller mode.

DestinationPort -> (integer)

The destination port number for the SRT protocol in caller mode.

MinimumLatencyMilliseconds -> (long)

The minimum latency in milliseconds for the SRT protocol in caller mode.

StreamId -> (string)

The stream ID for the SRT protocol in caller mode.

EncryptionConfiguration -> (structure)

Defines the encryption settings for an SRT caller output, including the encryption key configuration and associated parameters.

EncryptionKey -> (structure)

Specifies the encryption key configuration used for encrypting SRT streams, including the key source and associated credentials.

SecretArn -> (string)

The ARN of the AWS Secrets Manager secret used for transit encryption.

RoleArn -> (string)

The ARN of the IAM role assumed by MediaConnect to access the AWS Secrets Manager secret.

Protocol -> (string)

The protocol used by the standard router output.

MediaConnectFlow -> (structure)

Configuration settings for connecting a router output to a MediaConnect flow source.

FlowArn -> (string)

The ARN of the flow to connect to this router output.

FlowSourceArn -> (string)

The ARN of the flow source to connect to this router output.

DestinationTransitEncryption -> (structure)

The encryption configuration for the flow destination when connected to this router output.

EncryptionKeyType -> (string)

The type of encryption key to use for flow transit encryption.

EncryptionKeyConfiguration -> (tagged union structure)

The configuration details for the encryption key.

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: SecretsManager, Automatic.

SecretsManager -> (structure)

The configuration settings for transit encryption using AWS Secrets Manager, including the secret ARN and role ARN.

SecretArn -> (string)

The ARN of the AWS Secrets Manager secret used for transit encryption.

RoleArn -> (string)

The ARN of the IAM role assumed by MediaConnect to access the AWS Secrets Manager secret.

Automatic -> (structure)

Configuration settings for automatic encryption key management, where MediaConnect handles key creation and rotation.

MediaLiveInput -> (structure)

Configuration settings for connecting a router output to a MediaLive input.

MediaLiveInputArn -> (string)

The ARN of the MediaLive input to connect to this router output.

MediaLivePipelineId -> (string)

The index of the MediaLive pipeline to connect to this router output.

DestinationTransitEncryption -> (structure)

The encryption configuration for the MediaLive input when connected to this router output.

EncryptionKeyType -> (string)

The type of encryption key to use for MediaLive transit encryption.

EncryptionKeyConfiguration -> (tagged union structure)

The configuration details for the MediaLive encryption key.

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: SecretsManager, Automatic.

SecretsManager -> (structure)

The configuration settings for transit encryption using AWS Secrets Manager, including the secret ARN and role ARN.

SecretArn -> (string)

The ARN of the AWS Secrets Manager secret used for transit encryption.

RoleArn -> (string)

The ARN of the IAM role assumed by MediaConnect to access the AWS Secrets Manager secret.

Automatic -> (structure)

Configuration settings for automatic encryption key management, where MediaConnect handles key creation and rotation.

JSON Syntax:

{
  "Standard": {
    "NetworkInterfaceArn": "string",
    "ProtocolConfiguration": {
      "Rtp": {
        "DestinationAddress": "string",
        "DestinationPort": integer,
        "ForwardErrorCorrection": "ENABLED"|"DISABLED"
      },
      "Rist": {
        "DestinationAddress": "string",
        "DestinationPort": integer
      },
      "SrtListener": {
        "Port": integer,
        "MinimumLatencyMilliseconds": long,
        "EncryptionConfiguration": {
          "EncryptionKey": {
            "SecretArn": "string",
            "RoleArn": "string"
          }
        }
      },
      "SrtCaller": {
        "DestinationAddress": "string",
        "DestinationPort": integer,
        "MinimumLatencyMilliseconds": long,
        "StreamId": "string",
        "EncryptionConfiguration": {
          "EncryptionKey": {
            "SecretArn": "string",
            "RoleArn": "string"
          }
        }
      }
    },
    "Protocol": "RTP"|"RIST"|"SRT_CALLER"|"SRT_LISTENER"
  },
  "MediaConnectFlow": {
    "FlowArn": "string",
    "FlowSourceArn": "string",
    "DestinationTransitEncryption": {
      "EncryptionKeyType": "SECRETS_MANAGER"|"AUTOMATIC",
      "EncryptionKeyConfiguration": {
        "SecretsManager": {
          "SecretArn": "string",
          "RoleArn": "string"
        },
        "Automatic": {

        }
      }
    }
  },
  "MediaLiveInput": {
    "MediaLiveInputArn": "string",
    "MediaLivePipelineId": "PIPELINE_0"|"PIPELINE_1",
    "DestinationTransitEncryption": {
      "EncryptionKeyType": "SECRETS_MANAGER"|"AUTOMATIC",
      "EncryptionKeyConfiguration": {
        "SecretsManager": {
          "SecretArn": "string",
          "RoleArn": "string"
        },
        "Automatic": {

        }
      }
    }
  }
}

--maximum-bitrate (long)

The updated maximum bitrate for the router output.

--routing-scope (string)

Specifies whether the router output can take inputs that are in different Regions. REGIONAL (default) - can only take inputs from same Region. GLOBAL - can take inputs from any Region.

Possible values:

REGIONAL

GLOBAL

--tier (string)

The updated tier level for the router output.

Possible values:

OUTPUT_100

OUTPUT_50

OUTPUT_20

--maintenance-configuration (tagged union structure)

The updated maintenance configuration settings for the router output, including any changes to preferred maintenance windows and schedules.

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: PreferredDayTime, Default.

PreferredDayTime -> (structure)

Preferred day and time maintenance configuration settings.

Day -> (string)

The preferred day for maintenance operations.

Time -> (string)

The preferred time for maintenance operations.

Default -> (structure)

Default maintenance configuration settings.

Shorthand Syntax:

PreferredDayTime={Day=string,Time=string},Default={}

JSON Syntax:

{
  "PreferredDayTime": {
    "Day": "MONDAY"|"TUESDAY"|"WEDNESDAY"|"THURSDAY"|"FRIDAY"|"SATURDAY"|"SUNDAY",
    "Time": "string"
  },
  "Default": {

  }
}

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options¶

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

json
text
table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

on
off
auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--v2-debug (boolean)

Enable AWS CLI v2 migration assistance. Prints warnings if the command would face a breaking change after swapping AWS CLI v1 for AWS CLI v2 in the current environment. Prints one warning for each breaking change detected.

Output¶

RouterOutput -> (structure)

The updated router output.

Name -> (string)

The name of the router output.

Arn -> (string)

The Amazon Resource Name (ARN) of the router output.

Id -> (string)

The unique identifier of the router output.

State -> (string)

The overall state of the router output.

OutputType -> (string)

The type of the router output.

Configuration -> (tagged union structure)

The configuration settings for a router output.

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: Standard, MediaConnectFlow, MediaLiveInput.

Standard -> (structure)

The configuration settings for a standard router output, including the protocol, protocol-specific configuration, network interface, and availability zone.

NetworkInterfaceArn -> (string)

The Amazon Resource Name (ARN) of the network interface associated with the standard router output.

ProtocolConfiguration -> (tagged union structure)

The configuration settings for the protocol used by the standard router output.

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: Rtp, Rist, SrtListener, SrtCaller.

Rtp -> (structure)

The configuration settings for a router output using the RTP (Real-Time Transport Protocol) protocol, including the destination address and port, and forward error correction state.

DestinationAddress -> (string)

The destination IP address for the RTP protocol in the router output configuration.

DestinationPort -> (integer)

The destination port number for the RTP protocol in the router output configuration.

ForwardErrorCorrection -> (string)

The state of forward error correction for the RTP protocol in the router output configuration.

Rist -> (structure)

The configuration settings for a router output using the RIST (Reliable Internet Stream Transport) protocol, including the destination address and port.

DestinationAddress -> (string)

The destination IP address for the RIST protocol in the router output configuration.

DestinationPort -> (integer)

The destination port number for the RIST protocol in the router output configuration.

SrtListener -> (structure)

The configuration settings for a router output using the SRT (Secure Reliable Transport) protocol in listener mode, including the port, minimum latency, and encryption key configuration.

Port -> (integer)

The port number for the SRT protocol in listener mode.

MinimumLatencyMilliseconds -> (long)

The minimum latency in milliseconds for the SRT protocol in listener mode.

EncryptionConfiguration -> (structure)

Defines the encryption settings for an SRT listener output, including the encryption key configuration and associated parameters.

EncryptionKey -> (structure)

Specifies the encryption key configuration used for encrypting SRT streams, including the key source and associated credentials.

SecretArn -> (string)

The ARN of the AWS Secrets Manager secret used for transit encryption.

RoleArn -> (string)

The ARN of the IAM role assumed by MediaConnect to access the AWS Secrets Manager secret.

SrtCaller -> (structure)

The configuration settings for a router output using the SRT (Secure Reliable Transport) protocol in caller mode, including the destination address and port, minimum latency, stream ID, and encryption key configuration.

DestinationAddress -> (string)

The destination IP address for the SRT protocol in caller mode.

DestinationPort -> (integer)

The destination port number for the SRT protocol in caller mode.

MinimumLatencyMilliseconds -> (long)

The minimum latency in milliseconds for the SRT protocol in caller mode.

StreamId -> (string)

The stream ID for the SRT protocol in caller mode.

EncryptionConfiguration -> (structure)

Defines the encryption settings for an SRT caller output, including the encryption key configuration and associated parameters.

EncryptionKey -> (structure)

Specifies the encryption key configuration used for encrypting SRT streams, including the key source and associated credentials.

SecretArn -> (string)

The ARN of the AWS Secrets Manager secret used for transit encryption.

RoleArn -> (string)

The ARN of the IAM role assumed by MediaConnect to access the AWS Secrets Manager secret.

Protocol -> (string)

The protocol used by the standard router output.

MediaConnectFlow -> (structure)

Configuration settings for connecting a router output to a MediaConnect flow source.

FlowArn -> (string)

The ARN of the flow to connect to this router output.

FlowSourceArn -> (string)

The ARN of the flow source to connect to this router output.

DestinationTransitEncryption -> (structure)

The encryption configuration for the flow destination when connected to this router output.

EncryptionKeyType -> (string)

The type of encryption key to use for flow transit encryption.

EncryptionKeyConfiguration -> (tagged union structure)

The configuration details for the encryption key.

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: SecretsManager, Automatic.

SecretsManager -> (structure)

The configuration settings for transit encryption using AWS Secrets Manager, including the secret ARN and role ARN.

SecretArn -> (string)

The ARN of the AWS Secrets Manager secret used for transit encryption.

RoleArn -> (string)

The ARN of the IAM role assumed by MediaConnect to access the AWS Secrets Manager secret.

Automatic -> (structure)

Configuration settings for automatic encryption key management, where MediaConnect handles key creation and rotation.

MediaLiveInput -> (structure)

Configuration settings for connecting a router output to a MediaLive input.

MediaLiveInputArn -> (string)

The ARN of the MediaLive input to connect to this router output.

MediaLivePipelineId -> (string)

The index of the MediaLive pipeline to connect to this router output.

DestinationTransitEncryption -> (structure)

The encryption configuration for the MediaLive input when connected to this router output.

EncryptionKeyType -> (string)

The type of encryption key to use for MediaLive transit encryption.

EncryptionKeyConfiguration -> (tagged union structure)

The configuration details for the MediaLive encryption key.

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: SecretsManager, Automatic.

SecretsManager -> (structure)

The configuration settings for transit encryption using AWS Secrets Manager, including the secret ARN and role ARN.

SecretArn -> (string)

The ARN of the AWS Secrets Manager secret used for transit encryption.

RoleArn -> (string)

The ARN of the IAM role assumed by MediaConnect to access the AWS Secrets Manager secret.

Automatic -> (structure)

Configuration settings for automatic encryption key management, where MediaConnect handles key creation and rotation.

RoutedState -> (string)

The current state of the association between the router output and its input.

RegionName -> (string)

The AWS Region where the router output is located.

AvailabilityZone -> (string)

The Availability Zone of the router output.

MaximumBitrate -> (long)

The maximum bitrate for the router output.

RoutingScope -> (string)

Indicates whether the router output is configured for Regional or global routing.

Tier -> (string)

The tier level of the router output.

CreatedAt -> (timestamp)

The timestamp when the router output was created.

UpdatedAt -> (timestamp)

The timestamp when the router output was last updated.

Messages -> (list)

The messages associated with the router output.

(structure)

A message associated with a router output.

Code -> (string)

The code associated with the router output message.

Message -> (string)

The message text associated with the router output message.

Tags -> (map)

Key-value pairs that can be used to tag and organize this router output.

key -> (string)

value -> (string)

StreamDetails -> (tagged union structure)

Information about the router output’s stream, including connection state and destination details. The specific details provided vary based on the router output type.

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: Standard, MediaConnectFlow, MediaLiveInput.

Standard -> (structure)

Configuration details for a standard router output stream type. Contains information about the destination IP address and connection state for basic output routing.

DestinationIpAddress -> (string)

The IP address where the output stream will be sent. This is the destination address that will receive the routed media content.

MediaConnectFlow -> (structure)

Configuration details for a MediaConnect flow when used as a router output destination.

MediaLiveInput -> (structure)

Configuration details for a MediaLive input when used as a router output destination.

IpAddress -> (string)

The IP address of the router output.

RoutedInputArn -> (string)

The Amazon Resource Name (ARN) of the router input associated with the output.

MaintenanceType -> (string)

The type of maintenance configuration applied to this router output.

MaintenanceConfiguration -> (tagged union structure)

The maintenance configuration settings applied to this router output.

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: PreferredDayTime, Default.

PreferredDayTime -> (structure)

Preferred day and time maintenance configuration settings.

Day -> (string)

The preferred day for maintenance operations.

Time -> (string)

The preferred time for maintenance operations.

Default -> (structure)

Default maintenance configuration settings.

MaintenanceScheduleType -> (string)

The type of maintenance schedule currently in effect for this router output.

MaintenanceSchedule -> (tagged union structure)

The current maintenance schedule details for this router output.

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: Window.

Window -> (structure)

Defines a specific time window for maintenance operations.

Start -> (timestamp)

The start time of the maintenance window.

End -> (timestamp)

The end time of the maintenance window.

ScheduledTime -> (timestamp)

The date and time when the maintenance window is scheduled to occur.

Table of Contents

Feedback

User Guide

Note:

update-router-output¶

Description¶

Synopsis¶

Options¶

Note

Note

Note

Note

Note

Global Options¶

Output¶

Note

Note

Note

Note

Note

Note

Note