Skip to content

Compute

Source code in docs_src/capo_gamelift/types/compute.py
class Compute(TypedDict, closed=True):
    fleet_id: NotRequired["capo_gamelift.types.fleet_id.FleetId"]
    """<p>A unique identifier for the fleet that the compute belongs to.</p>"""
    fleet_arn: NotRequired["capo_gamelift.types.fleet_arn.FleetArn"]
    """<p>The Amazon Resource Name (ARN) of the fleet that the compute belongs to.</p>"""
    compute_name: NotRequired["capo_gamelift.types.compute_name.ComputeName"]
    """<p>A descriptive label for the compute resource. For instances in a managed EC2 fleet, the compute name is the same value as the <code>InstanceId</code> ID.</p>"""
    compute_arn: NotRequired["capo_gamelift.types.compute_arn.ComputeArn"]
    """<p>The ARN that is assigned to a compute resource and uniquely identifies it. ARNs are unique across locations. Instances in managed EC2 fleets are not assigned a Compute ARN.</p>"""
    ip_address: NotRequired["capo_gamelift.types.ip_address.IpAddress"]
    """<p>The IP address of a compute resource. Amazon GameLift Servers requires a DNS name or IP address for a compute.</p>"""
    dns_name: NotRequired["capo_gamelift.types.dns_name.DnsName"]
    """<p>The DNS name of a compute resource. Amazon GameLift Servers requires a DNS name or IP address for a compute.</p>"""
    compute_status: NotRequired["capo_gamelift.types.compute_status.ComputeStatus"]
    """<p>Current status of the compute. A compute must have an <code>ACTIVE</code> status to host game sessions. Valid values include <code>PENDING</code>, <code>ACTIVE</code>, <code>TERMINATING</code>, and <code>IMPAIRED</code>.</p> <note> <p>While the ComputeStatus enum type is valid for Container based servers, the result may also include other non-enumerated string values such as "Active" for fleets which are not Container-based.</p> </note>"""
    location: NotRequired[
        "capo_gamelift.types.location_string_model.LocationStringModel"
    ]
    """<p>The name of the custom location you added to the fleet that this compute resource resides in.</p>"""
    creation_time: NotRequired["capo_gamelift.types.timestamp.Timestamp"]
    """<p>A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example <code>"1469498468.057"</code>).</p>"""
    operating_system: NotRequired[
        "capo_gamelift.types.operating_system.OperatingSystem"
    ]
    """<p>The type of operating system on the compute resource.</p> <note> <p>Amazon Linux 2 (AL2) will reach end of support on 6/30/2026. See more details in the <a href="http://aws.amazon.com/aws.amazon.com/amazon-linux-2/faqs/">Amazon Linux 2 FAQs</a>. For game servers that are hosted on AL2 and use server SDK version 4.x for Amazon GameLift Servers, first update the game server build to server SDK 5.x, and then deploy to AL2023 instances. See <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-serversdk5-migration.html"> Migrate to server SDK version 5.</a> </p> </note>"""
    type: NotRequired["capo_gamelift.types.ec2_instance_type.EC2InstanceType"]
    """<p>The Amazon EC2 instance type that the fleet uses. For registered computes in an Amazon GameLift Servers Anywhere fleet, this property is empty. </p>"""
    game_lift_service_sdk_endpoint: NotRequired[
        "capo_gamelift.types.game_lift_service_sdk_endpoint_output.GameLiftServiceSdkEndpointOutput"
    ]
    """<p>The Amazon GameLift Servers SDK endpoint connection for a registered compute resource in an Anywhere fleet. The game servers on the compute use this endpoint to connect to the Amazon GameLift Servers service.</p>"""
    game_lift_agent_endpoint: NotRequired[
        "capo_gamelift.types.game_lift_agent_endpoint_output.GameLiftAgentEndpointOutput"
    ]
    """<p> The endpoint of the Amazon GameLift Servers Agent. </p>"""
    instance_id: NotRequired["capo_gamelift.types.instance_id.InstanceId"]
    """<p> The <code>InstanceID</code> of the EC2 instance that is hosting the compute. </p>"""
    container_attributes: NotRequired[
        "capo_gamelift.types.container_attributes.ContainerAttributes"
    ]
    """<p>A set of attributes for each container in the compute. </p>"""
    game_server_container_group_definition_arn: NotRequired[
        "capo_gamelift.types.container_group_definition_name_or_arn.ContainerGroupDefinitionNameOrArn"
    ]
    """<p>The game server container group definition for the compute.</p>"""

compute_arn instance-attribute

compute_arn: NotRequired[ComputeArn]

The ARN that is assigned to a compute resource and uniquely identifies it. ARNs are unique across locations. Instances in managed EC2 fleets are not assigned a Compute ARN.

compute_name instance-attribute

compute_name: NotRequired[ComputeName]

A descriptive label for the compute resource. For instances in a managed EC2 fleet, the compute name is the same value as the InstanceId ID.

compute_status instance-attribute

compute_status: NotRequired[ComputeStatus]

Current status of the compute. A compute must have an ACTIVE status to host game sessions. Valid values include PENDING, ACTIVE, TERMINATING, and IMPAIRED.

While the ComputeStatus enum type is valid for Container based servers, the result may also include other non-enumerated string values such as "Active" for fleets which are not Container-based.

container_attributes instance-attribute

container_attributes: NotRequired[ContainerAttributes]

A set of attributes for each container in the compute.

creation_time instance-attribute

creation_time: NotRequired[Timestamp]

A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

dns_name instance-attribute

dns_name: NotRequired[DnsName]

The DNS name of a compute resource. Amazon GameLift Servers requires a DNS name or IP address for a compute.

fleet_arn instance-attribute

fleet_arn: NotRequired[FleetArn]

The Amazon Resource Name (ARN) of the fleet that the compute belongs to.

fleet_id instance-attribute

fleet_id: NotRequired[FleetId]

A unique identifier for the fleet that the compute belongs to.

game_lift_agent_endpoint instance-attribute

game_lift_agent_endpoint: NotRequired[GameLiftAgentEndpointOutput]

The endpoint of the Amazon GameLift Servers Agent.

game_lift_service_sdk_endpoint instance-attribute

game_lift_service_sdk_endpoint: NotRequired[GameLiftServiceSdkEndpointOutput]

The Amazon GameLift Servers SDK endpoint connection for a registered compute resource in an Anywhere fleet. The game servers on the compute use this endpoint to connect to the Amazon GameLift Servers service.

game_server_container_group_definition_arn instance-attribute

game_server_container_group_definition_arn: NotRequired[
    ContainerGroupDefinitionNameOrArn
]

The game server container group definition for the compute.

instance_id instance-attribute

instance_id: NotRequired[InstanceId]

The InstanceID of the EC2 instance that is hosting the compute.

ip_address instance-attribute

ip_address: NotRequired[IpAddress]

The IP address of a compute resource. Amazon GameLift Servers requires a DNS name or IP address for a compute.

location instance-attribute

location: NotRequired[LocationStringModel]

The name of the custom location you added to the fleet that this compute resource resides in.

operating_system instance-attribute

operating_system: NotRequired[OperatingSystem]

The type of operating system on the compute resource.

Amazon Linux 2 (AL2) will reach end of support on 6/30/2026. See more details in the Amazon Linux 2 FAQs. For game servers that are hosted on AL2 and use server SDK version 4.x for Amazon GameLift Servers, first update the game server build to server SDK 5.x, and then deploy to AL2023 instances. See Migrate to server SDK version 5.

type instance-attribute

type: NotRequired[EC2InstanceType]

The Amazon EC2 instance type that the fleet uses. For registered computes in an Amazon GameLift Servers Anywhere fleet, this property is empty.