aws_sdk_medialive/client/update_cluster.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 [`UpdateCluster`](crate::operation::update_cluster::builders::UpdateClusterFluentBuilder) operation.
4 ///
5 /// - The fluent builder is configurable:
6 /// - [`cluster_id(impl Into<String>)`](crate::operation::update_cluster::builders::UpdateClusterFluentBuilder::cluster_id) / [`set_cluster_id(Option<String>)`](crate::operation::update_cluster::builders::UpdateClusterFluentBuilder::set_cluster_id):<br>required: **true**<br>The ID of the cluster<br>
7 /// - [`name(impl Into<String>)`](crate::operation::update_cluster::builders::UpdateClusterFluentBuilder::name) / [`set_name(Option<String>)`](crate::operation::update_cluster::builders::UpdateClusterFluentBuilder::set_name):<br>required: **false**<br>Include this parameter only if you want to change the current name of the Cluster. Specify a name that is unique in the AWS account. You can't change the name. Names are case-sensitive.<br>
8 /// - [`network_settings(ClusterNetworkSettingsUpdateRequest)`](crate::operation::update_cluster::builders::UpdateClusterFluentBuilder::network_settings) / [`set_network_settings(Option<ClusterNetworkSettingsUpdateRequest>)`](crate::operation::update_cluster::builders::UpdateClusterFluentBuilder::set_network_settings):<br>required: **false**<br>Include this property only if you want to change the current connections between the Nodes in the Cluster and the Networks the Cluster is associated with.<br>
9 /// - On success, responds with [`UpdateClusterOutput`](crate::operation::update_cluster::UpdateClusterOutput) with field(s):
10 /// - [`arn(Option<String>)`](crate::operation::update_cluster::UpdateClusterOutput::arn): The ARN of the Cluster.
11 /// - [`channel_ids(Option<Vec::<String>>)`](crate::operation::update_cluster::UpdateClusterOutput::channel_ids): An array of the IDs of the Channels that are associated with this Cluster. One Channel is associated with the Cluster as follows: A Channel belongs to a ChannelPlacementGroup. A ChannelPlacementGroup is attached to a Node. A Node belongs to a Cluster.
12 /// - [`cluster_type(Option<ClusterType>)`](crate::operation::update_cluster::UpdateClusterOutput::cluster_type): The hardware type for the Cluster
13 /// - [`id(Option<String>)`](crate::operation::update_cluster::UpdateClusterOutput::id): The unique ID of the Cluster.
14 /// - [`name(Option<String>)`](crate::operation::update_cluster::UpdateClusterOutput::name): The user-specified name of the Cluster.
15 /// - [`network_settings(Option<ClusterNetworkSettings>)`](crate::operation::update_cluster::UpdateClusterOutput::network_settings): Network settings that connect the Nodes in the Cluster to one or more of the Networks that the Cluster is associated with.
16 /// - [`state(Option<ClusterState>)`](crate::operation::update_cluster::UpdateClusterOutput::state): The current state of the Cluster.
17 /// - On failure, responds with [`SdkError<UpdateClusterError>`](crate::operation::update_cluster::UpdateClusterError)
18 pub fn update_cluster(&self) -> crate::operation::update_cluster::builders::UpdateClusterFluentBuilder {
19 crate::operation::update_cluster::builders::UpdateClusterFluentBuilder::new(self.handle.clone())
20 }
21}