AWS cli documentation change
Summary
Updated AWS CLI version reference and added documentation about NDI source handling. Changes include: new operational note about flow size/source type updates, added encoding-config parameter for NDI transcoding, clarified NDI configuration settings, added new flow size option (LARGE_4X), updated Secrets Manager references, and added NdiSourceSettings structure.
Security assessment
The changes primarily involve feature enhancements (NDI source handling, new encoding options) and documentation clarifications. There are no references to security vulnerabilities, patches, or incident responses. The Secrets Manager reference updates are branding changes ('AWS Secrets Manager' to 'Secrets Manager') without security implications.
Diff
diff --git a/cli/latest/reference/mediaconnect/update-flow.md b/cli/latest/reference/mediaconnect/update-flow.md index 37d80bd9e..e2fb58cfc 100644 --- a//cli/latest/reference/mediaconnect/update-flow.md +++ b//cli/latest/reference/mediaconnect/update-flow.md @@ -15 +15 @@ - * [AWS CLI 2.33.8 Command Reference](../../index.html) » + * [AWS CLI 2.33.12 Command Reference](../../index.html) » @@ -60,0 +61,13 @@ Updates an existing flow. +### Note + +Because `UpdateFlowSources` and `UpdateFlow` are separate operations, you can’t change both the source type AND the flow size in a single request. + + * If you have a `MEDIUM` flow and you want to change the flow source to NDI®: + * First, use the `UpdateFlow` operation to upgrade the flow size to `LARGE` . + * After that, you can then use the `UpdateFlowSource` operation to configure the NDI source. + * If you’re switching from an NDI source to a transport stream (TS) source and want to downgrade the flow size: + * First, use the `UpdateFlowSource` operation to change the flow source type. + * After that, you can then use the `UpdateFlow` operation to downgrade the flow size to `MEDIUM` . + + + @@ -72,0 +86 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/mediac + [--encoding-config <value>] @@ -340 +354 @@ JSON Syntax: -> Specifies the configuration settings for NDI outputs. Required when the flow includes NDI outputs. +> Specifies the configuration settings for a flow’s NDI source or output. Required when the flow includes an NDI source or output. @@ -344 +358,3 @@ JSON Syntax: ->> A setting that controls whether NDI outputs can be used in the flow. Must be ENABLED to add NDI outputs. Default is DISABLED. +>> A setting that controls whether NDI® sources or outputs can be used in the flow. +>> +>> The default value is `DISABLED` . This value must be set as `ENABLED` for your flow to support NDI sources or outputs. @@ -363 +379 @@ JSON Syntax: ->>> Specifies the configuration settings for individual NDI discovery servers. A maximum of 3 servers is allowed. +>>> Specifies the configuration settings for individual NDI® discovery servers. A maximum of 3 servers is allowed. @@ -407,0 +424,20 @@ JSON Syntax: +> * `LARGE_4X` +> + + +`--encoding-config` (structure) + +> The encoding configuration to apply to the NDI® source when transcoding it to a transport stream for downstream distribution. You can choose between several predefined encoding profiles based on common use cases. +> +> EncodingProfile -> (string) +> +>> The encoding profile to use when transcoding the NDI source content to a transport stream. You can change this value while the flow is running. +>> +>> Possible values: +>> +>> * `DISTRIBUTION_H264_DEFAULT` +>> * `CONTRIBUTION_H264_DEFAULT` +>> + +> +> VideoMaxBitrate -> (integer) @@ -408,0 +445,17 @@ JSON Syntax: +>> The maximum video bitrate to use when transcoding the NDI source to a transport stream. This parameter enables you to override the default video bitrate within the encoding profile’s supported range. +>> +>> The supported range is 10,000,000 - 50,000,000 bits per second (bps). If you don’t specify a value, MediaConnect uses the default value of 20,000,000 bps. + +Shorthand Syntax: + + + EncodingProfile=string,VideoMaxBitrate=integer + + +JSON Syntax: + + + { + "EncodingProfile": "DISTRIBUTION_H264_DEFAULT"|"CONTRIBUTION_H264_DEFAULT", + "VideoMaxBitrate": integer + } @@ -1014 +1067,9 @@ Flow -> (structure) ->>>>> A suffix for the names of the NDI sources that the flow creates. If a custom name isn’t specified, MediaConnect uses the output name. +>>>>> A suffix for the name of the NDI® sender that the flow creates. If a custom name isn’t specified, MediaConnect uses the output name. +>>>> +>>>> NdiSourceSettings -> (structure) +>>>> +>>>>> The settings for the NDI source. This includes the exact name of the upstream NDI sender that you want to connect to your source. +>>>>> +>>>>> SourceName -> (string) +>>>>> +>>>>>> The exact name of an existing NDI sender that’s registered with your discovery server. If included, the format of this name must be `MACHINENAME (ProgramName)` . @@ -1053 +1114 @@ Flow -> (structure) ->>>> * Peer IP addresses aren’t available for entitlements, managed MediaLive outputs, NDI outputs, and CDI/ST2110 outputs. +>>>> * Peer IP addresses aren’t available for entitlements, managed MediaLive outputs, NDI® sources and outputs, and CDI/ST2110 outputs. @@ -1094 +1155 @@ Flow -> (structure) ->>>>>> The configuration settings for transit encryption using AWS Secrets Manager, including the secret ARN and role ARN. +>>>>>> The configuration settings for transit encryption using Secrets Manager, including the secret ARN and role ARN. @@ -1098 +1159 @@ Flow -> (structure) ->>>>>>> The ARN of the AWS Secrets Manager secret used for transit encryption. +>>>>>>> The ARN of the Secrets Manager secret used for transit encryption. @@ -1108 +1169 @@ Flow -> (structure) ->>>>>>> The ARN of the IAM role assumed by MediaConnect to access the AWS Secrets Manager secret. +>>>>>>> The ARN of the IAM role assumed by MediaConnect to access the Secrets Manager secret. @@ -1354 +1415,9 @@ Flow -> (structure) ->>>> A suffix for the names of the NDI sources that the flow creates. If a custom name isn’t specified, MediaConnect uses the output name. +>>>> A suffix for the name of the NDI® sender that the flow creates. If a custom name isn’t specified, MediaConnect uses the output name. +>>> +>>> NdiSourceSettings -> (structure) +>>> +>>>> The settings for the NDI source. This includes the exact name of the upstream NDI sender that you want to connect to your source. +>>>> +>>>> SourceName -> (string) +>>>> +>>>>> The exact name of an existing NDI sender that’s registered with your discovery server. If included, the format of this name must be `MACHINENAME (ProgramName)` . @@ -1429 +1498 @@ Flow -> (structure) ->>>>> The configuration settings for transit encryption using AWS Secrets Manager, including the secret ARN and role ARN. +>>>>> The configuration settings for transit encryption using Secrets Manager, including the secret ARN and role ARN. @@ -1433 +1502 @@ Flow -> (structure) ->>>>>> The ARN of the AWS Secrets Manager secret used for transit encryption. +>>>>>> The ARN of the Secrets Manager secret used for transit encryption. @@ -1443 +1512 @@ Flow -> (structure) ->>>>>> The ARN of the IAM role assumed by MediaConnect to access the AWS Secrets Manager secret. +>>>>>> The ARN of the IAM role assumed by MediaConnect to access the Secrets Manager secret. @@ -1731 +1800,9 @@ Flow -> (structure) ->>>>> A suffix for the names of the NDI sources that the flow creates. If a custom name isn’t specified, MediaConnect uses the output name. +>>>>> A suffix for the name of the NDI® sender that the flow creates. If a custom name isn’t specified, MediaConnect uses the output name. +>>>> +>>>> NdiSourceSettings -> (structure) +>>>> +>>>>> The settings for the NDI source. This includes the exact name of the upstream NDI sender that you want to connect to your source. +>>>>> +>>>>> SourceName -> (string) +>>>>> +>>>>>> The exact name of an existing NDI sender that’s registered with your discovery server. If included, the format of this name must be `MACHINENAME (ProgramName)` . @@ -1806 +1883 @@ Flow -> (structure) ->>>>>> The configuration settings for transit encryption using AWS Secrets Manager, including the secret ARN and role ARN. +>>>>>> The configuration settings for transit encryption using Secrets Manager, including the secret ARN and role ARN. @@ -1810 +1887 @@ Flow -> (structure) ->>>>>>> The ARN of the AWS Secrets Manager secret used for transit encryption. +>>>>>>> The ARN of the Secrets Manager secret used for transit encryption. @@ -1820 +1897 @@ Flow -> (structure) ->>>>>>> The ARN of the IAM role assumed by MediaConnect to access the AWS Secrets Manager secret. +>>>>>>> The ARN of the IAM role assumed by MediaConnect to access the Secrets Manager secret. @@ -2028 +2105 @@ Flow -> (structure) ->> Determines the processing capacity and feature set of the flow. Set this optional parameter to LARGE if you want to enable NDI outputs on the flow. +>> Determines the processing capacity and feature set of the flow. @@ -2033,0 +2111 @@ Flow -> (structure) +>> * `LARGE_4X` @@ -2039 +2117 @@ Flow -> (structure) ->> Specifies the configuration settings for NDI outputs. Required when the flow includes NDI outputs. +>> Specifies the configuration settings for a flow’s NDI source or output. Required when the flow includes an NDI source or output. @@ -2043 +2121,3 @@ Flow -> (structure) ->>> A setting that controls whether NDI outputs can be used in the flow. Must be ENABLED to add NDI outputs. Default is DISABLED. +>>> A setting that controls whether NDI® sources or outputs can be used in the flow. +>>> +>>> The default value is `DISABLED` . This value must be set as `ENABLED` for your flow to support NDI sources or outputs. @@ -2062 +2142 @@ Flow -> (structure) ->>>> Specifies the configuration settings for individual NDI discovery servers. A maximum of 3 servers is allowed. +>>>> Specifies the configuration settings for individual NDI® discovery servers. A maximum of 3 servers is allowed. @@ -2074,0 +2155,21 @@ Flow -> (structure) +> +> EncodingConfig -> (structure) +> +>> The encoding configuration to apply to the NDI® source when transcoding it to a transport stream for downstream distribution. +>> +>> EncodingProfile -> (string) +>> +>>> The encoding profile to use when transcoding the NDI source content to a transport stream. You can change this value while the flow is running. +>>> +>>> Possible values: +>>> +>>> * `DISTRIBUTION_H264_DEFAULT` +>>> * `CONTRIBUTION_H264_DEFAULT` +>>> + +>> +>> VideoMaxBitrate -> (integer) +>> +>>> The maximum video bitrate to use when transcoding the NDI source to a transport stream. This parameter enables you to override the default video bitrate within the encoding profile’s supported range. +>>> +>>> The supported range is 10,000,000 - 50,000,000 bits per second (bps). If you don’t specify a value, MediaConnect uses the default value of 20,000,000 bps. @@ -2086 +2187 @@ Flow -> (structure) - * [AWS CLI 2.33.8 Command Reference](../../index.html) » + * [AWS CLI 2.33.12 Command Reference](../../index.html) »