aws_sdk_deadline/client/
create_fleet.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 [`CreateFleet`](crate::operation::create_fleet::builders::CreateFleetFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`client_token(impl Into<String>)`](crate::operation::create_fleet::builders::CreateFleetFluentBuilder::client_token) / [`set_client_token(Option<String>)`](crate::operation::create_fleet::builders::CreateFleetFluentBuilder::set_client_token):<br>required: **false**<br><p>The unique token which the server uses to recognize retries of the same request.</p><br>
7    ///   - [`farm_id(impl Into<String>)`](crate::operation::create_fleet::builders::CreateFleetFluentBuilder::farm_id) / [`set_farm_id(Option<String>)`](crate::operation::create_fleet::builders::CreateFleetFluentBuilder::set_farm_id):<br>required: **true**<br><p>The farm ID of the farm to connect to the fleet.</p><br>
8    ///   - [`display_name(impl Into<String>)`](crate::operation::create_fleet::builders::CreateFleetFluentBuilder::display_name) / [`set_display_name(Option<String>)`](crate::operation::create_fleet::builders::CreateFleetFluentBuilder::set_display_name):<br>required: **true**<br><p>The display name of the fleet.</p><important>  <p>This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.</p> </important><br>
9    ///   - [`description(impl Into<String>)`](crate::operation::create_fleet::builders::CreateFleetFluentBuilder::description) / [`set_description(Option<String>)`](crate::operation::create_fleet::builders::CreateFleetFluentBuilder::set_description):<br>required: **false**<br><p>The description of the fleet.</p><important>  <p>This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.</p> </important><br>
10    ///   - [`role_arn(impl Into<String>)`](crate::operation::create_fleet::builders::CreateFleetFluentBuilder::role_arn) / [`set_role_arn(Option<String>)`](crate::operation::create_fleet::builders::CreateFleetFluentBuilder::set_role_arn):<br>required: **true**<br><p>The IAM role ARN for the role that the fleet's workers will use.</p><br>
11    ///   - [`min_worker_count(i32)`](crate::operation::create_fleet::builders::CreateFleetFluentBuilder::min_worker_count) / [`set_min_worker_count(Option<i32>)`](crate::operation::create_fleet::builders::CreateFleetFluentBuilder::set_min_worker_count):<br>required: **false**<br><p>The minimum number of workers for the fleet.</p><br>
12    ///   - [`max_worker_count(i32)`](crate::operation::create_fleet::builders::CreateFleetFluentBuilder::max_worker_count) / [`set_max_worker_count(Option<i32>)`](crate::operation::create_fleet::builders::CreateFleetFluentBuilder::set_max_worker_count):<br>required: **true**<br><p>The maximum number of workers for the fleet.</p> <p>Deadline Cloud limits the number of workers to less than or equal to the fleet's maximum worker count. The service maintains eventual consistency for the worker count. If you make multiple rapid calls to <code>CreateWorker</code> before the field updates, you might exceed your fleet's maximum worker count. For example, if your <code>maxWorkerCount</code> is 10 and you currently have 9 workers, making two quick <code>CreateWorker</code> calls might successfully create 2 workers instead of 1, resulting in 11 total workers.</p><br>
13    ///   - [`configuration(FleetConfiguration)`](crate::operation::create_fleet::builders::CreateFleetFluentBuilder::configuration) / [`set_configuration(Option<FleetConfiguration>)`](crate::operation::create_fleet::builders::CreateFleetFluentBuilder::set_configuration):<br>required: **true**<br><p>The configuration settings for the fleet. Customer managed fleets are self-managed. Service managed Amazon EC2 fleets are managed by Deadline Cloud.</p><br>
14    ///   - [`tags(impl Into<String>, impl Into<String>)`](crate::operation::create_fleet::builders::CreateFleetFluentBuilder::tags) / [`set_tags(Option<HashMap::<String, String>>)`](crate::operation::create_fleet::builders::CreateFleetFluentBuilder::set_tags):<br>required: **false**<br><p>Each tag consists of a tag key and a tag value. Tag keys and values are both required, but tag values can be empty strings.</p><br>
15    ///   - [`host_configuration(HostConfiguration)`](crate::operation::create_fleet::builders::CreateFleetFluentBuilder::host_configuration) / [`set_host_configuration(Option<HostConfiguration>)`](crate::operation::create_fleet::builders::CreateFleetFluentBuilder::set_host_configuration):<br>required: **false**<br><p>Provides a script that runs as a worker is starting up that you can use to provide additional configuration for workers in your fleet.</p><br>
16    /// - On success, responds with [`CreateFleetOutput`](crate::operation::create_fleet::CreateFleetOutput) with field(s):
17    ///   - [`fleet_id(String)`](crate::operation::create_fleet::CreateFleetOutput::fleet_id): <p>The fleet ID.</p>
18    /// - On failure, responds with [`SdkError<CreateFleetError>`](crate::operation::create_fleet::CreateFleetError)
19    pub fn create_fleet(&self) -> crate::operation::create_fleet::builders::CreateFleetFluentBuilder {
20        crate::operation::create_fleet::builders::CreateFleetFluentBuilder::new(self.handle.clone())
21    }
22}
aws_sdk_deadline/client/create_fleet.rs

aws_sdk_deadline/client/
create_fleet.rs
