fleet_deployments

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

Overview

Name	fleet_deployments
Type	Resource
Id	aws.gamelift.fleet_deployments

Fields

The following fields are returned by SELECT queries:

describe_fleet_deployment

Name	Datatype	Description
fleet_deployment	object	The requested deployment information.
locational_deployments	object	If the deployment is for a multi-location fleet, the requests returns the deployment status in each fleet location.

list_fleet_deployments

Name	Datatype	Description
creation_time	string (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_configuration	object	Instructions for how to deploy updates to a container fleet and what actions to take if the deployment fails.
deployment_id	string	A unique identifier for the deployment. (pattern: <code>^[a-zA-Z0-9-]+$</code>)
deployment_status	string	The status of fleet deployment activity in the location. IN_PROGRESS -- The deployment is in progress. IMPAIRED -- The deployment failed and the fleet has some impaired containers. COMPLETE -- The deployment has completed successfully. ROLLBACK_IN_PROGRESS -- The deployment failed and rollback has been initiated. ROLLBACK_IN_COMPLETE -- The deployment failed and rollback has been completed. CANCELLED -- The deployment was cancelled. (IN_PROGRESS, IMPAIRED, COMPLETE, ROLLBACK_IN_PROGRESS, ROLLBACK_COMPLETE, CANCELLED, PENDING)
fleet_id	string	A unique identifier for the container fleet. (pattern: <code>^[a-z]*fleet-[a-zA-Z0-9-]+$</code>)
game_server_binary_arn	string	The unique identifier for the version of the game server container group definition that is being deployed. (pattern: <code>^[a-zA-Z0-9:/-]+$</code>)
per_instance_binary_arn	string	The unique identifier for the version of the per-instance container group definition that is being deployed. (pattern: <code>^[a-zA-Z0-9:/-]+$</code>)
rollback_game_server_binary_arn	string	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. (pattern: <code>^[a-zA-Z0-9:/-]+$</code>)
rollback_per_instance_binary_arn	string	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. (pattern: <code>^[a-zA-Z0-9:/-]+$</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_fleet_deployment	select	region		This API works with the following fleet types: Container Retrieves information about a managed container fleet deployment. Request options Get information about the latest deployment for a specific fleet. Provide the fleet ID or ARN. Get information about a specific deployment. Provide the fleet ID or ARN and the deployment ID. Results If successful, a FleetDeployment object is returned.
list_fleet_deployments	select	region		This API works with the following fleet types: Container Retrieves a collection of container fleet deployments in an Amazon Web Services Region. Use the pagination parameters to retrieve results as a set of sequential pages. Request options Get a list of all deployments. Call this operation without specifying a fleet ID. Get a list of all deployments for a fleet. Specify the container fleet ID or ARN value. Results If successful, this operation returns a list of deployments that match the request parameters. A NextToken value is also returned if there are more result pages to retrieve. Deployments are returned starting with the latest.

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.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

describe_fleet_deployment

This API works with the following fleet types: Container Retrieves information about a managed container fleet deployment. Request options Get information about the latest deployment for a specific fleet. Provide the fleet ID or ARN. Get information about a specific deployment. Provide the fleet ID or ARN and the deployment ID. Results If successful, a FleetDeployment object is returned.

SELECT
fleet_deployment,
locational_deployments
FROM aws.gamelift.fleet_deployments
WHERE region = '{{ region }}' -- required
;

list_fleet_deployments

This API works with the following fleet types: Container Retrieves a collection of container fleet deployments in an Amazon Web Services Region. Use the pagination parameters to retrieve results as a set of sequential pages. Request options Get a list of all deployments. Call this operation without specifying a fleet ID. Get a list of all deployments for a fleet. Specify the container fleet ID or ARN value. Results If successful, this operation returns a list of deployments that match the request parameters. A NextToken value is also returned if there are more result pages to retrieve. Deployments are returned starting with the latest.

SELECT
creation_time,
deployment_configuration,
deployment_id,
deployment_status,
fleet_id,
game_server_binary_arn,
per_instance_binary_arn,
rollback_game_server_binary_arn,
rollback_per_instance_binary_arn
FROM aws.gamelift.fleet_deployments
WHERE region = '{{ region }}' -- required
;