We recommend new projects start with resources from the AWS provider.
aws-native.gamelift.getFleet
Explore with Pulumi AI
We recommend new projects start with resources from the AWS provider.
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:
- Fleet
Id string - Unique fleet ID
- Fleet
Id string - Unique fleet ID
- fleet
Id String - Unique fleet ID
- fleet
Id string - Unique fleet ID
- fleet_
id str - Unique fleet ID
- fleet
Id String - Unique fleet ID
getFleet Result
The following output properties are available:
- Anywhere
Configuration Pulumi.Aws Native. Game Lift. Outputs. Fleet Anywhere Configuration - Configuration for Anywhere fleet.
- Description string
- A human-readable description of a fleet.
- Desired
Ec2Instances 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.
- Ec2Inbound
Permissions List<Pulumi.Aws Native. Game Lift. Outputs. Fleet Ip Permission> - A range of IP addresses and port settings that allow inbound traffic to connect to server processes on an Amazon GameLift server.
- Fleet
Id string - Unique fleet ID
- Locations
List<Pulumi.
Aws Native. Game Lift. Outputs. Fleet Location Configuration> - A set of remote locations to deploy additional instances to and manage as a multi-location fleet. Use this parameter when creating a fleet in AWS Regions that support multiple locations. You can add any AWS Region or Local Zone that's supported by Amazon GameLift. Provide a list of one or more AWS Region codes, such as
us-west-2
, or Local Zone names. When using this parameter, Amazon GameLift requires you to include your home location in the request. For a list of supported Regions and Local Zones, see Amazon GameLift service locations for managed hosting. - Max
Size 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.
- Metric
Groups 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.
- 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 string
- A descriptive label that is associated with a fleet. Fleet names do not need to be unique.
- New
Game Pulumi.Session Protection Policy Aws Native. Game Lift. Fleet New Game Session Protection Policy - 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.
- Resource
Creation Pulumi.Limit Policy Aws Native. Game Lift. Outputs. Fleet Resource Creation Limit Policy - A policy that limits the number of game sessions an individual player can create over a span of time for this fleet.
- Runtime
Configuration Pulumi.Aws Native. Game Lift. Outputs. Fleet Runtime Configuration 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.
- Scaling
Policies List<Pulumi.Aws Native. Game Lift. Outputs. Fleet Scaling Policy> - A list of rules that control how a fleet is scaled.
- Anywhere
Configuration FleetAnywhere Configuration - Configuration for Anywhere fleet.
- Description string
- A human-readable description of a fleet.
- Desired
Ec2Instances 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.
- Ec2Inbound
Permissions []FleetIp Permission - A range of IP addresses and port settings that allow inbound traffic to connect to server processes on an Amazon GameLift server.
- Fleet
Id string - Unique fleet ID
- Locations
[]Fleet
Location Configuration - A set of remote locations to deploy additional instances to and manage as a multi-location fleet. Use this parameter when creating a fleet in AWS Regions that support multiple locations. You can add any AWS Region or Local Zone that's supported by Amazon GameLift. Provide a list of one or more AWS Region codes, such as
us-west-2
, or Local Zone names. When using this parameter, Amazon GameLift requires you to include your home location in the request. For a list of supported Regions and Local Zones, see Amazon GameLift service locations for managed hosting. - Max
Size 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.
- Metric
Groups []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.
- 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 string
- A descriptive label that is associated with a fleet. Fleet names do not need to be unique.
- New
Game FleetSession Protection Policy New Game Session Protection Policy - 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.
- Resource
Creation FleetLimit Policy Resource Creation Limit Policy - A policy that limits the number of game sessions an individual player can create over a span of time for this fleet.
- Runtime
Configuration FleetRuntime Configuration 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.
- Scaling
Policies []FleetScaling Policy - A list of rules that control how a fleet is scaled.
- anywhere
Configuration FleetAnywhere Configuration - Configuration for Anywhere fleet.
- description String
- A human-readable description of a fleet.
- desired
Ec2Instances Integer - [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.
- ec2Inbound
Permissions List<FleetIp Permission> - A range of IP addresses and port settings that allow inbound traffic to connect to server processes on an Amazon GameLift server.
- fleet
Id String - Unique fleet ID
- locations
List<Fleet
Location Configuration> - A set of remote locations to deploy additional instances to and manage as a multi-location fleet. Use this parameter when creating a fleet in AWS Regions that support multiple locations. You can add any AWS Region or Local Zone that's supported by Amazon GameLift. Provide a list of one or more AWS Region codes, such as
us-west-2
, or Local Zone names. When using this parameter, Amazon GameLift requires you to include your home location in the request. For a list of supported Regions and Local Zones, see Amazon GameLift service locations for managed hosting. - max
Size Integer - [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.
- metric
Groups 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.
- min
Size 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.
- new
Game FleetSession Protection Policy New Game Session Protection Policy - 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.
- resource
Creation FleetLimit Policy Resource Creation Limit Policy - A policy that limits the number of game sessions an individual player can create over a span of time for this fleet.
- runtime
Configuration FleetRuntime Configuration 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.
- scaling
Policies List<FleetScaling Policy> - A list of rules that control how a fleet is scaled.
- anywhere
Configuration FleetAnywhere Configuration - Configuration for Anywhere fleet.
- description string
- A human-readable description of a fleet.
- desired
Ec2Instances number - [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.
- ec2Inbound
Permissions FleetIp Permission[] - A range of IP addresses and port settings that allow inbound traffic to connect to server processes on an Amazon GameLift server.
- fleet
Id string - Unique fleet ID
- locations
Fleet
Location Configuration[] - A set of remote locations to deploy additional instances to and manage as a multi-location fleet. Use this parameter when creating a fleet in AWS Regions that support multiple locations. You can add any AWS Region or Local Zone that's supported by Amazon GameLift. Provide a list of one or more AWS Region codes, such as
us-west-2
, or Local Zone names. When using this parameter, Amazon GameLift requires you to include your home location in the request. For a list of supported Regions and Local Zones, see Amazon GameLift service locations for managed hosting. - max
Size number - [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.
- metric
Groups 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.
- min
Size 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.
- new
Game FleetSession Protection Policy New Game Session Protection Policy - 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.
- resource
Creation FleetLimit Policy Resource Creation Limit Policy - A policy that limits the number of game sessions an individual player can create over a span of time for this fleet.
- runtime
Configuration FleetRuntime Configuration 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.
- scaling
Policies FleetScaling Policy[] - A list of rules that control how a fleet is scaled.
- anywhere_
configuration FleetAnywhere Configuration - Configuration for Anywhere fleet.
- description str
- A human-readable description of a fleet.
- desired_
ec2_ intinstances - [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.
- ec2_
inbound_ Sequence[Fleetpermissions Ip Permission] - 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[Fleet
Location Configuration] - A set of remote locations to deploy additional instances to and manage as a multi-location fleet. Use this parameter when creating a fleet in AWS Regions that support multiple locations. You can add any AWS Region or Local Zone that's supported by Amazon GameLift. Provide a list of one or more AWS Region codes, such as
us-west-2
, or Local Zone names. When using this parameter, Amazon GameLift requires you to include your home location in the request. For a list of supported Regions and Local Zones, see Amazon GameLift service locations for managed hosting. - max_
size 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.
- metric_
groups Sequence[str] - 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.
- 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_ Fleetsession_ protection_ policy New Game Session Protection Policy - 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.
- resource_
creation_ Fleetlimit_ policy Resource Creation Limit Policy - A policy that limits the number of game sessions an individual player can create over a span of time for this fleet.
- runtime_
configuration FleetRuntime Configuration 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.
- scaling_
policies Sequence[FleetScaling Policy] - A list of rules that control how a fleet is scaled.
- anywhere
Configuration Property Map - Configuration for Anywhere fleet.
- description String
- A human-readable description of a fleet.
- desired
Ec2Instances Number - [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.
- ec2Inbound
Permissions 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.
- fleet
Id String - Unique fleet ID
- locations List<Property Map>
- A set of remote locations to deploy additional instances to and manage as a multi-location fleet. Use this parameter when creating a fleet in AWS Regions that support multiple locations. You can add any AWS Region or Local Zone that's supported by Amazon GameLift. Provide a list of one or more AWS Region codes, such as
us-west-2
, or Local Zone names. When using this parameter, Amazon GameLift requires you to include your home location in the request. For a list of supported Regions and Local Zones, see Amazon GameLift service locations for managed hosting. - max
Size Number - [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.
- metric
Groups 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.
- min
Size 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.
- new
Game "FullSession Protection Policy Protection" | "No Protection" - 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.
- resource
Creation Property MapLimit Policy - A policy that limits the number of game sessions an individual player can create over a span of time for this fleet.
- runtime
Configuration Property Map 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.
- scaling
Policies List<Property Map> - A list of rules that control how a fleet is scaled.
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
- From
Port int - A starting value for a range of allowed port numbers.
- Ip
Range 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.
Aws Native. Game Lift. Fleet Ip Permission Protocol - 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.
- From
Port int - A starting value for a range of allowed port numbers.
- Ip
Range 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
Fleet
Ip Permission Protocol - 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.
- from
Port Integer - A starting value for a range of allowed port numbers.
- ip
Range 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
Fleet
Ip Permission Protocol - The network communication protocol used by the fleet.
- to
Port Integer - An ending value for a range of allowed port numbers. Port numbers are end-inclusive. This value must be higher than FromPort.
- from
Port number - A starting value for a range of allowed port numbers.
- ip
Range 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
Fleet
Ip Permission Protocol - The network communication protocol used by the fleet.
- to
Port 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
Fleet
Ip Permission Protocol - 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.
- from
Port Number - A starting value for a range of allowed port numbers.
- ip
Range 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.
- to
Port 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
- Desired
Ec2Instances 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.
- Desired
Ec2Instances 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.
- desired
Ec2Instances 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.
- max
Size 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.
- min
Size 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.
- desired
Ec2Instances 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.
- max
Size 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.
- min
Size 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_ intinstances - 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.
- desired
Ec2Instances 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.
- max
Size 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.
- min
Size 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
- An AWS Region code, such as
us-west-2
. For a list of supported Regions and Local Zones, see Amazon GameLift service locations for managed hosting. - Location
Capacity Pulumi.Aws Native. Game Lift. Inputs. Fleet Location Capacity Current resource capacity settings for managed EC2 fleets and managed container fleets. For multi-location fleets, location values might refer to a fleet's remote location or its home Region.
Returned by: DescribeFleetCapacity , DescribeFleetLocationCapacity , UpdateFleetCapacity
- Location string
- An AWS Region code, such as
us-west-2
. For a list of supported Regions and Local Zones, see Amazon GameLift service locations for managed hosting. - Location
Capacity FleetLocation Capacity Current resource capacity settings for managed EC2 fleets and managed container fleets. For multi-location fleets, location values might refer to a fleet's remote location or its home Region.
Returned by: DescribeFleetCapacity , DescribeFleetLocationCapacity , UpdateFleetCapacity
- location String
- An AWS Region code, such as
us-west-2
. For a list of supported Regions and Local Zones, see Amazon GameLift service locations for managed hosting. - location
Capacity FleetLocation Capacity Current resource capacity settings for managed EC2 fleets and managed container fleets. For multi-location fleets, location values might refer to a fleet's remote location or its home Region.
Returned by: DescribeFleetCapacity , DescribeFleetLocationCapacity , UpdateFleetCapacity
- location string
- An AWS Region code, such as
us-west-2
. For a list of supported Regions and Local Zones, see Amazon GameLift service locations for managed hosting. - location
Capacity FleetLocation Capacity Current resource capacity settings for managed EC2 fleets and managed container fleets. For multi-location fleets, location values might refer to a fleet's remote location or its home Region.
Returned by: DescribeFleetCapacity , DescribeFleetLocationCapacity , UpdateFleetCapacity
- location str
- An AWS Region code, such as
us-west-2
. For a list of supported Regions and Local Zones, see Amazon GameLift service locations for managed hosting. - location_
capacity FleetLocation Capacity Current resource capacity settings for managed EC2 fleets and managed container fleets. For multi-location fleets, location values might refer to a fleet's remote location or its home Region.
Returned by: DescribeFleetCapacity , DescribeFleetLocationCapacity , UpdateFleetCapacity
- location String
- An AWS Region code, such as
us-west-2
. For a list of supported Regions and Local Zones, see Amazon GameLift service locations for managed hosting. - location
Capacity Property Map Current resource capacity settings for managed EC2 fleets and managed container fleets. For multi-location fleets, location values might refer to a fleet's remote location or its home Region.
Returned by: DescribeFleetCapacity , DescribeFleetLocationCapacity , UpdateFleetCapacity
FleetNewGameSessionProtectionPolicy
FleetResourceCreationLimitPolicy
- New
Game intSessions Per Creator - The maximum number of game sessions that an individual can create during the policy period.
- Policy
Period intIn Minutes - The time span used in evaluating the resource creation limit policy.
- New
Game intSessions Per Creator - The maximum number of game sessions that an individual can create during the policy period.
- Policy
Period intIn Minutes - The time span used in evaluating the resource creation limit policy.
- new
Game IntegerSessions Per Creator - The maximum number of game sessions that an individual can create during the policy period.
- policy
Period IntegerIn Minutes - The time span used in evaluating the resource creation limit policy.
- new
Game numberSessions Per Creator - The maximum number of game sessions that an individual can create during the policy period.
- policy
Period numberIn Minutes - The time span used in evaluating the resource creation limit policy.
- new_
game_ intsessions_ per_ creator - The maximum number of game sessions that an individual can create during the policy period.
- policy_
period_ intin_ minutes - The time span used in evaluating the resource creation limit policy.
- new
Game NumberSessions Per Creator - The maximum number of game sessions that an individual can create during the policy period.
- policy
Period NumberIn Minutes - The time span used in evaluating the resource creation limit policy.
FleetRuntimeConfiguration
- Game
Session intActivation Timeout Seconds - 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 intGame Session Activations - 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 List<Pulumi.Aws Native. Game Lift. Inputs. Fleet Server Process> - A collection of server process configurations that describe which server processes to run on each instance in a fleet.
- Game
Session intActivation Timeout Seconds - 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 intGame Session Activations - 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 []FleetServer Process - A collection of server process configurations that describe which server processes to run on each instance in a fleet.
- game
Session IntegerActivation Timeout Seconds - 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 IntegerGame Session Activations - 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 List<FleetServer Process> - A collection of server process configurations that describe which server processes to run on each instance in a fleet.
- game
Session numberActivation Timeout Seconds - 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 numberGame Session Activations - 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 FleetServer Process[] - A collection of server process configurations that describe which server processes to run on each instance in a fleet.
- game_
session_ intactivation_ timeout_ seconds - 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_ intgame_ session_ activations - 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[FleetServer Process] - A collection of server process configurations that describe which server processes to run on each instance in a fleet.
- game
Session NumberActivation Timeout Seconds - 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 NumberGame Session Activations - 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 List<Property Map> - A collection of server process configurations that describe which server processes to run on each instance in a fleet.
FleetScalingPolicy
- Metric
Name Pulumi.Aws Native. Game Lift. Fleet Scaling Policy Metric Name - Name of the Amazon GameLift-defined metric that is used to trigger a scaling adjustment.
- Name string
- A descriptive label that is associated with a fleet's scaling policy. Policy names do not need to be unique.
- Comparison
Operator Pulumi.Aws Native. Game Lift. Fleet Scaling Policy Comparison Operator - Comparison operator to use when measuring a metric against the threshold value.
- Evaluation
Periods int - Length of time (in minutes) the metric must be at or beyond the threshold before a scaling event is triggered.
- Location string
- The fleet location.
- Policy
Type Pulumi.Aws Native. Game Lift. Fleet Scaling Policy Policy Type - The type of scaling policy to create. For a target-based policy, set the parameter MetricName to 'PercentAvailableGameSessions' and specify a TargetConfiguration. For a rule-based policy set the following parameters: MetricName, ComparisonOperator, Threshold, EvaluationPeriods, ScalingAdjustmentType, and ScalingAdjustment.
- Scaling
Adjustment int - Amount of adjustment to make, based on the scaling adjustment type.
- Scaling
Adjustment Pulumi.Type Aws Native. Game Lift. Fleet Scaling Policy Scaling Adjustment Type - The type of adjustment to make to a fleet's instance count.
- Status
Pulumi.
Aws Native. Game Lift. Fleet Scaling Policy Status - Current status of the scaling policy. The scaling policy can be in force only when in an ACTIVE status. Scaling policies can be suspended for individual fleets. If the policy is suspended for a fleet, the policy status does not change.
- Target
Configuration Pulumi.Aws Native. Game Lift. Inputs. Fleet Target Configuration - An object that contains settings for a target-based scaling policy.
- Threshold double
- Metric value used to trigger a scaling event.
- Update
Status Pulumi.Aws Native. Game Lift. Fleet Scaling Policy Update Status - The current status of the fleet's scaling policies in a requested fleet location. The status PENDING_UPDATE indicates that an update was requested for the fleet but has not yet been completed for the location.
- Metric
Name FleetScaling Policy Metric Name - Name of the Amazon GameLift-defined metric that is used to trigger a scaling adjustment.
- Name string
- A descriptive label that is associated with a fleet's scaling policy. Policy names do not need to be unique.
- Comparison
Operator FleetScaling Policy Comparison Operator - Comparison operator to use when measuring a metric against the threshold value.
- Evaluation
Periods int - Length of time (in minutes) the metric must be at or beyond the threshold before a scaling event is triggered.
- Location string
- The fleet location.
- Policy
Type FleetScaling Policy Policy Type - The type of scaling policy to create. For a target-based policy, set the parameter MetricName to 'PercentAvailableGameSessions' and specify a TargetConfiguration. For a rule-based policy set the following parameters: MetricName, ComparisonOperator, Threshold, EvaluationPeriods, ScalingAdjustmentType, and ScalingAdjustment.
- Scaling
Adjustment int - Amount of adjustment to make, based on the scaling adjustment type.
- Scaling
Adjustment FleetType Scaling Policy Scaling Adjustment Type - The type of adjustment to make to a fleet's instance count.
- Status
Fleet
Scaling Policy Status - Current status of the scaling policy. The scaling policy can be in force only when in an ACTIVE status. Scaling policies can be suspended for individual fleets. If the policy is suspended for a fleet, the policy status does not change.
- Target
Configuration FleetTarget Configuration - An object that contains settings for a target-based scaling policy.
- Threshold float64
- Metric value used to trigger a scaling event.
- Update
Status FleetScaling Policy Update Status - The current status of the fleet's scaling policies in a requested fleet location. The status PENDING_UPDATE indicates that an update was requested for the fleet but has not yet been completed for the location.
- metric
Name FleetScaling Policy Metric Name - Name of the Amazon GameLift-defined metric that is used to trigger a scaling adjustment.
- name String
- A descriptive label that is associated with a fleet's scaling policy. Policy names do not need to be unique.
- comparison
Operator FleetScaling Policy Comparison Operator - Comparison operator to use when measuring a metric against the threshold value.
- evaluation
Periods Integer - Length of time (in minutes) the metric must be at or beyond the threshold before a scaling event is triggered.
- location String
- The fleet location.
- policy
Type FleetScaling Policy Policy Type - The type of scaling policy to create. For a target-based policy, set the parameter MetricName to 'PercentAvailableGameSessions' and specify a TargetConfiguration. For a rule-based policy set the following parameters: MetricName, ComparisonOperator, Threshold, EvaluationPeriods, ScalingAdjustmentType, and ScalingAdjustment.
- scaling
Adjustment Integer - Amount of adjustment to make, based on the scaling adjustment type.
- scaling
Adjustment FleetType Scaling Policy Scaling Adjustment Type - The type of adjustment to make to a fleet's instance count.
- status
Fleet
Scaling Policy Status - Current status of the scaling policy. The scaling policy can be in force only when in an ACTIVE status. Scaling policies can be suspended for individual fleets. If the policy is suspended for a fleet, the policy status does not change.
- target
Configuration FleetTarget Configuration - An object that contains settings for a target-based scaling policy.
- threshold Double
- Metric value used to trigger a scaling event.
- update
Status FleetScaling Policy Update Status - The current status of the fleet's scaling policies in a requested fleet location. The status PENDING_UPDATE indicates that an update was requested for the fleet but has not yet been completed for the location.
- metric
Name FleetScaling Policy Metric Name - Name of the Amazon GameLift-defined metric that is used to trigger a scaling adjustment.
- name string
- A descriptive label that is associated with a fleet's scaling policy. Policy names do not need to be unique.
- comparison
Operator FleetScaling Policy Comparison Operator - Comparison operator to use when measuring a metric against the threshold value.
- evaluation
Periods number - Length of time (in minutes) the metric must be at or beyond the threshold before a scaling event is triggered.
- location string
- The fleet location.
- policy
Type FleetScaling Policy Policy Type - The type of scaling policy to create. For a target-based policy, set the parameter MetricName to 'PercentAvailableGameSessions' and specify a TargetConfiguration. For a rule-based policy set the following parameters: MetricName, ComparisonOperator, Threshold, EvaluationPeriods, ScalingAdjustmentType, and ScalingAdjustment.
- scaling
Adjustment number - Amount of adjustment to make, based on the scaling adjustment type.
- scaling
Adjustment FleetType Scaling Policy Scaling Adjustment Type - The type of adjustment to make to a fleet's instance count.
- status
Fleet
Scaling Policy Status - Current status of the scaling policy. The scaling policy can be in force only when in an ACTIVE status. Scaling policies can be suspended for individual fleets. If the policy is suspended for a fleet, the policy status does not change.
- target
Configuration FleetTarget Configuration - An object that contains settings for a target-based scaling policy.
- threshold number
- Metric value used to trigger a scaling event.
- update
Status FleetScaling Policy Update Status - The current status of the fleet's scaling policies in a requested fleet location. The status PENDING_UPDATE indicates that an update was requested for the fleet but has not yet been completed for the location.
- metric_
name FleetScaling Policy Metric Name - Name of the Amazon GameLift-defined metric that is used to trigger a scaling adjustment.
- name str
- A descriptive label that is associated with a fleet's scaling policy. Policy names do not need to be unique.
- comparison_
operator FleetScaling Policy Comparison Operator - Comparison operator to use when measuring a metric against the threshold value.
- evaluation_
periods int - Length of time (in minutes) the metric must be at or beyond the threshold before a scaling event is triggered.
- location str
- The fleet location.
- policy_
type FleetScaling Policy Policy Type - The type of scaling policy to create. For a target-based policy, set the parameter MetricName to 'PercentAvailableGameSessions' and specify a TargetConfiguration. For a rule-based policy set the following parameters: MetricName, ComparisonOperator, Threshold, EvaluationPeriods, ScalingAdjustmentType, and ScalingAdjustment.
- scaling_
adjustment int - Amount of adjustment to make, based on the scaling adjustment type.
- scaling_
adjustment_ Fleettype Scaling Policy Scaling Adjustment Type - The type of adjustment to make to a fleet's instance count.
- status
Fleet
Scaling Policy Status - Current status of the scaling policy. The scaling policy can be in force only when in an ACTIVE status. Scaling policies can be suspended for individual fleets. If the policy is suspended for a fleet, the policy status does not change.
- target_
configuration FleetTarget Configuration - An object that contains settings for a target-based scaling policy.
- threshold float
- Metric value used to trigger a scaling event.
- update_
status FleetScaling Policy Update Status - The current status of the fleet's scaling policies in a requested fleet location. The status PENDING_UPDATE indicates that an update was requested for the fleet but has not yet been completed for the location.
- metric
Name "ActivatingGame Sessions" | "Active Game Sessions" | "Active Instances" | "Available Game Sessions" | "Available Player Sessions" | "Current Player Sessions" | "Idle Instances" | "Percent Available Game Sessions" | "Percent Idle Instances" | "Queue Depth" | "Wait Time" | "Concurrent Activatable Game Sessions" - Name of the Amazon GameLift-defined metric that is used to trigger a scaling adjustment.
- name String
- A descriptive label that is associated with a fleet's scaling policy. Policy names do not need to be unique.
- comparison
Operator "GreaterThan Or Equal To Threshold" | "Greater Than Threshold" | "Less Than Threshold" | "Less Than Or Equal To Threshold" - Comparison operator to use when measuring a metric against the threshold value.
- evaluation
Periods Number - Length of time (in minutes) the metric must be at or beyond the threshold before a scaling event is triggered.
- location String
- The fleet location.
- policy
Type "RuleBased" | "Target Based" - The type of scaling policy to create. For a target-based policy, set the parameter MetricName to 'PercentAvailableGameSessions' and specify a TargetConfiguration. For a rule-based policy set the following parameters: MetricName, ComparisonOperator, Threshold, EvaluationPeriods, ScalingAdjustmentType, and ScalingAdjustment.
- scaling
Adjustment Number - Amount of adjustment to make, based on the scaling adjustment type.
- scaling
Adjustment "ChangeType In Capacity" | "Exact Capacity" | "Percent Change In Capacity" - The type of adjustment to make to a fleet's instance count.
- status "ACTIVE" | "UPDATE_REQUESTED" | "UPDATING" | "DELETE_REQUESTED" | "DELETING" | "DELETED" | "ERROR"
- Current status of the scaling policy. The scaling policy can be in force only when in an ACTIVE status. Scaling policies can be suspended for individual fleets. If the policy is suspended for a fleet, the policy status does not change.
- target
Configuration Property Map - An object that contains settings for a target-based scaling policy.
- threshold Number
- Metric value used to trigger a scaling event.
- update
Status "PENDING_UPDATE" - The current status of the fleet's scaling policies in a requested fleet location. The status PENDING_UPDATE indicates that an update was requested for the fleet but has not yet been completed for the location.
FleetScalingPolicyComparisonOperator
FleetScalingPolicyMetricName
FleetScalingPolicyPolicyType
FleetScalingPolicyScalingAdjustmentType
FleetScalingPolicyStatus
FleetScalingPolicyUpdateStatus
FleetServerProcess
- Concurrent
Executions int - The number of server processes that use this configuration to run concurrently on an instance.
- Launch
Path 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.
- Concurrent
Executions int - The number of server processes that use this configuration to run concurrently on an instance.
- Launch
Path 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.
- concurrent
Executions Integer - The number of server processes that use this configuration to run concurrently on an instance.
- launch
Path 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.
- concurrent
Executions number - The number of server processes that use this configuration to run concurrently on an instance.
- launch
Path 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.
- concurrent_
executions int - The number of server processes that use this configuration to run concurrently on an instance.
- launch_
path str 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 str
- An optional list of parameters to pass to the server executable or Realtime script on launch.
- concurrent
Executions Number - The number of server processes that use this configuration to run concurrently on an instance.
- launch
Path 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.
FleetTargetConfiguration
- Target
Value double - Desired value to use with a target-based scaling policy. The value must be relevant for whatever metric the scaling policy is using. For example, in a policy using the metric PercentAvailableGameSessions, the target value should be the preferred size of the fleet's buffer (the percent of capacity that should be idle and ready for new game sessions).
- Target
Value float64 - Desired value to use with a target-based scaling policy. The value must be relevant for whatever metric the scaling policy is using. For example, in a policy using the metric PercentAvailableGameSessions, the target value should be the preferred size of the fleet's buffer (the percent of capacity that should be idle and ready for new game sessions).
- target
Value Double - Desired value to use with a target-based scaling policy. The value must be relevant for whatever metric the scaling policy is using. For example, in a policy using the metric PercentAvailableGameSessions, the target value should be the preferred size of the fleet's buffer (the percent of capacity that should be idle and ready for new game sessions).
- target
Value number - Desired value to use with a target-based scaling policy. The value must be relevant for whatever metric the scaling policy is using. For example, in a policy using the metric PercentAvailableGameSessions, the target value should be the preferred size of the fleet's buffer (the percent of capacity that should be idle and ready for new game sessions).
- target_
value float - Desired value to use with a target-based scaling policy. The value must be relevant for whatever metric the scaling policy is using. For example, in a policy using the metric PercentAvailableGameSessions, the target value should be the preferred size of the fleet's buffer (the percent of capacity that should be idle and ready for new game sessions).
- target
Value Number - Desired value to use with a target-based scaling policy. The value must be relevant for whatever metric the scaling policy is using. For example, in a policy using the metric PercentAvailableGameSessions, the target value should be the preferred size of the fleet's buffer (the percent of capacity that should be idle and ready for new game sessions).
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.