ContainerFleet

Describes an Amazon GameLift Servers managed container fleet.

Types

Link copied to clipboard
class Builder
Link copied to clipboard
object Companion

Properties

Link copied to clipboard

Indicates whether the fleet uses On-Demand or Spot instances for this fleet. Learn more about when to use On-Demand versus Spot Instances. You can't update this fleet property.

Link copied to clipboard

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

Link copied to clipboard

Information about the most recent deployment for the container fleet.

Link copied to clipboard

A meaningful description of the container fleet.

Link copied to clipboard

The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift Servers fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912. In a GameLift fleet ARN, the resource ID matches the FleetId value.

Link copied to clipboard

A unique identifier for the container fleet to retrieve.

Link copied to clipboard

The unique identifier for an Identity and Access Management (IAM) role with permissions to run your containers on resources that are managed by Amazon GameLift Servers. See Set up an IAM service role. This fleet property can't be changed.

Link copied to clipboard

The Amazon Resource Name (ARN) that is assigned to the fleet's game server container group. The ARN value also identifies the specific container group definition version in use.

Link copied to clipboard

The name of the fleet's game server container group definition, which describes how to deploy containers with your game server build and support software onto each fleet instance.

Link copied to clipboard

The number of times to replicate the game server container group on each fleet instance.

Link copied to clipboard

A policy that limits the number of game sessions that each individual player can create on instances in this fleet. The limit applies for a specified span of time.

Link copied to clipboard

The set of port numbers to open on each instance in a container fleet. Connection ports are used by inbound traffic to connect with processes that are running in containers on the fleet.

Link copied to clipboard

The IP address ranges and port settings that allow inbound traffic to access game server processes and other processes on this fleet.

Link copied to clipboard

The Amazon EC2 instance type to use for all instances in the fleet. Instance type determines the computing resources and processing power that's available to host your game servers. This includes including CPU, memory, storage, and networking capacity. You can't update this fleet property.

Link copied to clipboard

Information about the container fleet's remote locations where fleet instances are deployed.

Link copied to clipboard

The method that is used to collect container logs for the fleet. Amazon GameLift Servers saves all standard output for each container in logs, including game session logs.

The calculated maximum number of game server container group that can be deployed on each fleet instance. The calculation depends on the resource needs of the container group and the CPU and memory resources of the fleet's instance type.

Link copied to clipboard

The name of an Amazon Web Services CloudWatch metric group to add this fleet to. Metric groups aggregate metrics for multiple fleets.

Link copied to clipboard

Determines whether Amazon GameLift Servers can shut down game sessions on the fleet that are actively running and hosting players. Amazon GameLift Servers might prompt an instance shutdown when scaling down fleet capacity or when retiring unhealthy instances. You can also set game session protection for individual game sessions using gamelift/latest/apireference/API_UpdateGameSession.html.

Link copied to clipboard

The Amazon Resource Name (ARN) that is assigned to the fleet's per-instance container group. The ARN value also identifies the specific container group definition version in use.

Link copied to clipboard

The name of the fleet's per-instance container group definition.

Link copied to clipboard

The current status of the container fleet.

Functions

Link copied to clipboard
inline fun copy(block: ContainerFleet.Builder.() -> Unit = {}): ContainerFleet
Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Link copied to clipboard
open override fun hashCode(): Int
Link copied to clipboard
open override fun toString(): String