View a markdown version of this page

FleetDeployment - Amazon GameLift Servers

FleetDeployment

Describes a container fleet deployment with updates to the fleet.

Contents

Note

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

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

DeploymentConfiguration

Instructions for how to deploy updates to a container fleet and what actions to take if the deployment fails.

Type: DeploymentConfiguration object

Required: No

DeploymentId

A unique identifier for the deployment.

Type: String

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

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

Required: No

DeploymentStatus

The status of the fleet deployment. For per-location status, see LocationalDeployment.

  • PENDING -- Amazon GameLift Servers has accepted the deployment and hasn't started it yet.

  • IN_PROGRESS -- The deployment is in progress. This status covers validation as well as the replacement of the fleet's containers.

  • IMPAIRED -- The deployment failed validation, and the fleet kept the containers that failed validation so that you can inspect them. A deployment reaches this status when its impairment strategy is MAINTAIN.

  • COMPLETE -- The deployment has completed successfully in every fleet location.

  • ROLLBACK_IN_PROGRESS -- The deployment failed and rollback has been initiated. A deployment reaches this status when its impairment strategy is ROLLBACK.

  • ROLLBACK_COMPLETE -- The deployment failed and rollback has been completed. The fleet is running the configuration from the last successful deployment.

  • CANCELLED -- The deployment was cancelled because a new deployment started for the same fleet.

For how to debug an impaired deployment or cancel one, see Container fleet deployments.

Type: String

Valid Values: IN_PROGRESS | IMPAIRED | COMPLETE | ROLLBACK_IN_PROGRESS | ROLLBACK_COMPLETE | CANCELLED | PENDING

Required: No

FleetId

A unique identifier for the container fleet.

Type: String

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

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

Required: No

GameServerBinaryArn

The unique identifier for the version of the game server container group definition that is being deployed.

Type: String

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

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

Required: No

PerInstanceBinaryArn

The unique identifier for the version of the per-instance container group definition that is being deployed.

Type: String

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

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

Required: No

RollbackGameServerBinaryArn

The unique identifier for the version of the game server container group definition to roll back to if deployment fails. Amazon GameLift Servers sets this property to the container group definition version that the fleet used when it was last active.

Type: String

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

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

Required: No

RollbackPerInstanceBinaryArn

The unique identifier for the version of the per-instance container group definition to roll back to if deployment fails. Amazon GameLift Servers sets this property to the container group definition version that the fleet used when it was last active.

Type: String

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

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

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: