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, __props__=None, __name__=None, __opts__=None)

Provides a Gamelift Alias resource.

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.

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 = None

Alias ARN.

description = None

Description of the alias.

name = None

Name of the alias.

routing_strategy = 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

static get(resource_name, id, opts=None, arn=None, description=None, name=None, routing_strategy=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.

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, version=None, __props__=None, __name__=None, __opts__=None)

Provides an Gamelift Build resource.

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.

  • 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.

name = None

Name of the build

operating_system = None

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

storage_location = 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.

version = None

Version that is associated with this build.

static get(resource_name, id, opts=None, name=None, operating_system=None, storage_location=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.

  • 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.

  • 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, metric_groups=None, name=None, new_game_session_protection_policy=None, resource_creation_limit_policy=None, runtime_configuration=None, __props__=None, __name__=None, __opts__=None)

Provides a Gamelift Fleet resource.

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

  • 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.

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 = None

Fleet ARN.

build_id = None

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

description = None

Human-readable description of the fleet.

ec2_inbound_permissions = 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 = None

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

metric_groups = 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 = None

The name of the fleet.

new_game_session_protection_policy = None

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

operating_system = None

Operating system of the fleet’s computing resources.

resource_creation_limit_policy = 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 = 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.

static get(resource_name, id, opts=None, arn=None, build_id=None, description=None, ec2_inbound_permissions=None, ec2_instance_type=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)

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

  • 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.

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, timeout_in_seconds=None, __props__=None, __name__=None, __opts__=None)

Provides an Gamelift Game Session Queue resource.

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.

  • 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 = None

Game Session Queue ARN.

destinations = None

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

name = None

Name of the session queue.

player_latency_policies = 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.

timeout_in_seconds = 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, 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.

  • 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