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.

gamelift¶

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.

class pulumi_aws.gamelift.Alias(resource_name, opts=None, description=None, name=None, routing_strategy=None, tags=None, __props__=None, __name__=None, __opts__=None)¶

Provides a Gamelift Alias resource.

import pulumi
import pulumi_aws as aws

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

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
description (pulumi.Input[str]) – Description of the alias.
name (pulumi.Input[str]) – Name of the alias.
routing_strategy (pulumi.Input[dict]) – Specifies the fleet and/or routing type to use for the alias.
tags (pulumi.Input[dict]) – Key-value map of resource tags

The routing_strategy object supports the following:

fleetId (pulumi.Input[str]) - ID of the Gamelift Fleet to point the alias to.
message (pulumi.Input[str]) - Message text to be used with the TERMINAL routing strategy.
type (pulumi.Input[str]) - Type of routing strategy. e.g. SIMPLE or TERMINAL

arn: pulumi.Output[str] = None¶: Alias ARN.

description: pulumi.Output[str] = None¶: Description of the alias.

name: pulumi.Output[str] = None¶: Name of the alias.

routing_strategy: pulumi.Output[dict] = None¶

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

fleetId (str) - ID of the Gamelift Fleet to point the alias to.
message (str) - Message text to be used with the TERMINAL routing strategy.
type (str) - Type of routing strategy. e.g. SIMPLE or TERMINAL

tags: pulumi.Output[dict] = None¶: Key-value map of resource tags

static get(resource_name, id, opts=None, arn=None, description=None, name=None, routing_strategy=None, tags=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
arn (pulumi.Input[str]) – Alias ARN.
description (pulumi.Input[str]) – Description of the alias.
name (pulumi.Input[str]) – Name of the alias.
routing_strategy (pulumi.Input[dict]) – Specifies the fleet and/or routing type to use for the alias.
tags (pulumi.Input[dict]) – Key-value map of resource tags

The routing_strategy object supports the following:

fleetId (pulumi.Input[str]) - ID of the Gamelift Fleet to point the alias to.
message (pulumi.Input[str]) - Message text to be used with the TERMINAL routing strategy.
type (pulumi.Input[str]) - Type of routing strategy. e.g. SIMPLE or TERMINAL

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_aws.gamelift.Build(resource_name, opts=None, name=None, operating_system=None, storage_location=None, tags=None, version=None, __props__=None, __name__=None, __opts__=None)¶

Provides an Gamelift Build resource.

import pulumi
import pulumi_aws as aws

test = aws.gamelift.Build("test",
    operating_system="WINDOWS_2012",
    storage_location={
        "bucket": aws_s3_bucket["test"]["bucket"],
        "key": aws_s3_bucket_object["test"]["key"],
        "role_arn": aws_iam_role["test"]["arn"],
    })

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
name (pulumi.Input[str]) – Name of the build
operating_system (pulumi.Input[str]) – Operating system that the game server binaries are built to run on. e.g. WINDOWS_2012 or AMAZON_LINUX.
storage_location (pulumi.Input[dict]) – Information indicating where your game build files are stored. See below.
tags (pulumi.Input[dict]) – Key-value map of resource tags
version (pulumi.Input[str]) – Version that is associated with this build.

The storage_location object supports the following:

bucket (pulumi.Input[str]) - Name of your S3 bucket.
key (pulumi.Input[str]) - Name of the zip file containing your build files.
role_arn (pulumi.Input[str]) - ARN of the access role that allows Amazon GameLift to access your S3 bucket.

arn: pulumi.Output[str] = None¶: Gamelift Build ARN.

name: pulumi.Output[str] = None¶: Name of the build

operating_system: pulumi.Output[str] = None¶: Operating system that the game server binaries are built to run on. e.g. WINDOWS_2012 or AMAZON_LINUX.

storage_location: pulumi.Output[dict] = None¶

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

bucket (str) - Name of your S3 bucket.
key (str) - Name of the zip file containing your build files.
role_arn (str) - ARN of the access role that allows Amazon GameLift to access your S3 bucket.

tags: pulumi.Output[dict] = None¶: Key-value map of resource tags

version: pulumi.Output[str] = None¶: Version that is associated with this build.

static get(resource_name, id, opts=None, arn=None, name=None, operating_system=None, storage_location=None, tags=None, version=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
arn (pulumi.Input[str]) – Gamelift Build ARN.
name (pulumi.Input[str]) – Name of the build
operating_system (pulumi.Input[str]) – Operating system that the game server binaries are built to run on. e.g. WINDOWS_2012 or AMAZON_LINUX.
storage_location (pulumi.Input[dict]) – Information indicating where your game build files are stored. See below.
tags (pulumi.Input[dict]) – Key-value map of resource tags
version (pulumi.Input[str]) – Version that is associated with this build.

The storage_location object supports the following:

bucket (pulumi.Input[str]) - Name of your S3 bucket.
key (pulumi.Input[str]) - Name of the zip file containing your build files.
role_arn (pulumi.Input[str]) - ARN of the access role that allows Amazon GameLift to access your S3 bucket.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_aws.gamelift.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, __name__=None, __opts__=None)¶

Provides a Gamelift Fleet resource.

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={
        "serverProcess": [{
            "concurrentExecutions": 1,
            "launchPath": "C:\game\GomokuServer.exe",
        }],
    })

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
build_id (pulumi.Input[str]) – ID of the Gamelift Build to be deployed on the fleet.
description (pulumi.Input[str]) – Human-readable description of the fleet.
ec2_inbound_permissions (pulumi.Input[list]) – Range of IP addresses and port settings that permit inbound traffic to access server processes running on the fleet. See below.
ec2_instance_type (pulumi.Input[str]) – Name of an EC2 instance type. e.g. t2.micro
fleet_type (pulumi.Input[str]) – Type of fleet. This value must be ON_DEMAND or SPOT. Defaults to ON_DEMAND.
instance_role_arn (pulumi.Input[str]) – ARN of an IAM role that instances in the fleet can assume.
metric_groups (pulumi.Input[list]) – 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 (pulumi.Input[str]) – The name of the fleet.
new_game_session_protection_policy (pulumi.Input[str]) – Game session protection policy to apply to all instances in this fleet. e.g. FullProtection. Defaults to NoProtection.
resource_creation_limit_policy (pulumi.Input[dict]) – 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 (pulumi.Input[dict]) – Instructions for launching server processes on each instance in the fleet. See below.
tags (pulumi.Input[dict]) – Key-value map of resource tags

The ec2_inbound_permissions object supports the following:

from_port (pulumi.Input[float]) - Starting value for a range of allowed port numbers.
ipRange (pulumi.Input[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 (pulumi.Input[str]) - Network communication protocol used by the fleet. e.g. TCP or UDP
to_port (pulumi.Input[float]) - Ending value for a range of allowed port numbers. Port numbers are end-inclusive. This value must be higher than from_port.

The resource_creation_limit_policy object supports the following:

newGameSessionsPerCreator (pulumi.Input[float]) - Maximum number of game sessions that an individual can create during the policy period.
policyPeriodInMinutes (pulumi.Input[float]) - Time span used in evaluating the resource creation limit policy.

The runtime_configuration object supports the following:

gameSessionActivationTimeoutSeconds (pulumi.Input[float]) - Maximum amount of time (in seconds) that a game session can remain in status ACTIVATING.
maxConcurrentGameSessionActivations (pulumi.Input[float]) - Maximum number of game sessions with status ACTIVATING to allow on an instance simultaneously.
serverProcesses (pulumi.Input[list]) - Collection of server process configurations that describe which server processes to run on each instance in a fleet. See below.
- concurrentExecutions (pulumi.Input[float]) - Number of server processes using this configuration to run concurrently on an instance.
- launchPath (pulumi.Input[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 (pulumi.Input[str]) - Optional list of parameters to pass to the server executable on launch.

arn: pulumi.Output[str] = None¶: Fleet ARN.

build_id: pulumi.Output[str] = None¶: ID of the Gamelift Build to be deployed on the fleet.

description: pulumi.Output[str] = None¶: Human-readable description of the fleet.

ec2_inbound_permissions: pulumi.Output[list] = None¶

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

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.

ec2_instance_type: pulumi.Output[str] = None¶: Name of an EC2 instance type. e.g. t2.micro

fleet_type: pulumi.Output[str] = None¶: Type of fleet. This value must be ON_DEMAND or SPOT. Defaults to ON_DEMAND.

instance_role_arn: pulumi.Output[str] = None¶: ARN of an IAM role that instances in the fleet can assume.

metric_groups: pulumi.Output[list] = None¶: 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: pulumi.Output[str] = None¶: The name of the fleet.

new_game_session_protection_policy: pulumi.Output[str] = None¶: Game session protection policy to apply to all instances in this fleet. e.g. FullProtection. Defaults to NoProtection.

operating_system: pulumi.Output[str] = None¶: Operating system of the fleet’s computing resources.

resource_creation_limit_policy: pulumi.Output[dict] = None¶

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

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.

runtime_configuration: pulumi.Output[dict] = None¶

Instructions for launching server processes on each instance in the 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) - Collection of server process configurations that describe which server processes to run on each instance in a fleet. See below.
- 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.

tags: pulumi.Output[dict] = None¶: Key-value map of resource tags

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)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
arn (pulumi.Input[str]) – Fleet ARN.
build_id (pulumi.Input[str]) – ID of the Gamelift Build to be deployed on the fleet.
description (pulumi.Input[str]) – Human-readable description of the fleet.
ec2_inbound_permissions (pulumi.Input[list]) – Range of IP addresses and port settings that permit inbound traffic to access server processes running on the fleet. See below.
ec2_instance_type (pulumi.Input[str]) – Name of an EC2 instance type. e.g. t2.micro
fleet_type (pulumi.Input[str]) – Type of fleet. This value must be ON_DEMAND or SPOT. Defaults to ON_DEMAND.
instance_role_arn (pulumi.Input[str]) – ARN of an IAM role that instances in the fleet can assume.
metric_groups (pulumi.Input[list]) – 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 (pulumi.Input[str]) – The name of the fleet.
new_game_session_protection_policy (pulumi.Input[str]) – Game session protection policy to apply to all instances in this fleet. e.g. FullProtection. Defaults to NoProtection.
operating_system (pulumi.Input[str]) – Operating system of the fleet’s computing resources.
resource_creation_limit_policy (pulumi.Input[dict]) – 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 (pulumi.Input[dict]) – Instructions for launching server processes on each instance in the fleet. See below.
tags (pulumi.Input[dict]) – Key-value map of resource tags

The ec2_inbound_permissions object supports the following:

from_port (pulumi.Input[float]) - Starting value for a range of allowed port numbers.
ipRange (pulumi.Input[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 (pulumi.Input[str]) - Network communication protocol used by the fleet. e.g. TCP or UDP
to_port (pulumi.Input[float]) - Ending value for a range of allowed port numbers. Port numbers are end-inclusive. This value must be higher than from_port.

The resource_creation_limit_policy object supports the following:

newGameSessionsPerCreator (pulumi.Input[float]) - Maximum number of game sessions that an individual can create during the policy period.
policyPeriodInMinutes (pulumi.Input[float]) - Time span used in evaluating the resource creation limit policy.

The runtime_configuration object supports the following:

gameSessionActivationTimeoutSeconds (pulumi.Input[float]) - Maximum amount of time (in seconds) that a game session can remain in status ACTIVATING.
maxConcurrentGameSessionActivations (pulumi.Input[float]) - Maximum number of game sessions with status ACTIVATING to allow on an instance simultaneously.
serverProcesses (pulumi.Input[list]) - Collection of server process configurations that describe which server processes to run on each instance in a fleet. See below.
- concurrentExecutions (pulumi.Input[float]) - Number of server processes using this configuration to run concurrently on an instance.
- launchPath (pulumi.Input[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 (pulumi.Input[str]) - Optional list of parameters to pass to the server executable on launch.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_aws.gamelift.GameSessionQueue(resource_name, opts=None, destinations=None, name=None, player_latency_policies=None, tags=None, timeout_in_seconds=None, __props__=None, __name__=None, __opts__=None)¶

Provides an Gamelift Game Session Queue resource.

import pulumi
import pulumi_aws as aws

test = aws.gamelift.GameSessionQueue("test",
    destinations=[
        aws_gamelift_fleet["us_west_2_fleet"]["arn"],
        aws_gamelift_fleet["eu_central_1_fleet"]["arn"],
    ],
    player_latency_policies=[
        {
            "maximumIndividualPlayerLatencyMilliseconds": 100,
            "policyDurationSeconds": 5,
        },
        {
            "maximumIndividualPlayerLatencyMilliseconds": 200,
        },
    ],
    timeout_in_seconds=60)

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
destinations (pulumi.Input[list]) – List of fleet/alias ARNs used by session queue for placing game sessions.
name (pulumi.Input[str]) – Name of the session queue.
player_latency_policies (pulumi.Input[list]) – One or more policies used to choose fleet based on player latency. See below.
tags (pulumi.Input[dict]) – Key-value map of resource tags
timeout_in_seconds (pulumi.Input[float]) – Maximum time a game session request can remain in the queue.

The player_latency_policies object supports the following:

maximumIndividualPlayerLatencyMilliseconds (pulumi.Input[float]) - Maximum latency value that is allowed for any player.
policyDurationSeconds (pulumi.Input[float]) - Length of time that the policy is enforced while placing a new game session. Absence of value for this attribute means that the policy is enforced until the queue times out.

arn: pulumi.Output[str] = None¶: Game Session Queue ARN.

destinations: pulumi.Output[list] = None¶: List of fleet/alias ARNs used by session queue for placing game sessions.

name: pulumi.Output[str] = None¶: Name of the session queue.

player_latency_policies: pulumi.Output[list] = None¶

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

maximumIndividualPlayerLatencyMilliseconds (float) - Maximum latency value that is allowed for any player.
policyDurationSeconds (float) - Length of time that the policy is enforced while placing a new game session. Absence of value for this attribute means that the policy is enforced until the queue times out.

tags: pulumi.Output[dict] = None¶: Key-value map of resource tags

timeout_in_seconds: pulumi.Output[float] = None¶: Maximum time a game session request can remain in the queue.

static get(resource_name, id, opts=None, arn=None, destinations=None, name=None, player_latency_policies=None, tags=None, timeout_in_seconds=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
arn (pulumi.Input[str]) – Game Session Queue ARN.
destinations (pulumi.Input[list]) – List of fleet/alias ARNs used by session queue for placing game sessions.
name (pulumi.Input[str]) – Name of the session queue.
player_latency_policies (pulumi.Input[list]) – One or more policies used to choose fleet based on player latency. See below.
tags (pulumi.Input[dict]) – Key-value map of resource tags
timeout_in_seconds (pulumi.Input[float]) – Maximum time a game session request can remain in the queue.

The player_latency_policies object supports the following:

maximumIndividualPlayerLatencyMilliseconds (pulumi.Input[float]) - Maximum latency value that is allowed for any player.
policyDurationSeconds (pulumi.Input[float]) - Length of time that the policy is enforced while placing a new game session. Absence of value for this attribute means that the policy is enforced until the queue times out.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

gamelift¶

On This Page