Fleet

Provides a Gamelift Fleet resource.

Example Usage

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
    public MyStack()
    {
        var example = new Aws.GameLift.Fleet("example", new Aws.GameLift.FleetArgs
        {
            BuildId = aws_gamelift_build.Example.Id,
            Ec2InstanceType = "t2.micro",
            FleetType = "ON_DEMAND",
            RuntimeConfiguration = new Aws.GameLift.Inputs.FleetRuntimeConfigurationArgs
            {
                ServerProcesses = 
                {
                    new Aws.GameLift.Inputs.FleetRuntimeConfigurationServerProcessArgs
                    {
                        ConcurrentExecutions = 1,
                        LaunchPath = "C:\\game\\GomokuServer.exe",
                    },
                },
            },
        });
    }

}

package main

import (
    "github.com/pulumi/pulumi-aws/sdk/v2/go/aws/gamelift"
    "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        _, err := gamelift.NewFleet(ctx, "example", &gamelift.FleetArgs{
            BuildId:         pulumi.String(aws_gamelift_build.Example.Id),
            Ec2InstanceType: pulumi.String("t2.micro"),
            FleetType:       pulumi.String("ON_DEMAND"),
            RuntimeConfiguration: &gamelift.FleetRuntimeConfigurationArgs{
                ServerProcesses: gamelift.FleetRuntimeConfigurationServerProcessArray{
                    &gamelift.FleetRuntimeConfigurationServerProcessArgs{
                        ConcurrentExecutions: pulumi.Int(1),
                        LaunchPath:           pulumi.String("C:\\game\\GomokuServer.exe"),
                    },
                },
            },
        })
        if err != nil {
            return err
        }
        return nil
    })
}

import pulumi
import pulumi_aws as aws

example = aws.gamelift.Fleet("example",
    build_id=aws_gamelift_build["example"]["id"],
    ec2_instance_type="t2.micro",
    fleet_type="ON_DEMAND",
    runtime_configuration={
        "serverProcesses": [{
            "concurrentExecutions": 1,
            "launchPath": "C:\\game\\GomokuServer.exe",
        }],
    })

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.gamelift.Fleet("example", {
    buildId: aws_gamelift_build_example.id,
    ec2InstanceType: "t2.micro",
    fleetType: "ON_DEMAND",
    runtimeConfiguration: {
        serverProcesses: [{
            concurrentExecutions: 1,
            launchPath: "C:\\game\\GomokuServer.exe",
        }],
    },
});

Create a Fleet Resource

new Fleet(name: string, args: FleetArgs, opts?: CustomResourceOptions);

def Fleet(resource_name, opts=None, build_id=None, description=None, ec2_inbound_permissions=None, ec2_instance_type=None, fleet_type=None, instance_role_arn=None, metric_groups=None, name=None, new_game_session_protection_policy=None, resource_creation_limit_policy=None, runtime_configuration=None, tags=None, __props__=None);

func NewFleet(ctx *Context, name string, args FleetArgs, opts ...ResourceOption) (*Fleet, error)

public Fleet(string name, FleetArgs args, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args FleetArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args FleetArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args FleetArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

Fleet Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The Fleet resource accepts the following input properties:

BuildId string: ID of the Gamelift Build to be deployed on the fleet.
Ec2InstanceType string: Name of an EC2 instance type. e.g. t2.micro
Description string: Human-readable description of the fleet.
Ec2InboundPermissions List<FleetEc2InboundPermissionArgs>: Range of IP addresses and port settings that permit inbound traffic to access server processes running on the fleet. See below.
FleetType string: Type of fleet. This value must be ON_DEMAND or SPOT. Defaults to ON_DEMAND.
InstanceRoleArn string: ARN of an IAM role that instances in the fleet can assume.
MetricGroups List<string>: List of names of metric groups to add this fleet to. A metric group tracks metrics across all fleets in the group. Defaults to default.
Name string: The name of the fleet.
NewGameSessionProtectionPolicy string: Game session protection policy to apply to all instances in this fleet. e.g. FullProtection. Defaults to NoProtection.
ResourceCreationLimitPolicy FleetResourceCreationLimitPolicyArgs: Policy that limits the number of game sessions an individual player can create over a span of time for this fleet. See below.
RuntimeConfiguration FleetRuntimeConfigurationArgs: Instructions for launching server processes on each instance in the fleet. See below.
Tags Dictionary<string, string>: Key-value map of resource tags

BuildId string: ID of the Gamelift Build to be deployed on the fleet.
Ec2InstanceType string: Name of an EC2 instance type. e.g. t2.micro
Description string: Human-readable description of the fleet.
Ec2InboundPermissions []FleetEc2InboundPermission: Range of IP addresses and port settings that permit inbound traffic to access server processes running on the fleet. See below.
FleetType string: Type of fleet. This value must be ON_DEMAND or SPOT. Defaults to ON_DEMAND.
InstanceRoleArn string: ARN of an IAM role that instances in the fleet can assume.
MetricGroups []string: List of names of metric groups to add this fleet to. A metric group tracks metrics across all fleets in the group. Defaults to default.
Name string: The name of the fleet.
NewGameSessionProtectionPolicy string: Game session protection policy to apply to all instances in this fleet. e.g. FullProtection. Defaults to NoProtection.
ResourceCreationLimitPolicy FleetResourceCreationLimitPolicy: Policy that limits the number of game sessions an individual player can create over a span of time for this fleet. See below.
RuntimeConfiguration FleetRuntimeConfiguration: Instructions for launching server processes on each instance in the fleet. See below.
Tags map[string]string: Key-value map of resource tags

buildId string: ID of the Gamelift Build to be deployed on the fleet.
ec2InstanceType string: Name of an EC2 instance type. e.g. t2.micro
description string: Human-readable description of the fleet.
ec2InboundPermissions FleetEc2InboundPermission[]: Range of IP addresses and port settings that permit inbound traffic to access server processes running on the fleet. See below.
fleetType string: Type of fleet. This value must be ON_DEMAND or SPOT. Defaults to ON_DEMAND.
instanceRoleArn string: ARN of an IAM role that instances in the fleet can assume.
metricGroups string[]: List of names of metric groups to add this fleet to. A metric group tracks metrics across all fleets in the group. Defaults to default.
name string: The name of the fleet.
newGameSessionProtectionPolicy string: Game session protection policy to apply to all instances in this fleet. e.g. FullProtection. Defaults to NoProtection.
resourceCreationLimitPolicy FleetResourceCreationLimitPolicy: Policy that limits the number of game sessions an individual player can create over a span of time for this fleet. See below.
runtimeConfiguration FleetRuntimeConfiguration: Instructions for launching server processes on each instance in the fleet. See below.
tags {[key: string]: string}: Key-value map of resource tags

build_id str: ID of the Gamelift Build to be deployed on the fleet.
ec2_instance_type str: Name of an EC2 instance type. e.g. t2.micro
description str: Human-readable description of the fleet.
ec2_inbound_permissions List[FleetEc2InboundPermission]: Range of IP addresses and port settings that permit inbound traffic to access server processes running on the fleet. See below.
fleet_type str: Type of fleet. This value must be ON_DEMAND or SPOT. Defaults to ON_DEMAND.
instance_role_arn str: ARN of an IAM role that instances in the fleet can assume.
metric_groups List[str]: List of names of metric groups to add this fleet to. A metric group tracks metrics across all fleets in the group. Defaults to default.
name str: The name of the fleet.
new_game_session_protection_policy str: Game session protection policy to apply to all instances in this fleet. e.g. FullProtection. Defaults to NoProtection.
resource_creation_limit_policy Dict[FleetResourceCreationLimitPolicy]: Policy that limits the number of game sessions an individual player can create over a span of time for this fleet. See below.
runtime_configuration Dict[FleetRuntimeConfiguration]: Instructions for launching server processes on each instance in the fleet. See below.
tags Dict[str, str]: Key-value map of resource tags

Outputs

All input properties are implicitly available as output properties. Additionally, the Fleet resource produces the following output properties:

Arn string: Fleet ARN.
Id string: The provider-assigned unique ID for this managed resource.
LogPaths List<string>
OperatingSystem string: Operating system of the fleet’s computing resources.

Arn string: Fleet ARN.
Id string: The provider-assigned unique ID for this managed resource.
LogPaths []string
OperatingSystem string: Operating system of the fleet’s computing resources.

arn string: Fleet ARN.
id string: The provider-assigned unique ID for this managed resource.
logPaths string[]
operatingSystem string: Operating system of the fleet’s computing resources.

arn str: Fleet ARN.
id str: The provider-assigned unique ID for this managed resource.
log_paths List[str]
operating_system str: Operating system of the fleet’s computing resources.

Look up an Existing Fleet Resource

Get an existing Fleet resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: FleetState, opts?: CustomResourceOptions): Fleet

static get(resource_name, id, opts=None, arn=None, build_id=None, description=None, ec2_inbound_permissions=None, ec2_instance_type=None, fleet_type=None, instance_role_arn=None, log_paths=None, metric_groups=None, name=None, new_game_session_protection_policy=None, operating_system=None, resource_creation_limit_policy=None, runtime_configuration=None, tags=None, __props__=None);

func GetFleet(ctx *Context, name string, id IDInput, state *FleetState, opts ...ResourceOption) (*Fleet, error)

public static Fleet Get(string name, Input<string> id, FleetState? state, CustomResourceOptions? opts = null)

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

Arn string: Fleet ARN.
BuildId string: ID of the Gamelift Build to be deployed on the fleet.
Description string: Human-readable description of the fleet.
Ec2InboundPermissions List<FleetEc2InboundPermissionArgs>: Range of IP addresses and port settings that permit inbound traffic to access server processes running on the fleet. See below.
Ec2InstanceType string: Name of an EC2 instance type. e.g. t2.micro
FleetType string: Type of fleet. This value must be ON_DEMAND or SPOT. Defaults to ON_DEMAND.
InstanceRoleArn string: ARN of an IAM role that instances in the fleet can assume.
LogPaths List<string>
MetricGroups List<string>: List of names of metric groups to add this fleet to. A metric group tracks metrics across all fleets in the group. Defaults to default.
Name string: The name of the fleet.
NewGameSessionProtectionPolicy string: Game session protection policy to apply to all instances in this fleet. e.g. FullProtection. Defaults to NoProtection.
OperatingSystem string: Operating system of the fleet’s computing resources.
ResourceCreationLimitPolicy FleetResourceCreationLimitPolicyArgs: Policy that limits the number of game sessions an individual player can create over a span of time for this fleet. See below.
RuntimeConfiguration FleetRuntimeConfigurationArgs: Instructions for launching server processes on each instance in the fleet. See below.
Tags Dictionary<string, string>: Key-value map of resource tags

Arn string: Fleet ARN.
BuildId string: ID of the Gamelift Build to be deployed on the fleet.
Description string: Human-readable description of the fleet.
Ec2InboundPermissions []FleetEc2InboundPermission: Range of IP addresses and port settings that permit inbound traffic to access server processes running on the fleet. See below.
Ec2InstanceType string: Name of an EC2 instance type. e.g. t2.micro
FleetType string: Type of fleet. This value must be ON_DEMAND or SPOT. Defaults to ON_DEMAND.
InstanceRoleArn string: ARN of an IAM role that instances in the fleet can assume.
LogPaths []string
MetricGroups []string: List of names of metric groups to add this fleet to. A metric group tracks metrics across all fleets in the group. Defaults to default.
Name string: The name of the fleet.
NewGameSessionProtectionPolicy string: Game session protection policy to apply to all instances in this fleet. e.g. FullProtection. Defaults to NoProtection.
OperatingSystem string: Operating system of the fleet’s computing resources.
ResourceCreationLimitPolicy FleetResourceCreationLimitPolicy: Policy that limits the number of game sessions an individual player can create over a span of time for this fleet. See below.
RuntimeConfiguration FleetRuntimeConfiguration: Instructions for launching server processes on each instance in the fleet. See below.
Tags map[string]string: Key-value map of resource tags

arn string: Fleet ARN.
buildId string: ID of the Gamelift Build to be deployed on the fleet.
description string: Human-readable description of the fleet.
ec2InboundPermissions FleetEc2InboundPermission[]: Range of IP addresses and port settings that permit inbound traffic to access server processes running on the fleet. See below.
ec2InstanceType string: Name of an EC2 instance type. e.g. t2.micro
fleetType string: Type of fleet. This value must be ON_DEMAND or SPOT. Defaults to ON_DEMAND.
instanceRoleArn string: ARN of an IAM role that instances in the fleet can assume.
logPaths string[]
metricGroups string[]: List of names of metric groups to add this fleet to. A metric group tracks metrics across all fleets in the group. Defaults to default.
name string: The name of the fleet.
newGameSessionProtectionPolicy string: Game session protection policy to apply to all instances in this fleet. e.g. FullProtection. Defaults to NoProtection.
operatingSystem string: Operating system of the fleet’s computing resources.
resourceCreationLimitPolicy FleetResourceCreationLimitPolicy: Policy that limits the number of game sessions an individual player can create over a span of time for this fleet. See below.
runtimeConfiguration FleetRuntimeConfiguration: Instructions for launching server processes on each instance in the fleet. See below.
tags {[key: string]: string}: Key-value map of resource tags

arn str: Fleet ARN.
build_id str: ID of the Gamelift Build to be deployed on the fleet.
description str: Human-readable description of the fleet.
ec2_inbound_permissions List[FleetEc2InboundPermission]: Range of IP addresses and port settings that permit inbound traffic to access server processes running on the fleet. See below.
ec2_instance_type str: Name of an EC2 instance type. e.g. t2.micro
fleet_type str: Type of fleet. This value must be ON_DEMAND or SPOT. Defaults to ON_DEMAND.
instance_role_arn str: ARN of an IAM role that instances in the fleet can assume.
log_paths List[str]
metric_groups List[str]: List of names of metric groups to add this fleet to. A metric group tracks metrics across all fleets in the group. Defaults to default.
name str: The name of the fleet.
new_game_session_protection_policy str: Game session protection policy to apply to all instances in this fleet. e.g. FullProtection. Defaults to NoProtection.
operating_system str: Operating system of the fleet’s computing resources.
resource_creation_limit_policy Dict[FleetResourceCreationLimitPolicy]: Policy that limits the number of game sessions an individual player can create over a span of time for this fleet. See below.
runtime_configuration Dict[FleetRuntimeConfiguration]: Instructions for launching server processes on each instance in the fleet. See below.
tags Dict[str, str]: Key-value map of resource tags

Supporting Types

FleetEc2InboundPermission

See the input and output API doc for this type.

FromPort int: Starting value for a range of allowed port numbers.
IpRange string: Range of allowed IP addresses expressed in CIDR notation. e.g. 000.000.000.000/[subnet mask] or 0.0.0.0/[subnet mask].
Protocol string: Network communication protocol used by the fleet. e.g. TCP or UDP
ToPort int: Ending value for a range of allowed port numbers. Port numbers are end-inclusive. This value must be higher than from_port.

FromPort int: Starting value for a range of allowed port numbers.
IpRange string: Range of allowed IP addresses expressed in CIDR notation. e.g. 000.000.000.000/[subnet mask] or 0.0.0.0/[subnet mask].
Protocol string: Network communication protocol used by the fleet. e.g. TCP or UDP
ToPort int: Ending value for a range of allowed port numbers. Port numbers are end-inclusive. This value must be higher than from_port.

fromPort number: Starting value for a range of allowed port numbers.
ipRange string: Range of allowed IP addresses expressed in CIDR notation. e.g. 000.000.000.000/[subnet mask] or 0.0.0.0/[subnet mask].
protocol string: Network communication protocol used by the fleet. e.g. TCP or UDP
toPort number: Ending value for a range of allowed port numbers. Port numbers are end-inclusive. This value must be higher than from_port.

from_port float: Starting value for a range of allowed port numbers.
ipRange str: Range of allowed IP addresses expressed in CIDR notation. e.g. 000.000.000.000/[subnet mask] or 0.0.0.0/[subnet mask].
protocol str: Network communication protocol used by the fleet. e.g. TCP or UDP
to_port float: Ending value for a range of allowed port numbers. Port numbers are end-inclusive. This value must be higher than from_port.

FleetResourceCreationLimitPolicy

See the input and output API doc for this type.

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

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

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

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

FleetRuntimeConfiguration

See the input and output API doc for this type.

GameSessionActivationTimeoutSeconds int: Maximum amount of time (in seconds) that a game session can remain in status ACTIVATING.
MaxConcurrentGameSessionActivations int: Maximum number of game sessions with status ACTIVATING to allow on an instance simultaneously.
ServerProcesses List<FleetRuntimeConfigurationServerProcessArgs>: Collection of server process configurations that describe which server processes to run on each instance in a fleet. See below.

GameSessionActivationTimeoutSeconds int: Maximum amount of time (in seconds) that a game session can remain in status ACTIVATING.
MaxConcurrentGameSessionActivations int: Maximum number of game sessions with status ACTIVATING to allow on an instance simultaneously.
ServerProcesses []FleetRuntimeConfigurationServerProcess: Collection of server process configurations that describe which server processes to run on each instance in a fleet. See below.

gameSessionActivationTimeoutSeconds number: Maximum amount of time (in seconds) that a game session can remain in status ACTIVATING.
maxConcurrentGameSessionActivations number: Maximum number of game sessions with status ACTIVATING to allow on an instance simultaneously.
serverProcesses FleetRuntimeConfigurationServerProcess[]: Collection of server process configurations that describe which server processes to run on each instance in a fleet. See below.

gameSessionActivationTimeoutSeconds float: Maximum amount of time (in seconds) that a game session can remain in status ACTIVATING.
maxConcurrentGameSessionActivations float: Maximum number of game sessions with status ACTIVATING to allow on an instance simultaneously.
serverProcesses List[FleetRuntimeConfigurationServerProcess]: Collection of server process configurations that describe which server processes to run on each instance in a fleet. See below.

FleetRuntimeConfigurationServerProcess

See the input and output API doc for this type.

ConcurrentExecutions int: Number of server processes using this configuration to run concurrently on an instance.
LaunchPath string: Location of the server executable in a game build. All game builds are installed on instances at the root : for Windows instances C:\game, and for Linux instances /local/game.
Parameters string: Optional list of parameters to pass to the server executable on launch.

ConcurrentExecutions int: Number of server processes using this configuration to run concurrently on an instance.
LaunchPath string: Location of the server executable in a game build. All game builds are installed on instances at the root : for Windows instances C:\game, and for Linux instances /local/game.
Parameters string: Optional list of parameters to pass to the server executable on launch.

concurrentExecutions number: Number of server processes using this configuration to run concurrently on an instance.
launchPath string: Location of the server executable in a game build. All game builds are installed on instances at the root : for Windows instances C:\game, and for Linux instances /local/game.
parameters string: Optional list of parameters to pass to the server executable on launch.

concurrentExecutions float: Number of server processes using this configuration to run concurrently on an instance.
launchPath str: Location of the server executable in a game build. All game builds are installed on instances at the root : for Windows instances C:\game, and for Linux instances /local/game.
parameters str: Optional list of parameters to pass to the server executable on launch.

Package Details

Repository: https://github.com/pulumi/pulumi-aws
License: Apache-2.0
Notes: This Pulumi package is based on the aws Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

Fleet

Example Usage

Create a Fleet Resource

Fleet Resource Properties

Inputs

Outputs

Look up an Existing Fleet Resource

Supporting Types

FleetEc2InboundPermission

FleetResourceCreationLimitPolicy

FleetRuntimeConfiguration

FleetRuntimeConfigurationServerProcess

Package Details

On This Page