ContainerFleet

Describes an Amazon GameLift managed container fleet.

Note

In the following list, the required parameters are described first.

BillingType

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.

By default, this property is set to ON_DEMAND.

Type: String

Valid Values: ON_DEMAND | SPOT

Required: No

CreationTime

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

Type: Timestamp

Required: No

DeploymentDetails

Information about the most recent deployment for the container fleet.

Type: DeploymentDetails object

Required: No

Description

A meaningful description of the container fleet.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Required: No

FleetArn

The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift 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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 512.

Pattern: ^arn:.*:[a-z]*fleet\/[a-z]*fleet-[a-zA-Z0-9\-]+$

Required: No

FleetId

A unique identifier for the container fleet to retrieve.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: ^[a-z]*fleet-[a-zA-Z0-9\-]+

Required: No

FleetRoleArn

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 512.

Pattern: [a-zA-Z0-9:/-]+

Required: No

GameServerContainerGroupDefinitionArn

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 512.

Pattern: ^arn:.*:containergroupdefinition\/[a-zA-Z0-9\-]+(:[0-9]+)?$

Required: No

GameServerContainerGroupDefinitionName

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: ^[a-zA-Z0-9\-]+$

Required: No

GameServerContainerGroupsPerInstance

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

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 5000.

Required: No

GameSessionCreationLimitPolicy

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.

Type: GameSessionCreationLimitPolicy object

Required: No

InstanceConnectionPortRange

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.

Type: ConnectionPortRange object

Required: No

InstanceInboundPermissions

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

Type: Array of IpPermission objects

Array Members: Maximum number of 50 items.

Required: No

InstanceType

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Required: No

LocationAttributes

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

Type: Array of ContainerFleetLocationAttributes objects

Required: No

LogConfiguration

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

CLOUDWATCH -- Send logs to an Amazon CloudWatch log group that you define. Each container emits a log stream, which is organized in the log group.
S3 -- Store logs in an Amazon S3 bucket that you define.
NONE -- Don't collect container logs.

Type: LogConfiguration object

Required: No

MaximumGameServerContainerGroupsPerInstance

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.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 5000.

Required: No

MetricGroups

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

Type: Array of strings

Array Members: Maximum number of 1 item.

Length Constraints: Minimum length of 1. Maximum length of 255.

Required: No

NewGameSessionProtectionPolicy

Determines whether Amazon GameLift can shut down game sessions on the fleet that are actively running and hosting players. Amazon GameLift 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 UpdateGameSession.

NoProtection -- Game sessions can be shut down during active gameplay.
FullProtection -- Game sessions in ACTIVE status can't be shut down.

Type: String

Valid Values: NoProtection | FullProtection

Required: No

PerInstanceContainerGroupDefinitionArn

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 512.

Pattern: ^arn:.*:containergroupdefinition\/[a-zA-Z0-9\-]+(:[0-9]+)?$

Required: No

PerInstanceContainerGroupDefinitionName

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: ^[a-zA-Z0-9\-]+$

Required: No

Status

The current status of the container fleet.

PENDING -- A new container fleet has been requested.
CREATING -- A new container fleet resource is being created.
CREATED -- A new container fleet resource has been created. No fleet instances have been deployed.
ACTIVATING -- New container fleet instances are being deployed.
ACTIVE -- The container fleet has been deployed and is ready to host game sessions.
UPDATING -- Updates to the container fleet is being updated. A deployment is in progress.

Type: String

Required: No

ContainerFleet

Contents

Note

See Also