Container for the parameters to the UpdateContainerFleet operation. 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.
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.
Inheritance Hierarchy
Amazon.Runtime.AmazonWebServiceRequest
Amazon.GameLift.AmazonGameLiftRequest
Amazon.GameLift.Model.UpdateContainerFleetRequest
Namespace: Amazon.GameLift.Model
Assembly: AWSSDK.GameLift.dll
Version: 3.x.y.z
Syntax
public class UpdateContainerFleetRequest : AmazonGameLiftRequest IAmazonWebServiceRequest
The UpdateContainerFleetRequest type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
UpdateContainerFleetRequest() |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
DeploymentConfiguration | Amazon.GameLift.Model.DeploymentConfiguration |
Gets and sets the property DeploymentConfiguration. Instructions for how to deploy updates to a container fleet, if the fleet update initiates a deployment. The deployment configuration lets you determine how to replace fleet instances and what actions to take if the deployment fails. |
|
|
Description | System.String |
Gets and sets the property Description. A meaningful description of the container fleet. |
|
|
FleetId | System.String |
Gets and sets the property FleetId. A unique identifier for the container fleet to update. You can use either the fleet ID or ARN value. |
|
|
GameServerContainerGroupDefinitionName | System.String |
Gets and sets the property GameServerContainerGroupDefinitionName. The name or ARN value of a new game server container group definition to deploy on the fleet. If you're updating the fleet to a specific version of a container group definition, use the ARN value and include the version number. If you're updating the fleet to the latest version of a container group definition, you can use the name value. You can't remove a fleet's game server container group definition, you can only update or replace it with another definition. Update a container group definition by calling UpdateContainerGroupDefinition. This operation creates a ContainerGroupDefinition resource with an incremented version. |
|
|
GameServerContainerGroupsPerInstance | System.Int32 |
Gets and sets the property GameServerContainerGroupsPerInstance. The number of times to replicate the game server container group on each fleet instance. By default, Amazon GameLift calculates the maximum number of game server container groups that can fit on each instance. You can remove this property value to use the calculated value, or set it manually. If you set this number manually, Amazon GameLift uses your value as long as it's less than the calculated maximum. |
|
|
GameSessionCreationLimitPolicy | Amazon.GameLift.Model.GameSessionCreationLimitPolicy |
Gets and sets the property 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. |
|
|
InstanceConnectionPortRange | Amazon.GameLift.Model.ConnectionPortRange |
Gets and sets the property InstanceConnectionPortRange. A revised set of port numbers to open on each fleet instance. By default, Amazon GameLift calculates an optimal port range based on your fleet configuration. If you previously set this parameter manually, you can't reset this to use the calculated settings. |
|
|
InstanceInboundPermissionAuthorizations | System.Collections.Generic.List<Amazon.GameLift.Model.IpPermission> |
Gets and sets the property InstanceInboundPermissionAuthorizations. A set of ports to add to the container fleet's inbound permissions. |
|
|
InstanceInboundPermissionRevocations | System.Collections.Generic.List<Amazon.GameLift.Model.IpPermission> |
Gets and sets the property InstanceInboundPermissionRevocations. A set of ports to remove from the container fleet's inbound permissions. |
|
|
LogConfiguration | Amazon.GameLift.Model.LogConfiguration |
Gets and sets the property LogConfiguration. The method for collecting container logs for the fleet. |
|
|
MetricGroups | System.Collections.Generic.List<System.String> |
Gets and sets the property MetricGroups. The name of an Amazon Web Services CloudWatch metric group to add this fleet to. |
|
|
NewGameSessionProtectionPolicy | Amazon.GameLift.ProtectionPolicy |
Gets and sets the property NewGameSessionProtectionPolicy. The game session protection policy to apply to all new game sessions that are started in this fleet. Game sessions that already exist are not affected. |
|
|
PerInstanceContainerGroupDefinitionName | System.String |
Gets and sets the property PerInstanceContainerGroupDefinitionName. The name or ARN value of a new per-instance container group definition to deploy on the fleet. If you're updating the fleet to a specific version of a container group definition, use the ARN value and include the version number. If you're updating the fleet to the latest version of a container group definition, you can use the name value. Update a container group definition by calling UpdateContainerGroupDefinition. This operation creates a ContainerGroupDefinition resource with an incremented version.
To remove a fleet's per-instance container group definition, leave this parameter
empty and use the parameter |
|
|
RemoveAttributes | System.Collections.Generic.List<System.String> |
Gets and sets the property RemoveAttributes. If set, this update removes a fleet's per-instance container group definition. You can't remove a fleet's game server container group definition. |
Version Information
.NET:
Supported in: 8.0 and newer, Core 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5 and newer, 3.5