aws_sdk_mediaconnect/client/
update_flow_output.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`UpdateFlowOutput`](crate::operation::update_flow_output::builders::UpdateFlowOutputFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`cidr_allow_list(impl Into<String>)`](crate::operation::update_flow_output::builders::UpdateFlowOutputFluentBuilder::cidr_allow_list) / [`set_cidr_allow_list(Option<Vec::<String>>)`](crate::operation::update_flow_output::builders::UpdateFlowOutputFluentBuilder::set_cidr_allow_list):<br>required: **false**<br><p>The range of IP addresses that should be allowed to initiate output requests to this flow. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.</p><br>
7    ///   - [`description(impl Into<String>)`](crate::operation::update_flow_output::builders::UpdateFlowOutputFluentBuilder::description) / [`set_description(Option<String>)`](crate::operation::update_flow_output::builders::UpdateFlowOutputFluentBuilder::set_description):<br>required: **false**<br><p>A description of the output. This description appears only on the MediaConnect console and will not be seen by the end user.</p><br>
8    ///   - [`destination(impl Into<String>)`](crate::operation::update_flow_output::builders::UpdateFlowOutputFluentBuilder::destination) / [`set_destination(Option<String>)`](crate::operation::update_flow_output::builders::UpdateFlowOutputFluentBuilder::set_destination):<br>required: **false**<br><p>The IP address where you want to send the output.</p><br>
9    ///   - [`encryption(UpdateEncryption)`](crate::operation::update_flow_output::builders::UpdateFlowOutputFluentBuilder::encryption) / [`set_encryption(Option<UpdateEncryption>)`](crate::operation::update_flow_output::builders::UpdateFlowOutputFluentBuilder::set_encryption):<br>required: **false**<br><p>The type of key used for the encryption. If no <code>keyType</code> is provided, the service will use the default setting (static-key). Allowable encryption types: static-key.</p><br>
10    ///   - [`flow_arn(impl Into<String>)`](crate::operation::update_flow_output::builders::UpdateFlowOutputFluentBuilder::flow_arn) / [`set_flow_arn(Option<String>)`](crate::operation::update_flow_output::builders::UpdateFlowOutputFluentBuilder::set_flow_arn):<br>required: **true**<br><p>The Amazon Resource Name (ARN) of the flow that is associated with the output that you want to update.</p><br>
11    ///   - [`max_latency(i32)`](crate::operation::update_flow_output::builders::UpdateFlowOutputFluentBuilder::max_latency) / [`set_max_latency(Option<i32>)`](crate::operation::update_flow_output::builders::UpdateFlowOutputFluentBuilder::set_max_latency):<br>required: **false**<br><p>The maximum latency in milliseconds. This parameter applies only to RIST-based and Zixi-based streams.</p><br>
12    ///   - [`media_stream_output_configurations(MediaStreamOutputConfigurationRequest)`](crate::operation::update_flow_output::builders::UpdateFlowOutputFluentBuilder::media_stream_output_configurations) / [`set_media_stream_output_configurations(Option<Vec::<MediaStreamOutputConfigurationRequest>>)`](crate::operation::update_flow_output::builders::UpdateFlowOutputFluentBuilder::set_media_stream_output_configurations):<br>required: **false**<br><p>The media streams that are associated with the output, and the parameters for those associations.</p><br>
13    ///   - [`min_latency(i32)`](crate::operation::update_flow_output::builders::UpdateFlowOutputFluentBuilder::min_latency) / [`set_min_latency(Option<i32>)`](crate::operation::update_flow_output::builders::UpdateFlowOutputFluentBuilder::set_min_latency):<br>required: **false**<br><p>The minimum latency in milliseconds for SRT-based streams. In streams that use the SRT protocol, this value that you set on your MediaConnect source or output represents the minimal potential latency of that connection. The latency of the stream is set to the highest number between the sender’s minimum latency and the receiver’s minimum latency.</p><br>
14    ///   - [`output_arn(impl Into<String>)`](crate::operation::update_flow_output::builders::UpdateFlowOutputFluentBuilder::output_arn) / [`set_output_arn(Option<String>)`](crate::operation::update_flow_output::builders::UpdateFlowOutputFluentBuilder::set_output_arn):<br>required: **true**<br><p>The ARN of the output that you want to update.</p><br>
15    ///   - [`port(i32)`](crate::operation::update_flow_output::builders::UpdateFlowOutputFluentBuilder::port) / [`set_port(Option<i32>)`](crate::operation::update_flow_output::builders::UpdateFlowOutputFluentBuilder::set_port):<br>required: **false**<br><p>The port to use when content is distributed to this output.</p><br>
16    ///   - [`protocol(Protocol)`](crate::operation::update_flow_output::builders::UpdateFlowOutputFluentBuilder::protocol) / [`set_protocol(Option<Protocol>)`](crate::operation::update_flow_output::builders::UpdateFlowOutputFluentBuilder::set_protocol):<br>required: **false**<br><p>The protocol to use for the output.</p><note>  <p>Elemental MediaConnect no longer supports the Fujitsu QoS protocol. This reference is maintained for legacy purposes only.</p> </note><br>
17    ///   - [`remote_id(impl Into<String>)`](crate::operation::update_flow_output::builders::UpdateFlowOutputFluentBuilder::remote_id) / [`set_remote_id(Option<String>)`](crate::operation::update_flow_output::builders::UpdateFlowOutputFluentBuilder::set_remote_id):<br>required: **false**<br><p>The remote ID for the Zixi-pull stream.</p><br>
18    ///   - [`sender_control_port(i32)`](crate::operation::update_flow_output::builders::UpdateFlowOutputFluentBuilder::sender_control_port) / [`set_sender_control_port(Option<i32>)`](crate::operation::update_flow_output::builders::UpdateFlowOutputFluentBuilder::set_sender_control_port):<br>required: **false**<br><p>The port that the flow uses to send outbound requests to initiate connection with the sender.</p><br>
19    ///   - [`sender_ip_address(impl Into<String>)`](crate::operation::update_flow_output::builders::UpdateFlowOutputFluentBuilder::sender_ip_address) / [`set_sender_ip_address(Option<String>)`](crate::operation::update_flow_output::builders::UpdateFlowOutputFluentBuilder::set_sender_ip_address):<br>required: **false**<br><p>The IP address that the flow communicates with to initiate connection with the sender.</p><br>
20    ///   - [`smoothing_latency(i32)`](crate::operation::update_flow_output::builders::UpdateFlowOutputFluentBuilder::smoothing_latency) / [`set_smoothing_latency(Option<i32>)`](crate::operation::update_flow_output::builders::UpdateFlowOutputFluentBuilder::set_smoothing_latency):<br>required: **false**<br><p>The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.</p><br>
21    ///   - [`stream_id(impl Into<String>)`](crate::operation::update_flow_output::builders::UpdateFlowOutputFluentBuilder::stream_id) / [`set_stream_id(Option<String>)`](crate::operation::update_flow_output::builders::UpdateFlowOutputFluentBuilder::set_stream_id):<br>required: **false**<br><p>The stream ID that you want to use for this transport. This parameter applies only to Zixi and SRT caller-based streams.</p><br>
22    ///   - [`vpc_interface_attachment(VpcInterfaceAttachment)`](crate::operation::update_flow_output::builders::UpdateFlowOutputFluentBuilder::vpc_interface_attachment) / [`set_vpc_interface_attachment(Option<VpcInterfaceAttachment>)`](crate::operation::update_flow_output::builders::UpdateFlowOutputFluentBuilder::set_vpc_interface_attachment):<br>required: **false**<br><p>The name of the VPC interface attachment to use for this output.</p><br>
23    ///   - [`output_status(OutputStatus)`](crate::operation::update_flow_output::builders::UpdateFlowOutputFluentBuilder::output_status) / [`set_output_status(Option<OutputStatus>)`](crate::operation::update_flow_output::builders::UpdateFlowOutputFluentBuilder::set_output_status):<br>required: **false**<br><p>An indication of whether the output should transmit data or not. If you don't specify the <code>outputStatus</code> field in your request, MediaConnect leaves the value unchanged.</p><br>
24    ///   - [`ndi_program_name(impl Into<String>)`](crate::operation::update_flow_output::builders::UpdateFlowOutputFluentBuilder::ndi_program_name) / [`set_ndi_program_name(Option<String>)`](crate::operation::update_flow_output::builders::UpdateFlowOutputFluentBuilder::set_ndi_program_name):<br>required: **false**<br><p>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.</p><br>
25    ///   - [`ndi_speed_hq_quality(i32)`](crate::operation::update_flow_output::builders::UpdateFlowOutputFluentBuilder::ndi_speed_hq_quality) / [`set_ndi_speed_hq_quality(Option<i32>)`](crate::operation::update_flow_output::builders::UpdateFlowOutputFluentBuilder::set_ndi_speed_hq_quality):<br>required: **false**<br><p>A quality setting for the NDI Speed HQ encoder.</p><br>
26    /// - On success, responds with [`UpdateFlowOutputOutput`](crate::operation::update_flow_output::UpdateFlowOutputOutput) with field(s):
27    ///   - [`flow_arn(Option<String>)`](crate::operation::update_flow_output::UpdateFlowOutputOutput::flow_arn): <p>The ARN of the flow that is associated with the updated output.</p>
28    ///   - [`output(Option<Output>)`](crate::operation::update_flow_output::UpdateFlowOutputOutput::output): <p>The new settings of the output that you updated.</p>
29    /// - On failure, responds with [`SdkError<UpdateFlowOutputError>`](crate::operation::update_flow_output::UpdateFlowOutputError)
30    pub fn update_flow_output(&self) -> crate::operation::update_flow_output::builders::UpdateFlowOutputFluentBuilder {
31        crate::operation::update_flow_output::builders::UpdateFlowOutputFluentBuilder::new(self.handle.clone())
32    }
33}