Skip to content

UpdateFleetAttributesInput

Source code in docs_src/capo_gamelift/types/update_fleet_attributes_input.py
class UpdateFleetAttributesInput(TypedDict, closed=True):
    fleet_id: NotRequired["capo_gamelift.types.fleet_id_or_arn.FleetIdOrArn"]
    """<p>A unique identifier for the fleet to update attribute metadata for. You can use either the fleet ID or ARN value.</p>"""
    name: NotRequired["capo_gamelift.types.non_zero_and_max_string.NonZeroAndMaxString"]
    """<p>A descriptive label that is associated with a fleet. Fleet names do not need to be unique.</p>"""
    description: NotRequired[
        "capo_gamelift.types.non_zero_and_max_string.NonZeroAndMaxString"
    ]
    """<p>A human-readable description of a fleet.</p>"""
    new_game_session_protection_policy: NotRequired[
        "capo_gamelift.types.protection_policy.ProtectionPolicy"
    ]
    """<p>The game session protection policy to apply to all new game sessions created in this fleet. Game sessions that already exist are not affected. You can set protection for individual game sessions using <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateGameSession.html">UpdateGameSession</a> .</p> <ul> <li> <p> <b>NoProtection</b> -- The game session can be terminated during a scale-down event.</p> </li> <li> <p> <b>FullProtection</b> -- If the game session is in an <code>ACTIVE</code> status, it cannot be terminated during a scale-down event.</p> </li> </ul>"""
    resource_creation_limit_policy: NotRequired[
        "capo_gamelift.types.resource_creation_limit_policy.ResourceCreationLimitPolicy"
    ]
    """<p>Policy settings that limit the number of game sessions an individual player can create over a span of time. </p>"""
    metric_groups: NotRequired["capo_gamelift.types.metric_group_list.MetricGroupList"]
    """<p>The name of a metric group to add this fleet to. Use a metric group in Amazon CloudWatch to aggregate the metrics from multiple fleets. Provide an existing metric group name, or create a new metric group by providing a new name. A fleet can only be in one metric group at a time.</p>"""
    anywhere_configuration: NotRequired[
        "capo_gamelift.types.anywhere_configuration.AnywhereConfiguration"
    ]
    """<p>Amazon GameLift Servers Anywhere configuration options.</p>"""

anywhere_configuration instance-attribute

anywhere_configuration: NotRequired[AnywhereConfiguration]

Amazon GameLift Servers Anywhere configuration options.

description instance-attribute

description: NotRequired[NonZeroAndMaxString]

A human-readable description of a fleet.

fleet_id instance-attribute

fleet_id: NotRequired[FleetIdOrArn]

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

metric_groups instance-attribute

metric_groups: NotRequired[MetricGroupList]

The name of a metric group to add this fleet to. Use a metric group in Amazon CloudWatch to aggregate the metrics from multiple fleets. Provide an existing metric group name, or create a new metric group by providing a new name. A fleet can only be in one metric group at a time.

name instance-attribute

name: NotRequired[NonZeroAndMaxString]

A descriptive label that is associated with a fleet. Fleet names do not need to be unique.

new_game_session_protection_policy instance-attribute

new_game_session_protection_policy: NotRequired[ProtectionPolicy]

The game session protection policy to apply to all new game sessions created in this fleet. Game sessions that already exist are not affected. You can set protection for individual game sessions using UpdateGameSession .

  • NoProtection -- The game session can be terminated during a scale-down event.

  • FullProtection -- If the game session is in an ACTIVE status, it cannot be terminated during a scale-down event.

resource_creation_limit_policy instance-attribute

resource_creation_limit_policy: NotRequired[ResourceCreationLimitPolicy]

Policy settings that limit the number of game sessions an individual player can create over a span of time.