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 | --cli-input-yaml]
[--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>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options¶

--arn (string) [required]

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

Constraints:

pattern: arn:(aws[a-zA-Z-]*):mediaconnect:[a-z0-9-]+:[0-9]{12}:routerOutput:[a-z0-9]{12}

--name (string)

The updated name for the router output.

Constraints:

min: 1

max: 128

--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) [required]

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

Constraints:

pattern: arn:(aws[a-zA-Z-]*):mediaconnect:[a-z0-9-]+:[0-9]{12}:routerNetworkInterface:[a-z0-9]{12}

ProtocolConfiguration -> (tagged union structure) [required]

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) [required]

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

DestinationPort -> (integer) [required]

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

Constraints:

min: 0

max: 65531

ForwardErrorCorrection -> (string)

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

Possible values:

ENABLED

DISABLED

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) [required]

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

DestinationPort -> (integer) [required]

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

Constraints:

min: 0

max: 65535

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) [required]

The port number for the SRT protocol in listener mode.

Constraints:

min: 3000

max: 30000

MinimumLatencyMilliseconds -> (long) [required]

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

Constraints:

min: 10

max: 10000

EncryptionConfiguration -> (structure)

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

EncryptionKey -> (structure) [required]

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

SecretArn -> (string) [required]

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

Constraints:

pattern: arn:(aws[a-zA-Z-]*):secretsmanager:[a-z0-9-]+:[0-9]{12}:secret:[a-zA-Z0-9/_+=.@-]+

RoleArn -> (string) [required]

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

Constraints:

pattern: arn:(aws[a-zA-Z-]*):iam::[0-9]{12}:role/[a-zA-Z0-9_+=,.@-]+

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) [required]

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

DestinationPort -> (integer) [required]

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

Constraints:

min: 0

max: 65535

MinimumLatencyMilliseconds -> (long) [required]

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

Constraints:

min: 10

max: 10000

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) [required]

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

SecretArn -> (string) [required]

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

Constraints:

pattern: arn:(aws[a-zA-Z-]*):secretsmanager:[a-z0-9-]+:[0-9]{12}:secret:[a-zA-Z0-9/_+=.@-]+

RoleArn -> (string) [required]

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

Constraints:

pattern: arn:(aws[a-zA-Z-]*):iam::[0-9]{12}:role/[a-zA-Z0-9_+=,.@-]+

Protocol -> (string)

The protocol used by the standard router output.

Possible values:

RTP

RIST

SRT_CALLER

SRT_LISTENER

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.

Constraints:

pattern: arn:(aws[a-zA-Z-]*):mediaconnect:[a-z0-9-]+:[0-9]{12}:flow:[a-zA-Z0-9-]+:[a-zA-Z0-9_-]+

FlowSourceArn -> (string)

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

Constraints:

pattern: arn:(aws[a-zA-Z-]*):mediaconnect:[a-z0-9-]+:[0-9]{12}:source:[a-zA-Z0-9-]+:[a-zA-Z0-9_-]+

DestinationTransitEncryption -> (structure) [required]

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.

Possible values:

SECRETS_MANAGER

AUTOMATIC

EncryptionKeyConfiguration -> (tagged union structure) [required]

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) [required]

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

Constraints:

pattern: arn:(aws[a-zA-Z-]*):secretsmanager:[a-z0-9-]+:[0-9]{12}:secret:[a-zA-Z0-9/_+=.@-]+

RoleArn -> (string) [required]

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

Constraints:

pattern: arn:(aws[a-zA-Z-]*):iam::[0-9]{12}:role/[a-zA-Z0-9_+=,.@-]+

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.

Constraints:

pattern: arn:(aws[a-zA-Z-]*):medialive:[a-z0-9-]+:[0-9]{12}:input:[a-zA-Z0-9]+

MediaLivePipelineId -> (string)

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

Possible values:

PIPELINE_0

PIPELINE_1

DestinationTransitEncryption -> (structure) [required]

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.

Possible values:

SECRETS_MANAGER

AUTOMATIC

EncryptionKeyConfiguration -> (tagged union structure) [required]

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) [required]

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

Constraints:

pattern: arn:(aws[a-zA-Z-]*):secretsmanager:[a-z0-9-]+:[0-9]{12}:secret:[a-zA-Z0-9/_+=.@-]+

RoleArn -> (string) [required]

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

Constraints:

pattern: arn:(aws[a-zA-Z-]*):iam::[0-9]{12}:role/[a-zA-Z0-9_+=,.@-]+

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) [required]

The preferred day for maintenance operations.

Possible values:

MONDAY

TUESDAY

WEDNESDAY

THURSDAY

FRIDAY

SATURDAY

SUNDAY

Time -> (string) [required]

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 | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

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
yaml
yaml-stream

--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.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

base64
raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Output¶

RouterOutput -> (structure)

The updated router output.

Name -> (string) [required]

The name of the router output.

Arn -> (string) [required]

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

Constraints:

pattern: arn:(aws[a-zA-Z-]*):mediaconnect:[a-z0-9-]+:[0-9]{12}:routerOutput:[a-z0-9]{12}

Id -> (string) [required]

The unique identifier of the router output.

State -> (string) [required]

The overall state of the router output.

Possible values:

CREATING

STANDBY

STARTING

ACTIVE

STOPPING

DELETING

UPDATING

ERROR

RECOVERING

MIGRATING

OutputType -> (string) [required]

The type of the router output.

Possible values:

STANDARD

MEDIACONNECT_FLOW

MEDIALIVE_INPUT

Configuration -> (tagged union structure) [required]

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) [required]

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

Constraints:

pattern: arn:(aws[a-zA-Z-]*):mediaconnect:[a-z0-9-]+:[0-9]{12}:routerNetworkInterface:[a-z0-9]{12}

ProtocolConfiguration -> (tagged union structure) [required]

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) [required]

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

DestinationPort -> (integer) [required]

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

Constraints:

min: 0

max: 65531

ForwardErrorCorrection -> (string)

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

Possible values:

ENABLED

DISABLED

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) [required]

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

DestinationPort -> (integer) [required]

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

Constraints:

min: 0

max: 65535

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) [required]

The port number for the SRT protocol in listener mode.

Constraints:

min: 3000

max: 30000

MinimumLatencyMilliseconds -> (long) [required]

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

Constraints:

min: 10

max: 10000

EncryptionConfiguration -> (structure)

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

EncryptionKey -> (structure) [required]

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

SecretArn -> (string) [required]

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

Constraints:

pattern: arn:(aws[a-zA-Z-]*):secretsmanager:[a-z0-9-]+:[0-9]{12}:secret:[a-zA-Z0-9/_+=.@-]+

RoleArn -> (string) [required]

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

Constraints:

pattern: arn:(aws[a-zA-Z-]*):iam::[0-9]{12}:role/[a-zA-Z0-9_+=,.@-]+

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) [required]

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

DestinationPort -> (integer) [required]

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

Constraints:

min: 0

max: 65535

MinimumLatencyMilliseconds -> (long) [required]

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

Constraints:

min: 10

max: 10000

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) [required]

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

SecretArn -> (string) [required]

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

Constraints:

pattern: arn:(aws[a-zA-Z-]*):secretsmanager:[a-z0-9-]+:[0-9]{12}:secret:[a-zA-Z0-9/_+=.@-]+

RoleArn -> (string) [required]

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

Constraints:

pattern: arn:(aws[a-zA-Z-]*):iam::[0-9]{12}:role/[a-zA-Z0-9_+=,.@-]+

Protocol -> (string)

The protocol used by the standard router output.

Possible values:

RTP

RIST

SRT_CALLER

SRT_LISTENER

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.

Constraints:

pattern: arn:(aws[a-zA-Z-]*):mediaconnect:[a-z0-9-]+:[0-9]{12}:flow:[a-zA-Z0-9-]+:[a-zA-Z0-9_-]+

FlowSourceArn -> (string)

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

Constraints:

pattern: arn:(aws[a-zA-Z-]*):mediaconnect:[a-z0-9-]+:[0-9]{12}:source:[a-zA-Z0-9-]+:[a-zA-Z0-9_-]+

DestinationTransitEncryption -> (structure) [required]

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.

Possible values:

SECRETS_MANAGER

AUTOMATIC

EncryptionKeyConfiguration -> (tagged union structure) [required]

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) [required]

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

Constraints:

pattern: arn:(aws[a-zA-Z-]*):secretsmanager:[a-z0-9-]+:[0-9]{12}:secret:[a-zA-Z0-9/_+=.@-]+

RoleArn -> (string) [required]

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

Constraints:

pattern: arn:(aws[a-zA-Z-]*):iam::[0-9]{12}:role/[a-zA-Z0-9_+=,.@-]+

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.

Constraints:

pattern: arn:(aws[a-zA-Z-]*):medialive:[a-z0-9-]+:[0-9]{12}:input:[a-zA-Z0-9]+

MediaLivePipelineId -> (string)

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

Possible values:

PIPELINE_0

PIPELINE_1

DestinationTransitEncryption -> (structure) [required]

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.

Possible values:

SECRETS_MANAGER

AUTOMATIC

EncryptionKeyConfiguration -> (tagged union structure) [required]

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) [required]

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

Constraints:

pattern: arn:(aws[a-zA-Z-]*):secretsmanager:[a-z0-9-]+:[0-9]{12}:secret:[a-zA-Z0-9/_+=.@-]+

RoleArn -> (string) [required]

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

Constraints:

pattern: arn:(aws[a-zA-Z-]*):iam::[0-9]{12}:role/[a-zA-Z0-9_+=,.@-]+

Automatic -> (structure)

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

RoutedState -> (string) [required]

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

Possible values:

ROUTED

ROUTING

UNROUTED

RegionName -> (string) [required]

The AWS Region where the router output is located.

AvailabilityZone -> (string) [required]

The Availability Zone of the router output.

MaximumBitrate -> (long) [required]

The maximum bitrate for the router output.

RoutingScope -> (string) [required]

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

Possible values:

REGIONAL

GLOBAL

Tier -> (string) [required]

The tier level of the router output.

Possible values:

OUTPUT_100

OUTPUT_50

OUTPUT_20

CreatedAt -> (timestamp) [required]

The timestamp when the router output was created.

UpdatedAt -> (timestamp) [required]

The timestamp when the router output was last updated.

Messages -> (list) [required]

The messages associated with the router output.

(structure)

A message associated with a router output.

Code -> (string) [required]

The code associated with the router output message.

Message -> (string) [required]

The message text associated with the router output message.

Tags -> (map) [required]

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

key -> (string)

value -> (string)

StreamDetails -> (tagged union structure) [required]

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.

Constraints:

pattern: arn:(aws[a-zA-Z-]*):mediaconnect:[a-z0-9-]+:[0-9]{12}:routerInput:[a-z0-9]{12}

MaintenanceType -> (string) [required]

The type of maintenance configuration applied to this router output.

Possible values:

PREFERRED_DAY_TIME

DEFAULT

MaintenanceConfiguration -> (tagged union structure) [required]

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) [required]

The preferred day for maintenance operations.

Possible values:

MONDAY

TUESDAY

WEDNESDAY

THURSDAY

FRIDAY

SATURDAY

SUNDAY

Time -> (string) [required]

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.

Possible values:

WINDOW

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) [required]

The start time of the maintenance window.

End -> (timestamp) [required]

The end time of the maintenance window.

ScheduledTime -> (timestamp) [required]

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

Table of Contents

Feedback

User Guide

update-router-output¶

Description¶

Synopsis¶

Options¶

Note

Note

Note

Note

Note

Global Options¶

Output¶

Note

Note

Note

Note

Note

Note

Note