aws_sdk_medialive/client/
create_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 [`CreateCluster`](crate::operation::create_cluster::builders::CreateClusterFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`cluster_type(ClusterType)`](crate::operation::create_cluster::builders::CreateClusterFluentBuilder::cluster_type) / [`set_cluster_type(Option<ClusterType>)`](crate::operation::create_cluster::builders::CreateClusterFluentBuilder::set_cluster_type):<br>required: **false**<br>Specify a type. All the Nodes that you later add to this Cluster must be this type of hardware. One Cluster instance can't contain different hardware types. You won't be able to change this parameter after you create the Cluster.<br>
7    ///   - [`instance_role_arn(impl Into<String>)`](crate::operation::create_cluster::builders::CreateClusterFluentBuilder::instance_role_arn) / [`set_instance_role_arn(Option<String>)`](crate::operation::create_cluster::builders::CreateClusterFluentBuilder::set_instance_role_arn):<br>required: **false**<br>The ARN of the IAM role for the Node in this Cluster. The role must include all the operations that you expect these Node to perform. If necessary, create a role in IAM, then attach it here.<br>
8    ///   - [`name(impl Into<String>)`](crate::operation::create_cluster::builders::CreateClusterFluentBuilder::name) / [`set_name(Option<String>)`](crate::operation::create_cluster::builders::CreateClusterFluentBuilder::set_name):<br>required: **false**<br>Specify a name that is unique in the AWS account. We recommend that you assign a name that hints at the types of Nodes in the Cluster. Names are case-sensitive.<br>
9    ///   - [`network_settings(ClusterNetworkSettingsCreateRequest)`](crate::operation::create_cluster::builders::CreateClusterFluentBuilder::network_settings) / [`set_network_settings(Option<ClusterNetworkSettingsCreateRequest>)`](crate::operation::create_cluster::builders::CreateClusterFluentBuilder::set_network_settings):<br>required: **false**<br>Network settings that connect the Nodes in the Cluster to one or more of the Networks that the Cluster is associated with.<br>
10    ///   - [`request_id(impl Into<String>)`](crate::operation::create_cluster::builders::CreateClusterFluentBuilder::request_id) / [`set_request_id(Option<String>)`](crate::operation::create_cluster::builders::CreateClusterFluentBuilder::set_request_id):<br>required: **false**<br>The unique ID of the request.<br>
11    ///   - [`tags(impl Into<String>, impl Into<String>)`](crate::operation::create_cluster::builders::CreateClusterFluentBuilder::tags) / [`set_tags(Option<HashMap::<String, String>>)`](crate::operation::create_cluster::builders::CreateClusterFluentBuilder::set_tags):<br>required: **false**<br>A collection of key-value pairs.<br>
12    /// - On success, responds with [`CreateClusterOutput`](crate::operation::create_cluster::CreateClusterOutput) with field(s):
13    ///   - [`arn(Option<String>)`](crate::operation::create_cluster::CreateClusterOutput::arn): The ARN of this Cluster. It is automatically assigned when the Cluster is created.
14    ///   - [`channel_ids(Option<Vec::<String>>)`](crate::operation::create_cluster::CreateClusterOutput::channel_ids): Placeholder documentation for __listOf__string
15    ///   - [`cluster_type(Option<ClusterType>)`](crate::operation::create_cluster::CreateClusterOutput::cluster_type): The hardware type for the Cluster
16    ///   - [`id(Option<String>)`](crate::operation::create_cluster::CreateClusterOutput::id): The ID of the Cluster. Unique in the AWS account. The ID is the resource-id portion of the ARN.
17    ///   - [`instance_role_arn(Option<String>)`](crate::operation::create_cluster::CreateClusterOutput::instance_role_arn): The ARN of the IAM role for the Node in this Cluster. Any Nodes that are associated with this Cluster assume this role. The role gives permissions to the operations that you expect these Node to perform.
18    ///   - [`name(Option<String>)`](crate::operation::create_cluster::CreateClusterOutput::name): The name that you specified for the Cluster.
19    ///   - [`network_settings(Option<ClusterNetworkSettings>)`](crate::operation::create_cluster::CreateClusterOutput::network_settings): Network settings that connect the Nodes in the Cluster to one or more of the Networks that the Cluster is associated with.
20    ///   - [`state(Option<ClusterState>)`](crate::operation::create_cluster::CreateClusterOutput::state): The current state of the Cluster.
21    /// - On failure, responds with [`SdkError<CreateClusterError>`](crate::operation::create_cluster::CreateClusterError)
22    pub fn create_cluster(&self) -> crate::operation::create_cluster::builders::CreateClusterFluentBuilder {
23        crate::operation::create_cluster::builders::CreateClusterFluentBuilder::new(self.handle.clone())
24    }
25}