Module gamelift

This page documents the language specification for the aws package. If you're looking for help working with the inputs, outputs, or functions of aws resources in a Pulumi program, please see the resource documentation for examples and API reference.

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-aws repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-aws repo.

Others

AliasArgs
AliasState
BuildArgs
BuildState
FleetArgs
FleetState
GameSessionQueueArgs
GameSessionQueueState

Resources

Resource Alias

class Alias extends CustomResource

Provides a Gamelift Alias resource.

Example Usage

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

const example = new aws.gamelift.Alias("example", {
    description: "Example Description",
    routingStrategy: {
        message: "Example Message",
        type: "TERMINAL",
    },
});

constructor

new Alias(name: string, args: AliasArgs, opts?: pulumi.CustomResourceOptions)

Create a Alias resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: AliasState, opts?: pulumi.CustomResourceOptions): Alias

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Alias

Returns true if the given object is an instance of Alias. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property arn

public arn: pulumi.Output<string>;

Alias ARN.

property description

public description: pulumi.Output<string | undefined>;

Description of the alias.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

Name of the alias.

property routingStrategy

public routingStrategy: pulumi.Output<AliasRoutingStrategy>;

Specifies the fleet and/or routing type to use for the alias.

property tags

public tags: pulumi.Output<{[key: string]: any} | undefined>;

Key-value map of resource tags

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource Build

class Build extends CustomResource

Provides an Gamelift Build resource.

Example Usage

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

const test = new aws.gamelift.Build("test", {
    operatingSystem: "WINDOWS_2012",
    storage_location: {
        bucket: aws_s3_bucket.test.bucket,
        key: aws_s3_bucket_object.test.key,
        roleArn: aws_iam_role.test.arn,
    },
});

constructor

new Build(name: string, args: BuildArgs, opts?: pulumi.CustomResourceOptions)

Create a Build resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: BuildState, opts?: pulumi.CustomResourceOptions): Build

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Build

Returns true if the given object is an instance of Build. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property arn

public arn: pulumi.Output<string>;

Gamelift Build ARN.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

Name of the build

property operatingSystem

public operatingSystem: pulumi.Output<string>;

Operating system that the game server binaries are built to run on. e.g. WINDOWS_2012 or AMAZON_LINUX.

property storageLocation

public storageLocation: pulumi.Output<BuildStorageLocation>;

Information indicating where your game build files are stored. See below.

property tags

public tags: pulumi.Output<{[key: string]: any} | undefined>;

Key-value map of resource tags

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property version

public version: pulumi.Output<string | undefined>;

Version that is associated with this build.

Resource Fleet

class Fleet extends CustomResource

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", {
    buildId: aws_gamelift_build_example.id,
    ec2InstanceType: "t2.micro",
    fleetType: "ON_DEMAND",
    runtimeConfiguration: {
        serverProcesses: [{
            concurrentExecutions: 1,
            launchPath: "C:\\game\\GomokuServer.exe",
        }],
    },
});

constructor

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

Create a Fleet resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

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

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Fleet

Returns true if the given object is an instance of Fleet. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property arn

public arn: pulumi.Output<string>;

Fleet ARN.

property buildId

public buildId: pulumi.Output<string>;

ID of the Gamelift Build to be deployed on the fleet.

property description

public description: pulumi.Output<string | undefined>;

Human-readable description of the fleet.

property ec2InboundPermissions

public ec2InboundPermissions: pulumi.Output<FleetEc2InboundPermission[] | undefined>;

Range of IP addresses and port settings that permit inbound traffic to access server processes running on the fleet. See below.

property ec2InstanceType

public ec2InstanceType: pulumi.Output<string>;

Name of an EC2 instance type. e.g. t2.micro

property fleetType

public fleetType: pulumi.Output<string | undefined>;

Type of fleet. This value must be ON_DEMAND or SPOT. Defaults to ON_DEMAND.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property instanceRoleArn

public instanceRoleArn: pulumi.Output<string | undefined>;

ARN of an IAM role that instances in the fleet can assume.

property logPaths

public logPaths: pulumi.Output<string[]>;

property metricGroups

public metricGroups: pulumi.Output<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.

property name

public name: pulumi.Output<string>;

The name of the fleet.

property newGameSessionProtectionPolicy

public newGameSessionProtectionPolicy: pulumi.Output<string | undefined>;

Game session protection policy to apply to all instances in this fleet. e.g. FullProtection. Defaults to NoProtection.

property operatingSystem

public operatingSystem: pulumi.Output<string>;

Operating system of the fleet’s computing resources.

property resourceCreationLimitPolicy

public resourceCreationLimitPolicy: pulumi.Output<FleetResourceCreationLimitPolicy | undefined>;

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

property runtimeConfiguration

public runtimeConfiguration: pulumi.Output<FleetRuntimeConfiguration | undefined>;

Instructions for launching server processes on each instance in the fleet. See below.

property tags

public tags: pulumi.Output<{[key: string]: any} | undefined>;

Key-value map of resource tags

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource GameSessionQueue

class GameSessionQueue extends CustomResource

Provides an Gamelift Game Session Queue resource.

Example Usage

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

const test = new aws.gamelift.GameSessionQueue("test", {
    destinations: [
        aws_gamelift_fleet_us_west_2_fleet.arn,
        aws_gamelift_fleet_eu_central_1_fleet.arn,
    ],
    playerLatencyPolicies: [
        {
            maximumIndividualPlayerLatencyMilliseconds: 100,
            policyDurationSeconds: 5,
        },
        {
            maximumIndividualPlayerLatencyMilliseconds: 200,
        },
    ],
    timeoutInSeconds: 60,
});

constructor

new GameSessionQueue(name: string, args?: GameSessionQueueArgs, opts?: pulumi.CustomResourceOptions)

Create a GameSessionQueue resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: GameSessionQueueState, opts?: pulumi.CustomResourceOptions): GameSessionQueue

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is GameSessionQueue

Returns true if the given object is an instance of GameSessionQueue. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property arn

public arn: pulumi.Output<string>;

Game Session Queue ARN.

property destinations

public destinations: pulumi.Output<string[] | undefined>;

List of fleet/alias ARNs used by session queue for placing game sessions.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

Name of the session queue.

property playerLatencyPolicies

public playerLatencyPolicies: pulumi.Output<GameSessionQueuePlayerLatencyPolicy[] | undefined>;

One or more policies used to choose fleet based on player latency. See below.

property tags

public tags: pulumi.Output<{[key: string]: any} | undefined>;

Key-value map of resource tags

property timeoutInSeconds

public timeoutInSeconds: pulumi.Output<number | undefined>;

Maximum time a game session request can remain in the queue.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Others

interface AliasArgs

interface AliasArgs

The set of arguments for constructing a Alias resource.

property description

description?: pulumi.Input<string>;

Description of the alias.

property name

name?: pulumi.Input<string>;

Name of the alias.

property routingStrategy

routingStrategy: pulumi.Input<AliasRoutingStrategy>;

Specifies the fleet and/or routing type to use for the alias.

property tags

tags?: pulumi.Input<{[key: string]: any}>;

Key-value map of resource tags

interface AliasState

interface AliasState

Input properties used for looking up and filtering Alias resources.

property arn

arn?: pulumi.Input<string>;

Alias ARN.

property description

description?: pulumi.Input<string>;

Description of the alias.

property name

name?: pulumi.Input<string>;

Name of the alias.

property routingStrategy

routingStrategy?: pulumi.Input<AliasRoutingStrategy>;

Specifies the fleet and/or routing type to use for the alias.

property tags

tags?: pulumi.Input<{[key: string]: any}>;

Key-value map of resource tags

interface BuildArgs

interface BuildArgs

The set of arguments for constructing a Build resource.

property name

name?: pulumi.Input<string>;

Name of the build

property operatingSystem

operatingSystem: pulumi.Input<string>;

Operating system that the game server binaries are built to run on. e.g. WINDOWS_2012 or AMAZON_LINUX.

property storageLocation

storageLocation: pulumi.Input<BuildStorageLocation>;

Information indicating where your game build files are stored. See below.

property tags

tags?: pulumi.Input<{[key: string]: any}>;

Key-value map of resource tags

property version

version?: pulumi.Input<string>;

Version that is associated with this build.

interface BuildState

interface BuildState

Input properties used for looking up and filtering Build resources.

property arn

arn?: pulumi.Input<string>;

Gamelift Build ARN.

property name

name?: pulumi.Input<string>;

Name of the build

property operatingSystem

operatingSystem?: pulumi.Input<string>;

Operating system that the game server binaries are built to run on. e.g. WINDOWS_2012 or AMAZON_LINUX.

property storageLocation

storageLocation?: pulumi.Input<BuildStorageLocation>;

Information indicating where your game build files are stored. See below.

property tags

tags?: pulumi.Input<{[key: string]: any}>;

Key-value map of resource tags

property version

version?: pulumi.Input<string>;

Version that is associated with this build.

interface FleetArgs

interface FleetArgs

The set of arguments for constructing a Fleet resource.

property buildId

buildId: pulumi.Input<string>;

ID of the Gamelift Build to be deployed on the fleet.

property description

description?: pulumi.Input<string>;

Human-readable description of the fleet.

property ec2InboundPermissions

ec2InboundPermissions?: pulumi.Input<pulumi.Input<FleetEc2InboundPermission>[]>;

Range of IP addresses and port settings that permit inbound traffic to access server processes running on the fleet. See below.

property ec2InstanceType

ec2InstanceType: pulumi.Input<string>;

Name of an EC2 instance type. e.g. t2.micro

property fleetType

fleetType?: pulumi.Input<string>;

Type of fleet. This value must be ON_DEMAND or SPOT. Defaults to ON_DEMAND.

property instanceRoleArn

instanceRoleArn?: pulumi.Input<string>;

ARN of an IAM role that instances in the fleet can assume.

property metricGroups

metricGroups?: pulumi.Input<pulumi.Input<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.

property name

name?: pulumi.Input<string>;

The name of the fleet.

property newGameSessionProtectionPolicy

newGameSessionProtectionPolicy?: pulumi.Input<string>;

Game session protection policy to apply to all instances in this fleet. e.g. FullProtection. Defaults to NoProtection.

property resourceCreationLimitPolicy

resourceCreationLimitPolicy?: pulumi.Input<FleetResourceCreationLimitPolicy>;

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

property runtimeConfiguration

runtimeConfiguration?: pulumi.Input<FleetRuntimeConfiguration>;

Instructions for launching server processes on each instance in the fleet. See below.

property tags

tags?: pulumi.Input<{[key: string]: any}>;

Key-value map of resource tags

interface FleetState

interface FleetState

Input properties used for looking up and filtering Fleet resources.

property arn

arn?: pulumi.Input<string>;

Fleet ARN.

property buildId

buildId?: pulumi.Input<string>;

ID of the Gamelift Build to be deployed on the fleet.

property description

description?: pulumi.Input<string>;

Human-readable description of the fleet.

property ec2InboundPermissions

ec2InboundPermissions?: pulumi.Input<pulumi.Input<FleetEc2InboundPermission>[]>;

Range of IP addresses and port settings that permit inbound traffic to access server processes running on the fleet. See below.

property ec2InstanceType

ec2InstanceType?: pulumi.Input<string>;

Name of an EC2 instance type. e.g. t2.micro

property fleetType

fleetType?: pulumi.Input<string>;

Type of fleet. This value must be ON_DEMAND or SPOT. Defaults to ON_DEMAND.

property instanceRoleArn

instanceRoleArn?: pulumi.Input<string>;

ARN of an IAM role that instances in the fleet can assume.

property logPaths

logPaths?: pulumi.Input<pulumi.Input<string>[]>;

property metricGroups

metricGroups?: pulumi.Input<pulumi.Input<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.

property name

name?: pulumi.Input<string>;

The name of the fleet.

property newGameSessionProtectionPolicy

newGameSessionProtectionPolicy?: pulumi.Input<string>;

Game session protection policy to apply to all instances in this fleet. e.g. FullProtection. Defaults to NoProtection.

property operatingSystem

operatingSystem?: pulumi.Input<string>;

Operating system of the fleet’s computing resources.

property resourceCreationLimitPolicy

resourceCreationLimitPolicy?: pulumi.Input<FleetResourceCreationLimitPolicy>;

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

property runtimeConfiguration

runtimeConfiguration?: pulumi.Input<FleetRuntimeConfiguration>;

Instructions for launching server processes on each instance in the fleet. See below.

property tags

tags?: pulumi.Input<{[key: string]: any}>;

Key-value map of resource tags

interface GameSessionQueueArgs

interface GameSessionQueueArgs

The set of arguments for constructing a GameSessionQueue resource.

property destinations

destinations?: pulumi.Input<pulumi.Input<string>[]>;

List of fleet/alias ARNs used by session queue for placing game sessions.

property name

name?: pulumi.Input<string>;

Name of the session queue.

property playerLatencyPolicies

playerLatencyPolicies?: pulumi.Input<pulumi.Input<GameSessionQueuePlayerLatencyPolicy>[]>;

One or more policies used to choose fleet based on player latency. See below.

property tags

tags?: pulumi.Input<{[key: string]: any}>;

Key-value map of resource tags

property timeoutInSeconds

timeoutInSeconds?: pulumi.Input<number>;

Maximum time a game session request can remain in the queue.

interface GameSessionQueueState

interface GameSessionQueueState

Input properties used for looking up and filtering GameSessionQueue resources.

property arn

arn?: pulumi.Input<string>;

Game Session Queue ARN.

property destinations

destinations?: pulumi.Input<pulumi.Input<string>[]>;

List of fleet/alias ARNs used by session queue for placing game sessions.

property name

name?: pulumi.Input<string>;

Name of the session queue.

property playerLatencyPolicies

playerLatencyPolicies?: pulumi.Input<pulumi.Input<GameSessionQueuePlayerLatencyPolicy>[]>;

One or more policies used to choose fleet based on player latency. See below.

property tags

tags?: pulumi.Input<{[key: string]: any}>;

Key-value map of resource tags

property timeoutInSeconds

timeoutInSeconds?: pulumi.Input<number>;

Maximum time a game session request can remain in the queue.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

Module gamelift

Resources

Others

Resources

Example Usage

Example Usage

Example Usage

Example Usage

Others