AWS Native v0.54.0, Mar 21 23

aws-native.gamelift.getFleet

The AWS::GameLift::Fleet resource creates an Amazon GameLift (GameLift) fleet to host game servers. A fleet is a set of EC2 or Anywhere instances, each of which can host multiple game sessions.

Using getFleet

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getFleet(args: GetFleetArgs, opts?: InvokeOptions): Promise<GetFleetResult>
function getFleetOutput(args: GetFleetOutputArgs, opts?: InvokeOptions): Output<GetFleetResult>

def get_fleet(fleet_id: Optional[str] = None,
              opts: Optional[InvokeOptions] = None) -> GetFleetResult
def get_fleet_output(fleet_id: Optional[pulumi.Input[str]] = None,
              opts: Optional[InvokeOptions] = None) -> Output[GetFleetResult]

func LookupFleet(ctx *Context, args *LookupFleetArgs, opts ...InvokeOption) (*LookupFleetResult, error)
func LookupFleetOutput(ctx *Context, args *LookupFleetOutputArgs, opts ...InvokeOption) LookupFleetResultOutput

> Note: This function is named LookupFleet in the Go SDK.

public static class GetFleet 
{
    public static Task<GetFleetResult> InvokeAsync(GetFleetArgs args, InvokeOptions? opts = null)
    public static Output<GetFleetResult> Invoke(GetFleetInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetFleetResult> getFleet(GetFleetArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: aws-native:gamelift:getFleet
  arguments:
    # arguments dictionary

The following arguments are supported:

FleetId string: Unique fleet ID

FleetId string: Unique fleet ID

fleetId String: Unique fleet ID

fleetId string: Unique fleet ID

fleet_id str: Unique fleet ID

fleetId String: Unique fleet ID

getFleet Result

The following output properties are available:

AnywhereConfiguration Pulumi.AwsNative.GameLift.Outputs.FleetAnywhereConfiguration

Configuration for Anywhere fleet.

Description string

A human-readable description of a fleet.

DesiredEC2Instances int

[DEPRECATED] The number of EC2 instances that you want this fleet to host. When creating a new fleet, GameLift automatically sets this value to "1" and initiates a single instance. Once the fleet is active, update this value to trigger GameLift to add or remove instances from the fleet.

EC2InboundPermissions List<Pulumi.AwsNative.GameLift.Outputs.FleetIpPermission>

A range of IP addresses and port settings that allow inbound traffic to connect to server processes on an Amazon GameLift server.

FleetId string

Unique fleet ID

Locations List<Pulumi.AwsNative.GameLift.Outputs.FleetLocationConfiguration>

MaxSize int

[DEPRECATED] The maximum value that is allowed for the fleet's instance count. When creating a new fleet, GameLift automatically sets this value to "1". Once the fleet is active, you can change this value.

MetricGroups List<string>

The name of an Amazon CloudWatch metric group. A metric group aggregates the metrics for all fleets in the group. Specify a string containing the metric group name. You can use an existing name or use a new name to create a new metric group. Currently, this parameter can have only one string.

MinSize int

[DEPRECATED] The minimum value allowed for the fleet's instance count. When creating a new fleet, GameLift automatically sets this value to "0". After the fleet is active, you can change this value.

Name string

A descriptive label that is associated with a fleet. Fleet names do not need to be unique.

NewGameSessionProtectionPolicy Pulumi.AwsNative.GameLift.FleetNewGameSessionProtectionPolicy

A game session protection policy to apply to all game sessions hosted on instances in this fleet. When protected, active game sessions cannot be terminated during a scale-down event. If this parameter is not set, instances in this fleet default to no protection. You can change a fleet's protection policy to affect future game sessions on the fleet. You can also set protection for individual game sessions.

ResourceCreationLimitPolicy Pulumi.AwsNative.GameLift.Outputs.FleetResourceCreationLimitPolicy

A policy that limits the number of game sessions an individual player can create over a span of time for this fleet.

RuntimeConfiguration Pulumi.AwsNative.GameLift.Outputs.FleetRuntimeConfiguration

Instructions for launching server processes on each instance in the fleet. Server processes run either a custom game build executable or a Realtime script. The runtime configuration defines the server executables or launch script file, launch parameters, and the number of processes to run concurrently on each instance. When creating a fleet, the runtime configuration must have at least one server process configuration; otherwise the request fails with an invalid request exception.

This parameter is required unless the parameters ServerLaunchPath and ServerLaunchParameters are defined. Runtime configuration has replaced these parameters, but fleets that use them will continue to work.

AnywhereConfiguration FleetAnywhereConfiguration

Configuration for Anywhere fleet.

Description string

A human-readable description of a fleet.

DesiredEC2Instances int

EC2InboundPermissions []FleetIpPermission

A range of IP addresses and port settings that allow inbound traffic to connect to server processes on an Amazon GameLift server.

FleetId string

Unique fleet ID

Locations []FleetLocationConfiguration

MaxSize int

MetricGroups []string

MinSize int

[DEPRECATED] The minimum value allowed for the fleet's instance count. When creating a new fleet, GameLift automatically sets this value to "0". After the fleet is active, you can change this value.

Name string

A descriptive label that is associated with a fleet. Fleet names do not need to be unique.

NewGameSessionProtectionPolicy FleetNewGameSessionProtectionPolicy

ResourceCreationLimitPolicy FleetResourceCreationLimitPolicy

A policy that limits the number of game sessions an individual player can create over a span of time for this fleet.

RuntimeConfiguration FleetRuntimeConfiguration

anywhereConfiguration FleetAnywhereConfiguration

Configuration for Anywhere fleet.

description String

A human-readable description of a fleet.

desiredEC2Instances Integer

eC2InboundPermissions List<FleetIpPermission>

A range of IP addresses and port settings that allow inbound traffic to connect to server processes on an Amazon GameLift server.

fleetId String

Unique fleet ID

locations List<FleetLocationConfiguration>

maxSize Integer

metricGroups List<String>

minSize Integer

[DEPRECATED] The minimum value allowed for the fleet's instance count. When creating a new fleet, GameLift automatically sets this value to "0". After the fleet is active, you can change this value.

name String

A descriptive label that is associated with a fleet. Fleet names do not need to be unique.

newGameSessionProtectionPolicy FleetNewGameSessionProtectionPolicy

resourceCreationLimitPolicy FleetResourceCreationLimitPolicy

A policy that limits the number of game sessions an individual player can create over a span of time for this fleet.

runtimeConfiguration FleetRuntimeConfiguration

anywhereConfiguration FleetAnywhereConfiguration

Configuration for Anywhere fleet.

description string

A human-readable description of a fleet.

desiredEC2Instances number

eC2InboundPermissions FleetIpPermission[]

A range of IP addresses and port settings that allow inbound traffic to connect to server processes on an Amazon GameLift server.

fleetId string

Unique fleet ID

locations FleetLocationConfiguration[]

maxSize number

metricGroups string[]

minSize number

[DEPRECATED] The minimum value allowed for the fleet's instance count. When creating a new fleet, GameLift automatically sets this value to "0". After the fleet is active, you can change this value.

name string

A descriptive label that is associated with a fleet. Fleet names do not need to be unique.

newGameSessionProtectionPolicy FleetNewGameSessionProtectionPolicy

resourceCreationLimitPolicy FleetResourceCreationLimitPolicy

A policy that limits the number of game sessions an individual player can create over a span of time for this fleet.

runtimeConfiguration FleetRuntimeConfiguration

anywhere_configuration FleetAnywhereConfiguration

Configuration for Anywhere fleet.

description str

A human-readable description of a fleet.

desired_ec2_instances int

e_c2_inbound_permissions Sequence[FleetIpPermission]

A range of IP addresses and port settings that allow inbound traffic to connect to server processes on an Amazon GameLift server.

fleet_id str

Unique fleet ID

locations Sequence[FleetLocationConfiguration]

max_size int

metric_groups Sequence[str]

min_size int

[DEPRECATED] The minimum value allowed for the fleet's instance count. When creating a new fleet, GameLift automatically sets this value to "0". After the fleet is active, you can change this value.

name str

A descriptive label that is associated with a fleet. Fleet names do not need to be unique.

new_game_session_protection_policy FleetNewGameSessionProtectionPolicy

resource_creation_limit_policy FleetResourceCreationLimitPolicy

A policy that limits the number of game sessions an individual player can create over a span of time for this fleet.

runtime_configuration FleetRuntimeConfiguration

anywhereConfiguration Property Map

Configuration for Anywhere fleet.

description String

A human-readable description of a fleet.

desiredEC2Instances Number

eC2InboundPermissions List<Property Map>

A range of IP addresses and port settings that allow inbound traffic to connect to server processes on an Amazon GameLift server.

fleetId String

Unique fleet ID

locations List<Property Map>

maxSize Number

metricGroups List<String>

minSize Number

[DEPRECATED] The minimum value allowed for the fleet's instance count. When creating a new fleet, GameLift automatically sets this value to "0". After the fleet is active, you can change this value.

name String

A descriptive label that is associated with a fleet. Fleet names do not need to be unique.

newGameSessionProtectionPolicy "FullProtection" | "NoProtection"

resourceCreationLimitPolicy Property Map

A policy that limits the number of game sessions an individual player can create over a span of time for this fleet.

runtimeConfiguration Property Map

Supporting Types

FleetAnywhereConfiguration

Cost string: Cost of compute can be specified on Anywhere Fleets to prioritize placement across Queue destinations based on Cost.

Cost string: Cost of compute can be specified on Anywhere Fleets to prioritize placement across Queue destinations based on Cost.

cost String: Cost of compute can be specified on Anywhere Fleets to prioritize placement across Queue destinations based on Cost.

cost string: Cost of compute can be specified on Anywhere Fleets to prioritize placement across Queue destinations based on Cost.

cost str: Cost of compute can be specified on Anywhere Fleets to prioritize placement across Queue destinations based on Cost.

cost String: Cost of compute can be specified on Anywhere Fleets to prioritize placement across Queue destinations based on Cost.

FleetIpPermission

FromPort int: A starting value for a range of allowed port numbers.
IpRange string: A range of allowed IP addresses. This value must be expressed in CIDR notation. Example: "000.000.000.000/[subnet mask]" or optionally the shortened version "0.0.0.0/[subnet mask]".
Protocol Pulumi.AwsNative.GameLift.FleetIpPermissionProtocol: The network communication protocol used by the fleet.
ToPort int: An ending value for a range of allowed port numbers. Port numbers are end-inclusive. This value must be higher than FromPort.

FromPort int: A starting value for a range of allowed port numbers.
IpRange string: A range of allowed IP addresses. This value must be expressed in CIDR notation. Example: "000.000.000.000/[subnet mask]" or optionally the shortened version "0.0.0.0/[subnet mask]".
Protocol FleetIpPermissionProtocol: The network communication protocol used by the fleet.
ToPort int: An ending value for a range of allowed port numbers. Port numbers are end-inclusive. This value must be higher than FromPort.

fromPort Integer: A starting value for a range of allowed port numbers.
ipRange String: A range of allowed IP addresses. This value must be expressed in CIDR notation. Example: "000.000.000.000/[subnet mask]" or optionally the shortened version "0.0.0.0/[subnet mask]".
protocol FleetIpPermissionProtocol: The network communication protocol used by the fleet.
toPort Integer: An ending value for a range of allowed port numbers. Port numbers are end-inclusive. This value must be higher than FromPort.

fromPort number: A starting value for a range of allowed port numbers.
ipRange string: A range of allowed IP addresses. This value must be expressed in CIDR notation. Example: "000.000.000.000/[subnet mask]" or optionally the shortened version "0.0.0.0/[subnet mask]".
protocol FleetIpPermissionProtocol: The network communication protocol used by the fleet.
toPort number: An ending value for a range of allowed port numbers. Port numbers are end-inclusive. This value must be higher than FromPort.

from_port int: A starting value for a range of allowed port numbers.
ip_range str: A range of allowed IP addresses. This value must be expressed in CIDR notation. Example: "000.000.000.000/[subnet mask]" or optionally the shortened version "0.0.0.0/[subnet mask]".
protocol FleetIpPermissionProtocol: The network communication protocol used by the fleet.
to_port int: An ending value for a range of allowed port numbers. Port numbers are end-inclusive. This value must be higher than FromPort.

fromPort Number: A starting value for a range of allowed port numbers.
ipRange String: A range of allowed IP addresses. This value must be expressed in CIDR notation. Example: "000.000.000.000/[subnet mask]" or optionally the shortened version "0.0.0.0/[subnet mask]".
protocol "TCP" | "UDP": The network communication protocol used by the fleet.
toPort Number: An ending value for a range of allowed port numbers. Port numbers are end-inclusive. This value must be higher than FromPort.

FleetIpPermissionProtocol

FleetLocationCapacity

DesiredEC2Instances int: The number of EC2 instances you want to maintain in the specified fleet location. This value must fall between the minimum and maximum size limits.
MaxSize int: The maximum value that is allowed for the fleet's instance count for a location. When creating a new fleet, GameLift automatically sets this value to "1". Once the fleet is active, you can change this value.
MinSize int: The minimum value allowed for the fleet's instance count for a location. When creating a new fleet, GameLift automatically sets this value to "0". After the fleet is active, you can change this value.

DesiredEC2Instances int: The number of EC2 instances you want to maintain in the specified fleet location. This value must fall between the minimum and maximum size limits.
MaxSize int: The maximum value that is allowed for the fleet's instance count for a location. When creating a new fleet, GameLift automatically sets this value to "1". Once the fleet is active, you can change this value.
MinSize int: The minimum value allowed for the fleet's instance count for a location. When creating a new fleet, GameLift automatically sets this value to "0". After the fleet is active, you can change this value.

desiredEC2Instances Integer: The number of EC2 instances you want to maintain in the specified fleet location. This value must fall between the minimum and maximum size limits.
maxSize Integer: The maximum value that is allowed for the fleet's instance count for a location. When creating a new fleet, GameLift automatically sets this value to "1". Once the fleet is active, you can change this value.
minSize Integer: The minimum value allowed for the fleet's instance count for a location. When creating a new fleet, GameLift automatically sets this value to "0". After the fleet is active, you can change this value.

desiredEC2Instances number: The number of EC2 instances you want to maintain in the specified fleet location. This value must fall between the minimum and maximum size limits.
maxSize number: The maximum value that is allowed for the fleet's instance count for a location. When creating a new fleet, GameLift automatically sets this value to "1". Once the fleet is active, you can change this value.
minSize number: The minimum value allowed for the fleet's instance count for a location. When creating a new fleet, GameLift automatically sets this value to "0". After the fleet is active, you can change this value.

desired_ec2_instances int: The number of EC2 instances you want to maintain in the specified fleet location. This value must fall between the minimum and maximum size limits.
max_size int: The maximum value that is allowed for the fleet's instance count for a location. When creating a new fleet, GameLift automatically sets this value to "1". Once the fleet is active, you can change this value.
min_size int: The minimum value allowed for the fleet's instance count for a location. When creating a new fleet, GameLift automatically sets this value to "0". After the fleet is active, you can change this value.

desiredEC2Instances Number: The number of EC2 instances you want to maintain in the specified fleet location. This value must fall between the minimum and maximum size limits.
maxSize Number: The maximum value that is allowed for the fleet's instance count for a location. When creating a new fleet, GameLift automatically sets this value to "1". Once the fleet is active, you can change this value.
minSize Number: The minimum value allowed for the fleet's instance count for a location. When creating a new fleet, GameLift automatically sets this value to "0". After the fleet is active, you can change this value.

FleetLocationConfiguration

Location string
LocationCapacity Pulumi.AwsNative.GameLift.Inputs.FleetLocationCapacity

Location string
LocationCapacity FleetLocationCapacity

location String
locationCapacity FleetLocationCapacity

location string
locationCapacity FleetLocationCapacity

location str
location_capacity FleetLocationCapacity

location String
locationCapacity Property Map

FleetNewGameSessionProtectionPolicy

FleetResourceCreationLimitPolicy

NewGameSessionsPerCreator int: The maximum number of game sessions that an individual can create during the policy period.
PolicyPeriodInMinutes int: The time span used in evaluating the resource creation limit policy.

NewGameSessionsPerCreator int: The maximum number of game sessions that an individual can create during the policy period.
PolicyPeriodInMinutes int: The time span used in evaluating the resource creation limit policy.

newGameSessionsPerCreator Integer: The maximum number of game sessions that an individual can create during the policy period.
policyPeriodInMinutes Integer: The time span used in evaluating the resource creation limit policy.

newGameSessionsPerCreator number: The maximum number of game sessions that an individual can create during the policy period.
policyPeriodInMinutes number: The time span used in evaluating the resource creation limit policy.

new_game_sessions_per_creator int: The maximum number of game sessions that an individual can create during the policy period.
policy_period_in_minutes int: The time span used in evaluating the resource creation limit policy.

newGameSessionsPerCreator Number: The maximum number of game sessions that an individual can create during the policy period.
policyPeriodInMinutes Number: The time span used in evaluating the resource creation limit policy.

FleetRuntimeConfiguration

GameSessionActivationTimeoutSeconds int: The maximum amount of time (in seconds) that a game session can remain in status ACTIVATING. If the game session is not active before the timeout, activation is terminated and the game session status is changed to TERMINATED.
MaxConcurrentGameSessionActivations int: The maximum number of game sessions with status ACTIVATING to allow on an instance simultaneously. This setting limits the amount of instance resources that can be used for new game activations at any one time.
ServerProcesses List<Pulumi.AwsNative.GameLift.Inputs.FleetServerProcess>: A collection of server process configurations that describe which server processes to run on each instance in a fleet.

GameSessionActivationTimeoutSeconds int: The maximum amount of time (in seconds) that a game session can remain in status ACTIVATING. If the game session is not active before the timeout, activation is terminated and the game session status is changed to TERMINATED.
MaxConcurrentGameSessionActivations int: The maximum number of game sessions with status ACTIVATING to allow on an instance simultaneously. This setting limits the amount of instance resources that can be used for new game activations at any one time.
ServerProcesses []FleetServerProcess: A collection of server process configurations that describe which server processes to run on each instance in a fleet.

gameSessionActivationTimeoutSeconds Integer: The maximum amount of time (in seconds) that a game session can remain in status ACTIVATING. If the game session is not active before the timeout, activation is terminated and the game session status is changed to TERMINATED.
maxConcurrentGameSessionActivations Integer: The maximum number of game sessions with status ACTIVATING to allow on an instance simultaneously. This setting limits the amount of instance resources that can be used for new game activations at any one time.
serverProcesses List<FleetServerProcess>: A collection of server process configurations that describe which server processes to run on each instance in a fleet.

gameSessionActivationTimeoutSeconds number: The maximum amount of time (in seconds) that a game session can remain in status ACTIVATING. If the game session is not active before the timeout, activation is terminated and the game session status is changed to TERMINATED.
maxConcurrentGameSessionActivations number: The maximum number of game sessions with status ACTIVATING to allow on an instance simultaneously. This setting limits the amount of instance resources that can be used for new game activations at any one time.
serverProcesses FleetServerProcess[]: A collection of server process configurations that describe which server processes to run on each instance in a fleet.

game_session_activation_timeout_seconds int: The maximum amount of time (in seconds) that a game session can remain in status ACTIVATING. If the game session is not active before the timeout, activation is terminated and the game session status is changed to TERMINATED.
max_concurrent_game_session_activations int: The maximum number of game sessions with status ACTIVATING to allow on an instance simultaneously. This setting limits the amount of instance resources that can be used for new game activations at any one time.
server_processes Sequence[FleetServerProcess]: A collection of server process configurations that describe which server processes to run on each instance in a fleet.

gameSessionActivationTimeoutSeconds Number: The maximum amount of time (in seconds) that a game session can remain in status ACTIVATING. If the game session is not active before the timeout, activation is terminated and the game session status is changed to TERMINATED.
maxConcurrentGameSessionActivations Number: The maximum number of game sessions with status ACTIVATING to allow on an instance simultaneously. This setting limits the amount of instance resources that can be used for new game activations at any one time.
serverProcesses List<Property Map>: A collection of server process configurations that describe which server processes to run on each instance in a fleet.

FleetServerProcess

ConcurrentExecutions int

The number of server processes that use this configuration to run concurrently on an instance.

LaunchPath string

The location of the server executable in a custom game build or the name of the Realtime script file that contains the Init() function. Game builds and Realtime scripts are installed on instances at the root:

Windows (for custom game builds only): C:\game. Example: "C:\game\MyGame\server.exe"

Linux: /local/game. Examples: "/local/game/MyGame/server.exe" or "/local/game/MyRealtimeScript.js"

Parameters string

An optional list of parameters to pass to the server executable or Realtime script on launch.

ConcurrentExecutions int

The number of server processes that use this configuration to run concurrently on an instance.

LaunchPath string

Windows (for custom game builds only): C:\game. Example: "C:\game\MyGame\server.exe"

Linux: /local/game. Examples: "/local/game/MyGame/server.exe" or "/local/game/MyRealtimeScript.js"

Parameters string

An optional list of parameters to pass to the server executable or Realtime script on launch.

concurrentExecutions Integer

The number of server processes that use this configuration to run concurrently on an instance.

launchPath String

Windows (for custom game builds only): C:\game. Example: "C:\game\MyGame\server.exe"

Linux: /local/game. Examples: "/local/game/MyGame/server.exe" or "/local/game/MyRealtimeScript.js"

parameters String

An optional list of parameters to pass to the server executable or Realtime script on launch.

concurrentExecutions number

The number of server processes that use this configuration to run concurrently on an instance.

launchPath string

Windows (for custom game builds only): C:\game. Example: "C:\game\MyGame\server.exe"

Linux: /local/game. Examples: "/local/game/MyGame/server.exe" or "/local/game/MyRealtimeScript.js"

parameters string

An optional list of parameters to pass to the server executable or Realtime script on launch.

concurrent_executions int

The number of server processes that use this configuration to run concurrently on an instance.

launch_path str

Windows (for custom game builds only): C:\game. Example: "C:\game\MyGame\server.exe"

Linux: /local/game. Examples: "/local/game/MyGame/server.exe" or "/local/game/MyRealtimeScript.js"

parameters str

An optional list of parameters to pass to the server executable or Realtime script on launch.

concurrentExecutions Number

The number of server processes that use this configuration to run concurrently on an instance.

launchPath String

Windows (for custom game builds only): C:\game. Example: "C:\game\MyGame\server.exe"

Linux: /local/game. Examples: "/local/game/MyGame/server.exe" or "/local/game/MyRealtimeScript.js"

parameters String

An optional list of parameters to pass to the server executable or Realtime script on launch.

Package Details

Repository: AWS Native pulumi/pulumi-aws-native
License: Apache-2.0

aws-native.gamelift.getFleet

Using getFleet

getFleet Result

Supporting Types

FleetAnywhereConfiguration

FleetIpPermission

FleetIpPermissionProtocol

FleetLocationCapacity

FleetLocationConfiguration

FleetNewGameSessionProtectionPolicy

FleetResourceCreationLimitPolicy

FleetRuntimeConfiguration

FleetServerProcess

Package Details

Contents