Fleet class

Provides a GameLift Fleet resource.

Example Usage

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

const example = new aws.gamelift.Fleet("example", {
    runtimeConfiguration: {
        serverProcesses: [{
            concurrentExecutions: 1,
            launchPath: "C:\\game\\GomokuServer.exe",
        }],
    },
    buildId: exampleAwsGameliftBuild.id,
    ec2InstanceType: "t2.micro",
    fleetType: "ON_DEMAND",
    name: "example-fleet-name",
});
import pulumi
import pulumi_aws as aws

example = aws.gamelift.Fleet("example",
    runtime_configuration={
        "server_processes": [{
            "concurrent_executions": 1,
            "launch_path": "C:\\game\\GomokuServer.exe",
        }],
    },
    build_id=example_aws_gamelift_build["id"],
    ec2_instance_type="t2.micro",
    fleet_type="ON_DEMAND",
    name="example-fleet-name")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var example = new Aws.GameLift.Fleet("example", new()
    {
        RuntimeConfiguration = new Aws.GameLift.Inputs.FleetRuntimeConfigurationArgs
        {
            ServerProcesses = new[]
            {
                new Aws.GameLift.Inputs.FleetRuntimeConfigurationServerProcessArgs
                {
                    ConcurrentExecutions = 1,
                    LaunchPath = "C:\\game\\GomokuServer.exe",
                },
            },
        },
        BuildId = exampleAwsGameliftBuild.Id,
        Ec2InstanceType = "t2.micro",
        FleetType = "ON_DEMAND",
        Name = "example-fleet-name",
    });

});
package main

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

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

resource "aws_gamelift_fleet" "example" {
  runtime_configuration = {
    server_processes = [{
      "concurrentExecutions" = 1
      "launchPath"           = "C:\\game\\GomokuServer.exe"
    }]
  }
  build_id          = exampleAwsGameliftBuild.id
  ec2_instance_type = "t2.micro"
  fleet_type        = "ON_DEMAND"
  name              = "example-fleet-name"
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.gamelift.Fleet;
import com.pulumi.aws.gamelift.FleetArgs;
import com.pulumi.aws.gamelift.inputs.FleetRuntimeConfigurationArgs;
import com.pulumi.aws.gamelift.inputs.FleetRuntimeConfigurationServerProcessArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new Fleet("example", FleetArgs.builder()
            .runtimeConfiguration(FleetRuntimeConfigurationArgs.builder()
                .serverProcesses(FleetRuntimeConfigurationServerProcessArgs.builder()
                    .concurrentExecutions(1)
                    .launchPath("C:\\game\\GomokuServer.exe")
                    .build())
                .build())
            .buildId(exampleAwsGameliftBuild.id())
            .ec2InstanceType("t2.micro")
            .fleetType("ON_DEMAND")
            .name("example-fleet-name")
            .build());

    }
}
resources:
  example:
    type: aws:gamelift:Fleet
    properties:
      runtimeConfiguration:
        serverProcesses:
          - concurrentExecutions: 1
            launchPath: C:\game\GomokuServer.exe
      buildId: ${exampleAwsGameliftBuild.id}
      ec2InstanceType: t2.micro
      fleetType: ON_DEMAND
      name: example-fleet-name

Import

Using pulumi import, import GameLift Fleets using the ID. For example:

$ pulumi import aws:gamelift/fleet:Fleet example <fleet-id>

Constructors

Fleet(String name, {FleetArgs? args, CustomResourceOptions? options})
Creates a new Fleet. name The Pulumi resource name. args Arguments used to configure this Fleet. The set of arguments for Fleet. options Resource options controlling this resource's behavior.
Fleet.reference(String urn)
Creates a typed reference to an existing Fleet resource.

Properties

arn ↔ Output<String>
Fleet ARN.
latefinal
buildArn ↔ Output<String>
Build ARN.
latefinal
buildId ↔ Output<String?>
ID of the GameLift Build to be deployed on the fleet. Conflicts with scriptId.
latefinal
certificateConfiguration ↔ Output<FleetCertificateConfiguration>
Prompts GameLift to generate a TLS/SSL certificate for the fleet. See certificate_configuration.
latefinal
childResources → Set<Resource>
finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
description ↔ Output<String?>
Human-readable description of the fleet.
latefinal
ec2InboundPermissions ↔ Output<List<FleetEc2InboundPermission>>
Range of IP addresses and port settings that permit inbound traffic to access server processes running on the fleet. See below.
latefinal
ec2InstanceType ↔ Output<String>
Name of an EC2 instance typeE.g., t2.micro
latefinal
fleetType ↔ Output<String?>
Type of fleet. This value must be ON_DEMAND or SPOT. Defaults to ON_DEMAND.
latefinal
hashCode → int
The hash code for this object.
no setterinherited
id ↔ Output<String>
getter/setter pairinherited
instanceRoleArn ↔ Output<String?>
ARN of an IAM role that instances in the fleet can assume.
latefinal
isCustom → bool
Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool
Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool
Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool
Whether this instance represents a resource value returned over RPC.
finalinherited
logPaths ↔ Output<List<String>>
latefinal
metricGroups ↔ Output<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.
latefinal
name ↔ Output<String>
The name of the fleet.
latefinal
newGameSessionProtectionPolicy ↔ Output<String?>
Game session protection policy to apply to all instances in this fleetE.g., FullProtection. Defaults to NoProtection.
latefinal
operatingSystem ↔ Output<String>
Operating system of the fleet's computing resources.
latefinal
region ↔ Output<String>
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
resourceCreationLimitPolicy ↔ Output<FleetResourceCreationLimitPolicy?>
Policy that limits the number of game sessions an individual player can create over a span of time for this fleet. See below.
latefinal
resourceTransforms → List<ResourceTransform>
Inherited/explicit async transforms.
no setterinherited
runtimeConfiguration ↔ Output<FleetRuntimeConfiguration?>
Instructions for launching server processes on each instance in the fleet. See below.
latefinal
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
scriptArn ↔ Output<String>
Script ARN.
latefinal
scriptId ↔ Output<String?>
ID of the GameLift Script to be deployed on the fleet. Conflicts with buildId.
latefinal
tags ↔ Output<Map<String, String>?>
Key-value map of resource tags. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
latefinal
tagsAll ↔ Output<Map<String, String>>
A map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
latefinal
transformations → List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
urn ↔ Output<String>
latefinalinherited

Methods

failId(Object error) → void
Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void
Completes all output properties with error.
inherited
failUrn(Object error) → void
Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?
Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String
Returns this resource's logical name.
inherited
getResourceType() → String
Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>
Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void
Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void
Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void
Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>
Serializes resource properties for RPC transmission.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {FleetState? state, CustomResourceOptions? options}) → Fleet
Gets an existing Fleet resource's state with the given name and id.