aws_sdk_medialive/client/

update_node.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`UpdateNode`](crate::operation::update_node::builders::UpdateNodeFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`cluster_id(impl Into<String>)`](crate::operation::update_node::builders::UpdateNodeFluentBuilder::cluster_id) / [`set_cluster_id(Option<String>)`](crate::operation::update_node::builders::UpdateNodeFluentBuilder::set_cluster_id):<br>required: **true**<br>The ID of the cluster<br>
    ///   - [`name(impl Into<String>)`](crate::operation::update_node::builders::UpdateNodeFluentBuilder::name) / [`set_name(Option<String>)`](crate::operation::update_node::builders::UpdateNodeFluentBuilder::set_name):<br>required: **false**<br>Include this parameter only if you want to change the current name of the Node. Specify a name that is unique in the Cluster. You can't change the name. Names are case-sensitive.<br>
    ///   - [`node_id(impl Into<String>)`](crate::operation::update_node::builders::UpdateNodeFluentBuilder::node_id) / [`set_node_id(Option<String>)`](crate::operation::update_node::builders::UpdateNodeFluentBuilder::set_node_id):<br>required: **true**<br>The ID of the node.<br>
    ///   - [`role(NodeRole)`](crate::operation::update_node::builders::UpdateNodeFluentBuilder::role) / [`set_role(Option<NodeRole>)`](crate::operation::update_node::builders::UpdateNodeFluentBuilder::set_role):<br>required: **false**<br>The initial role of the Node in the Cluster. ACTIVE means the Node is available for encoding. BACKUP means the Node is a redundant Node and might get used if an ACTIVE Node fails.<br>
    ///   - [`sdi_source_mappings(SdiSourceMappingUpdateRequest)`](crate::operation::update_node::builders::UpdateNodeFluentBuilder::sdi_source_mappings) / [`set_sdi_source_mappings(Option<Vec::<SdiSourceMappingUpdateRequest>>)`](crate::operation::update_node::builders::UpdateNodeFluentBuilder::set_sdi_source_mappings):<br>required: **false**<br>The mappings of a SDI capture card port to a logical SDI data stream<br>
    /// - On success, responds with [`UpdateNodeOutput`](crate::operation::update_node::UpdateNodeOutput) with field(s):
    ///   - [`arn(Option<String>)`](crate::operation::update_node::UpdateNodeOutput::arn): The ARN of the Node. It is automatically assigned when the Node is created.
    ///   - [`channel_placement_groups(Option<Vec::<String>>)`](crate::operation::update_node::UpdateNodeOutput::channel_placement_groups): An array of IDs. Each ID is one ChannelPlacementGroup that is associated with this Node. Empty if the Node is not yet associated with any groups.
    ///   - [`cluster_id(Option<String>)`](crate::operation::update_node::UpdateNodeOutput::cluster_id): The ID of the Cluster that the Node belongs to.
    ///   - [`connection_state(Option<NodeConnectionState>)`](crate::operation::update_node::UpdateNodeOutput::connection_state): The current connection state of the Node.
    ///   - [`id(Option<String>)`](crate::operation::update_node::UpdateNodeOutput::id): The unique ID of the Node. Unique in the Cluster. The ID is the resource-id portion of the ARN.
    ///   - [`instance_arn(Option<String>)`](crate::operation::update_node::UpdateNodeOutput::instance_arn): The ARN of the EC2 instance hosting the Node.
    ///   - [`name(Option<String>)`](crate::operation::update_node::UpdateNodeOutput::name): The name that you specified for the Node.
    ///   - [`node_interface_mappings(Option<Vec::<NodeInterfaceMapping>>)`](crate::operation::update_node::UpdateNodeOutput::node_interface_mappings): Documentation update needed
    ///   - [`role(Option<NodeRole>)`](crate::operation::update_node::UpdateNodeOutput::role): The initial role current role of the Node in the Cluster. ACTIVE means the Node is available for encoding. BACKUP means the Node is a redundant Node and might get used if an ACTIVE Node fails.
    ///   - [`state(Option<NodeState>)`](crate::operation::update_node::UpdateNodeOutput::state): The current state of the Node.
    ///   - [`sdi_source_mappings(Option<Vec::<SdiSourceMapping>>)`](crate::operation::update_node::UpdateNodeOutput::sdi_source_mappings): An array of SDI source mappings. Each mapping connects one logical SdiSource to the physical SDI card and port that the physical SDI source uses.
    /// - On failure, responds with [`SdkError<UpdateNodeError>`](crate::operation::update_node::UpdateNodeError)
    pub fn update_node(&self) -> crate::operation::update_node::builders::UpdateNodeFluentBuilder {
        crate::operation::update_node::builders::UpdateNodeFluentBuilder::new(self.handle.clone())
    }
}