Skip to main content

container_fleets

Creates, updates, deletes, gets or lists a container_fleets resource.

Overview​

Namecontainer_fleets
TypeResource
Idaws.gamelift.container_fleets

Fields​

The following fields are returned by SELECT queries:

NameDatatypeDescription
billing_typestringIndicates 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. (ON_DEMAND, SPOT)
creation_timestring (date-time)A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
deployment_detailsobjectInformation about the most recent deployment for the container fleet.
descriptionstringA meaningful description of the container fleet.
fleet_arnstringThe 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. (pattern: <code>^arn:.*:[a-z]*fleet/[a-z]*fleet-[a-zA-Z0-9-]+$</code>)
fleet_idstringA unique identifier for the container fleet to retrieve. (pattern: <code>^[a-z]*fleet-[a-zA-Z0-9-]+$</code>)
fleet_role_arnstringThe 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. (pattern: <code>^arn:.*:role/[\w+=,.@-]+</code>)
game_server_container_group_definition_arnstringThe 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. (pattern: <code>^arn:.*:containergroupdefinition/[a-zA-Z0-9-]+(:[0-9]+)?$</code>)
game_server_container_group_definition_namestringThe 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. (pattern: <code>^[a-zA-Z0-9-]+$</code>)
game_server_container_groups_per_instanceintegerThe number of times to replicate the game server container group on each fleet instance.
game_session_creation_limit_policyobjectA 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.
instance_connection_port_rangeobjectThe 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. The port range must not overlap with the Amazon GameLift Servers reserved port range 4092-4191. This range is reserved for internal Amazon GameLift Servers services.
instance_inbound_permissionsarrayThe IP address ranges and port settings that allow inbound traffic to access game server processes and other processes on this fleet.
instance_typestringThe 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.
location_attributesarrayInformation about the container fleet's remote locations where fleet instances are deployed.
log_configurationobjectThe 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. 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.
maximum_game_server_container_groups_per_instanceintegerThe 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.
metric_groupsarrayThe name of an Amazon Web Services CloudWatch metric group to add this fleet to. Metric groups aggregate metrics for multiple fleets.
new_game_session_protection_policystringDetermines 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 UpdateGameSession. NoProtection -- Game sessions can be shut down during active gameplay. FullProtection -- Game sessions in ACTIVE status can't be shut down. (NoProtection, FullProtection)
per_instance_container_group_definition_arnstringThe 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. (pattern: <code>^arn:.*:containergroupdefinition/[a-zA-Z0-9-]+(:[0-9]+)?$</code>)
per_instance_container_group_definition_namestringThe name of the fleet's per-instance container group definition. (pattern: <code>^[a-zA-Z0-9-]+$</code>)
player_gateway_modestringIndicates whether player gateway is enabled for this container fleet. Player gateway provides benefits such as DDoS protection with negligible impact to latency. If ENABLED or REQUIRED, game clients can use player gateway to connect with the game server. If DISABLED, game clients cannot use player gateway. Instead, they have to directly connect to the game server. (DISABLED, ENABLED, REQUIRED)
statusstringThe 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. EXPIRED -- The container fleet has been expired. The fleet is scaled down to zero instances and cannot host new game sessions. (PENDING, CREATING, CREATED, ACTIVATING, ACTIVE, UPDATING, DELETING, EXPIRED)

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
describe_container_fleetselectregionThis API works with the following fleet types: Container Retrieves the properties for a container fleet. When requesting attributes for multiple fleets, use the pagination parameters to retrieve results as a set of sequential pages. Request options Get container fleet properties for a single fleet. Provide either the fleet ID or ARN value. Results If successful, a ContainerFleet object is returned. This object includes the fleet properties, including information about the most recent deployment. Some API operations limit the number of fleet IDs that allowed in one request. If a request exceeds this limit, the request fails and the error message contains the maximum allowed number.
list_container_fleetsselectregionThis API works with the following fleet types: Container Retrieves a collection of container fleet resources in an Amazon Web Services Region. For fleets that have multiple locations, this operation retrieves fleets based on their home Region only. Request options Get a list of all fleets. Call this operation without specifying a container group definition. Get a list of fleets filtered by container group definition. Provide the container group definition name or ARN value. To get a list of all Amazon GameLift Servers Realtime fleets with a specific configuration script, provide the script ID. Use the pagination parameters to retrieve results as a set of sequential pages. If successful, this operation returns a collection of container fleets that match the request parameters. A NextToken value is also returned if there are more result pages to retrieve. Fleet IDs are returned in no particular order.
create_container_fleetinsertregion, FleetRoleArnThis API works with the following fleet types: Container Creates a managed fleet of Amazon Elastic Compute Cloud (Amazon EC2) instances to host your containerized game servers. Use this operation to define how to deploy a container architecture onto each fleet instance and configure fleet settings. You can create a container fleet in any Amazon Web Services Regions that Amazon GameLift Servers supports for multi-location fleets. A container fleet can be deployed to a single location or multiple locations. Container fleets are deployed with Amazon Linux 2023 as the instance operating system. Define the fleet's container architecture using container group definitions. Each fleet can have one of the following container group types: The game server container group runs your game server build and dependent software. Amazon GameLift Servers deploys one or more replicas of this container group to each fleet instance. The number of replicas depends on the computing capabilities of the fleet instance in use. An optional per-instance container group might be used to run other software that only needs to run once per instance, such as background services, logging, or test processes. One per-instance container group is deployed to each fleet instance. Each container group can include the definition for one or more containers. A container definition specifies a container image that is stored in an Amazon Elastic Container Registry (Amazon ECR) public or private repository. Request options Use this operation to make the following types of requests. Most fleet settings have default values, so you can create a working fleet with a minimal configuration and default values, which you can customize later. Create a fleet with no container groups. You can configure a container fleet and then add container group definitions later. In this scenario, no fleet instances are deployed, and the fleet can't host game sessions until you add a game server container group definition. Provide the following required parameter values: FleetRoleArn Create a fleet with a game server container group. Provide the following required parameter values: FleetRoleArn GameServerContainerGroupDefinitionName Create a fleet with a game server container group and a per-instance container group. Provide the following required parameter values: FleetRoleArn GameServerContainerGroupDefinitionName PerInstanceContainerGroupDefinitionName Results If successful, this operation creates a new container fleet resource, places it in PENDING status, and initiates the fleet creation workflow. For fleets with container groups, this workflow starts a fleet deployment and transitions the status to ACTIVE. Fleets without a container group are placed in CREATED status. You can update most of the properties of a fleet, including container group definitions, and deploy the update across all fleet instances. Use UpdateContainerFleet to deploy a new game server version update across the container fleet. A managed fleet's runtime environment depends on the Amazon Machine Image (AMI) version it uses. When a new fleet is created, Amazon GameLift Servers assigns the latest available AMI version to the fleet, and all compute instances in that fleet are deployed with that version. To update the AMI version, you must create a new fleet. As a best practice, we recommend replacing your managed fleets every 30 days to maintain a secure and up-to-date runtime environment for your hosted game servers. For guidance, see Security best practices for Amazon GameLift Servers.
update_container_fleetupdateregion, FleetIdThis API works with the following fleet types: Container Updates the properties of a managed container fleet. Depending on the properties being updated, this operation might initiate a fleet deployment. You can track deployments for a fleet using https:​//docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeFleetDeployment.html. A managed fleet's runtime environment, which depends on the fleet's Amazon Machine Image {AMI} version, can't be updated. You must create a new fleet. As a best practice, we recommend replacing your managed fleets every 30 days to maintain a secure and up-to-date runtime environment for your hosted game servers. For guidance, see Security best practices for Amazon GameLift Servers. Request options As with CreateContainerFleet, many fleet properties use common defaults or are calculated based on the fleet's container group definitions. Update fleet properties that result in a fleet deployment. Include only those properties that you want to change. Specify deployment configuration settings. Update fleet properties that don't result in a fleet deployment. Include only those properties that you want to change. Changes to the following properties initiate a fleet deployment: GameServerContainerGroupDefinition PerInstanceContainerGroupDefinition GameServerContainerGroupsPerInstance InstanceInboundPermissions InstanceConnectionPortRange LogConfiguration Results If successful, this operation updates the container fleet resource, and might initiate a new deployment of fleet resources using the deployment configuration provided. A deployment replaces existing fleet instances with new instances that are deployed with the updated fleet properties. The fleet is placed in UPDATING status until the deployment is complete, then return to ACTIVE. You can have only one update deployment active at a time for a fleet. If a second update request initiates a deployment while another deployment is in progress, the first deployment is cancelled.
delete_container_fleetdeleteregionThis API works with the following fleet types: Container Deletes all resources and information related to a container fleet and shuts down currently running fleet instances, including those in remote locations. The container fleet must be in ACTIVE status to be deleted. To delete a fleet, specify the fleet ID to be terminated. During the deletion process, the fleet status is changed to DELETING. Learn more Setting up Amazon GameLift Servers Fleets

Parameters​

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
regionstringAWS region (default: us-east-1)

SELECT examples​

This API works with the following fleet types: Container Retrieves the properties for a container fleet. When requesting attributes for multiple fleets, use the pagination parameters to retrieve results as a set of sequential pages. Request options Get container fleet properties for a single fleet. Provide either the fleet ID or ARN value. Results If successful, a ContainerFleet object is returned. This object includes the fleet properties, including information about the most recent deployment. Some API operations limit the number of fleet IDs that allowed in one request. If a request exceeds this limit, the request fails and the error message contains the maximum allowed number.

SELECT
billing_type,
creation_time,
deployment_details,
description,
fleet_arn,
fleet_id,
fleet_role_arn,
game_server_container_group_definition_arn,
game_server_container_group_definition_name,
game_server_container_groups_per_instance,
game_session_creation_limit_policy,
instance_connection_port_range,
instance_inbound_permissions,
instance_type,
location_attributes,
log_configuration,
maximum_game_server_container_groups_per_instance,
metric_groups,
new_game_session_protection_policy,
per_instance_container_group_definition_arn,
per_instance_container_group_definition_name,
player_gateway_mode,
status
FROM aws.gamelift.container_fleets
WHERE region = '{{ region }}' -- required
;

INSERT examples​

This API works with the following fleet types: Container Creates a managed fleet of Amazon Elastic Compute Cloud (Amazon EC2) instances to host your containerized game servers. Use this operation to define how to deploy a container architecture onto each fleet instance and configure fleet settings. You can create a container fleet in any Amazon Web Services Regions that Amazon GameLift Servers supports for multi-location fleets. A container fleet can be deployed to a single location or multiple locations. Container fleets are deployed with Amazon Linux 2023 as the instance operating system. Define the fleet's container architecture using container group definitions. Each fleet can have one of the following container group types: The game server container group runs your game server build and dependent software. Amazon GameLift Servers deploys one or more replicas of this container group to each fleet instance. The number of replicas depends on the computing capabilities of the fleet instance in use. An optional per-instance container group might be used to run other software that only needs to run once per instance, such as background services, logging, or test processes. One per-instance container group is deployed to each fleet instance. Each container group can include the definition for one or more containers. A container definition specifies a container image that is stored in an Amazon Elastic Container Registry (Amazon ECR) public or private repository. Request options Use this operation to make the following types of requests. Most fleet settings have default values, so you can create a working fleet with a minimal configuration and default values, which you can customize later. Create a fleet with no container groups. You can configure a container fleet and then add container group definitions later. In this scenario, no fleet instances are deployed, and the fleet can't host game sessions until you add a game server container group definition. Provide the following required parameter values: FleetRoleArn Create a fleet with a game server container group. Provide the following required parameter values: FleetRoleArn GameServerContainerGroupDefinitionName Create a fleet with a game server container group and a per-instance container group. Provide the following required parameter values: FleetRoleArn GameServerContainerGroupDefinitionName PerInstanceContainerGroupDefinitionName Results If successful, this operation creates a new container fleet resource, places it in PENDING status, and initiates the fleet creation workflow. For fleets with container groups, this workflow starts a fleet deployment and transitions the status to ACTIVE. Fleets without a container group are placed in CREATED status. You can update most of the properties of a fleet, including container group definitions, and deploy the update across all fleet instances. Use UpdateContainerFleet to deploy a new game server version update across the container fleet. A managed fleet's runtime environment depends on the Amazon Machine Image (AMI) version it uses. When a new fleet is created, Amazon GameLift Servers assigns the latest available AMI version to the fleet, and all compute instances in that fleet are deployed with that version. To update the AMI version, you must create a new fleet. As a best practice, we recommend replacing your managed fleets every 30 days to maintain a secure and up-to-date runtime environment for your hosted game servers. For guidance, see Security best practices for Amazon GameLift Servers.

INSERT INTO aws.gamelift.container_fleets (
FleetRoleArn,
Description,
GameServerContainerGroupDefinitionName,
PerInstanceContainerGroupDefinitionName,
InstanceConnectionPortRange,
InstanceInboundPermissions,
GameServerContainerGroupsPerInstance,
InstanceType,
BillingType,
Locations,
MetricGroups,
NewGameSessionProtectionPolicy,
GameSessionCreationLimitPolicy,
LogConfiguration,
Tags,
PlayerGatewayMode,
region
)
SELECT 
'{{ FleetRoleArn }}' /* required */,
'{{ Description }}',
'{{ GameServerContainerGroupDefinitionName }}',
'{{ PerInstanceContainerGroupDefinitionName }}',
'{{ InstanceConnectionPortRange }}',
'{{ InstanceInboundPermissions }}',
{{ GameServerContainerGroupsPerInstance }},
'{{ InstanceType }}',
'{{ BillingType }}',
'{{ Locations }}',
'{{ MetricGroups }}',
'{{ NewGameSessionProtectionPolicy }}',
'{{ GameSessionCreationLimitPolicy }}',
'{{ LogConfiguration }}',
'{{ Tags }}',
'{{ PlayerGatewayMode }}',
'{{ region }}'
RETURNING
container_fleet
;

UPDATE examples​

This API works with the following fleet types: Container Updates the properties of a managed container fleet. Depending on the properties being updated, this operation might initiate a fleet deployment. You can track deployments for a fleet using https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeFleetDeployment.html. A managed fleet's runtime environment, which depends on the fleet's Amazon Machine Image {AMI} version, can't be updated. You must create a new fleet. As a best practice, we recommend replacing your managed fleets every 30 days to maintain a secure and up-to-date runtime environment for your hosted game servers. For guidance, see Security best practices for Amazon GameLift Servers. Request options As with CreateContainerFleet, many fleet properties use common defaults or are calculated based on the fleet's container group definitions. Update fleet properties that result in a fleet deployment. Include only those properties that you want to change. Specify deployment configuration settings. Update fleet properties that don't result in a fleet deployment. Include only those properties that you want to change. Changes to the following properties initiate a fleet deployment: GameServerContainerGroupDefinition PerInstanceContainerGroupDefinition GameServerContainerGroupsPerInstance InstanceInboundPermissions InstanceConnectionPortRange LogConfiguration Results If successful, this operation updates the container fleet resource, and might initiate a new deployment of fleet resources using the deployment configuration provided. A deployment replaces existing fleet instances with new instances that are deployed with the updated fleet properties. The fleet is placed in UPDATING status until the deployment is complete, then return to ACTIVE. You can have only one update deployment active at a time for a fleet. If a second update request initiates a deployment while another deployment is in progress, the first deployment is cancelled.

UPDATE aws.gamelift.container_fleets
SET 
FleetId = '{{ FleetId }}',
GameServerContainerGroupDefinitionName = '{{ GameServerContainerGroupDefinitionName }}',
PerInstanceContainerGroupDefinitionName = '{{ PerInstanceContainerGroupDefinitionName }}',
GameServerContainerGroupsPerInstance = {{ GameServerContainerGroupsPerInstance }},
InstanceConnectionPortRange = '{{ InstanceConnectionPortRange }}',
InstanceInboundPermissionAuthorizations = '{{ InstanceInboundPermissionAuthorizations }}',
InstanceInboundPermissionRevocations = '{{ InstanceInboundPermissionRevocations }}',
DeploymentConfiguration = '{{ DeploymentConfiguration }}',
Description = '{{ Description }}',
MetricGroups = '{{ MetricGroups }}',
NewGameSessionProtectionPolicy = '{{ NewGameSessionProtectionPolicy }}',
GameSessionCreationLimitPolicy = '{{ GameSessionCreationLimitPolicy }}',
LogConfiguration = '{{ LogConfiguration }}',
RemoveAttributes = '{{ RemoveAttributes }}'
WHERE 
region = '{{ region }}' --required
AND FleetId = '{{ FleetId }}' --required
RETURNING
container_fleet;

DELETE examples​

This API works with the following fleet types: Container Deletes all resources and information related to a container fleet and shuts down currently running fleet instances, including those in remote locations. The container fleet must be in ACTIVE status to be deleted. To delete a fleet, specify the fleet ID to be terminated. During the deletion process, the fleet status is changed to DELETING. Learn more Setting up Amazon GameLift Servers Fleets

DELETE FROM aws.gamelift.container_fleets
WHERE region = '{{ region }}' --required
;
Last updated on