aws-sdk-gamelift 1.118.0

AWS SDK for Amazon GameLift
Documentation
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`UpdateFleetCapacity`](crate::operation::update_fleet_capacity::builders::UpdateFleetCapacityFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`fleet_id(impl Into<String>)`](crate::operation::update_fleet_capacity::builders::UpdateFleetCapacityFluentBuilder::fleet_id) / [`set_fleet_id(Option<String>)`](crate::operation::update_fleet_capacity::builders::UpdateFleetCapacityFluentBuilder::set_fleet_id):<br>required: **true**<br><p>A unique identifier for the fleet to update capacity settings for. You can use either the fleet ID or ARN value.</p><br>
    ///   - [`desired_instances(i32)`](crate::operation::update_fleet_capacity::builders::UpdateFleetCapacityFluentBuilder::desired_instances) / [`set_desired_instances(Option<i32>)`](crate::operation::update_fleet_capacity::builders::UpdateFleetCapacityFluentBuilder::set_desired_instances):<br>required: **false**<br><p>The number of Amazon EC2 instances you want to maintain in the specified fleet location. This value must fall between the minimum and maximum size limits. Changes in desired instance value can take up to 1 minute to be reflected when viewing the fleet's capacity settings.</p><br>
    ///   - [`min_size(i32)`](crate::operation::update_fleet_capacity::builders::UpdateFleetCapacityFluentBuilder::min_size) / [`set_min_size(Option<i32>)`](crate::operation::update_fleet_capacity::builders::UpdateFleetCapacityFluentBuilder::set_min_size):<br>required: **false**<br><p>The minimum number of instances that are allowed in the specified fleet location. If this parameter is not set, the default is 0. This parameter cannot be set when using a ManagedCapacityConfiguration where ZeroCapacityStrategy has a value of SCALE_TO_AND_FROM_ZERO.</p><br>
    ///   - [`max_size(i32)`](crate::operation::update_fleet_capacity::builders::UpdateFleetCapacityFluentBuilder::max_size) / [`set_max_size(Option<i32>)`](crate::operation::update_fleet_capacity::builders::UpdateFleetCapacityFluentBuilder::set_max_size):<br>required: **false**<br><p>The maximum number of instances that are allowed in the specified fleet location. If this parameter is not set, the default is 1.</p><br>
    ///   - [`location(impl Into<String>)`](crate::operation::update_fleet_capacity::builders::UpdateFleetCapacityFluentBuilder::location) / [`set_location(Option<String>)`](crate::operation::update_fleet_capacity::builders::UpdateFleetCapacityFluentBuilder::set_location):<br>required: **false**<br><p>The name of a remote location to update fleet capacity settings for, in the form of an Amazon Web Services Region code such as <code>us-west-2</code>.</p><br>
    ///   - [`managed_capacity_configuration(ManagedCapacityConfiguration)`](crate::operation::update_fleet_capacity::builders::UpdateFleetCapacityFluentBuilder::managed_capacity_configuration) / [`set_managed_capacity_configuration(Option<ManagedCapacityConfiguration>)`](crate::operation::update_fleet_capacity::builders::UpdateFleetCapacityFluentBuilder::set_managed_capacity_configuration):<br>required: **false**<br><p>Configuration for Amazon GameLift Servers-managed capacity scaling options.</p><br>
    /// - On success, responds with [`UpdateFleetCapacityOutput`](crate::operation::update_fleet_capacity::UpdateFleetCapacityOutput) with field(s):
    ///   - [`fleet_id(Option<String>)`](crate::operation::update_fleet_capacity::UpdateFleetCapacityOutput::fleet_id): <p>A unique identifier for the fleet that was updated.</p>
    ///   - [`fleet_arn(Option<String>)`](crate::operation::update_fleet_capacity::UpdateFleetCapacityOutput::fleet_arn): <p>The Amazon Resource Name (<a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html">ARN</a>) that is assigned to a Amazon GameLift Servers fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is <code>arn:aws:gamelift:<region>    ::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912   </region></code>.</p>
    ///   - [`location(Option<String>)`](crate::operation::update_fleet_capacity::UpdateFleetCapacityOutput::location): <p>The remote location being updated, expressed as an Amazon Web Services Region code, such as <code>us-west-2</code>.</p>
    ///   - [`managed_capacity_configuration(Option<ManagedCapacityConfiguration>)`](crate::operation::update_fleet_capacity::UpdateFleetCapacityOutput::managed_capacity_configuration): <p>Configuration for Amazon GameLift Servers-managed capacity scaling options.</p>
    /// - On failure, responds with [`SdkError<UpdateFleetCapacityError>`](crate::operation::update_fleet_capacity::UpdateFleetCapacityError)
    pub fn update_fleet_capacity(&self) -> crate::operation::update_fleet_capacity::builders::UpdateFleetCapacityFluentBuilder {
        crate::operation::update_fleet_capacity::builders::UpdateFleetCapacityFluentBuilder::new(self.handle.clone())
    }
}