Skip to content

UpdateFleetCapacityInput

Source code in docs_src/capo_gamelift/types/update_fleet_capacity_input.py
class UpdateFleetCapacityInput(TypedDict, closed=True):
    fleet_id: NotRequired["capo_gamelift.types.fleet_id_or_arn.FleetIdOrArn"]
    """<p>A unique identifier for the fleet to update capacity settings for. You can use either the fleet ID or ARN value.</p>"""
    desired_instances: NotRequired["capo_gamelift.types.whole_number.WholeNumber"]
    """<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>"""
    min_size: NotRequired["capo_gamelift.types.whole_number.WholeNumber"]
    """<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>"""
    max_size: NotRequired["capo_gamelift.types.whole_number.WholeNumber"]
    """<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>"""
    location: NotRequired[
        "capo_gamelift.types.location_string_model.LocationStringModel"
    ]
    """<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>"""
    managed_capacity_configuration: NotRequired[
        "capo_gamelift.types.managed_capacity_configuration.ManagedCapacityConfiguration"
    ]
    """<p>Configuration for Amazon GameLift Servers-managed capacity scaling options.</p>"""

desired_instances instance-attribute

desired_instances: NotRequired[WholeNumber]

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.

fleet_id instance-attribute

fleet_id: NotRequired[FleetIdOrArn]

A unique identifier for the fleet to update capacity settings for. You can use either the fleet ID or ARN value.

location instance-attribute

location: NotRequired[LocationStringModel]

The name of a remote location to update fleet capacity settings for, in the form of an Amazon Web Services Region code such as us-west-2.

managed_capacity_configuration instance-attribute

managed_capacity_configuration: NotRequired[ManagedCapacityConfiguration]

Configuration for Amazon GameLift Servers-managed capacity scaling options.

max_size instance-attribute

max_size: NotRequired[WholeNumber]

The maximum number of instances that are allowed in the specified fleet location. If this parameter is not set, the default is 1.

min_size instance-attribute

min_size: NotRequired[WholeNumber]

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.