GameServerConfig

A game server config resource. Configs are global and immutable.

To get more information about GameServerConfig, see:

API documentation
How-to Guides
- Official Documentation

Create a GameServerConfig Resource

new GameServerConfig(name: string, args: GameServerConfigArgs, opts?: CustomResourceOptions);

def GameServerConfig(resource_name, opts=None, config_id=None, deployment_id=None, description=None, fleet_configs=None, labels=None, location=None, project=None, scaling_configs=None, __props__=None);

func NewGameServerConfig(ctx *Context, name string, args GameServerConfigArgs, opts ...ResourceOption) (*GameServerConfig, error)

public GameServerConfig(string name, GameServerConfigArgs args, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args GameServerConfigArgs: 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 GameServerConfigArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

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

GameServerConfig Resource Properties

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

Inputs

The GameServerConfig resource accepts the following input properties:

ConfigId string: A unique id for the deployment config.
DeploymentId string: A unique id for the deployment.
FleetConfigs List<GameServerConfigFleetConfigArgs>: The fleet config contains list of fleet specs. In the Single Cloud, there will be only one. Structure is documented below.
Description string: The description of the game server config.
Labels Dictionary<string, string>: Set of labels to group by.
Location string: Location of the Deployment.
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
ScalingConfigs List<GameServerConfigScalingConfigArgs>: Optional. This contains the autoscaling settings. Structure is documented below.

ConfigId string: A unique id for the deployment config.
DeploymentId string: A unique id for the deployment.
FleetConfigs []GameServerConfigFleetConfig: The fleet config contains list of fleet specs. In the Single Cloud, there will be only one. Structure is documented below.
Description string: The description of the game server config.
Labels map[string]string: Set of labels to group by.
Location string: Location of the Deployment.
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
ScalingConfigs []GameServerConfigScalingConfig: Optional. This contains the autoscaling settings. Structure is documented below.

configId string: A unique id for the deployment config.
deploymentId string: A unique id for the deployment.
fleetConfigs GameServerConfigFleetConfig[]: The fleet config contains list of fleet specs. In the Single Cloud, there will be only one. Structure is documented below.
description string: The description of the game server config.
labels {[key: string]: string}: Set of labels to group by.
location string: Location of the Deployment.
project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
scalingConfigs GameServerConfigScalingConfig[]: Optional. This contains the autoscaling settings. Structure is documented below.

config_id str: A unique id for the deployment config.
deployment_id str: A unique id for the deployment.
fleet_configs List[GameServerConfigFleetConfig]: The fleet config contains list of fleet specs. In the Single Cloud, there will be only one. Structure is documented below.
description str: The description of the game server config.
labels Dict[str, str]: Set of labels to group by.
location str: Location of the Deployment.
project str: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
scaling_configs List[GameServerConfigScalingConfig]: Optional. This contains the autoscaling settings. Structure is documented below.

Outputs

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

Id string: The provider-assigned unique ID for this managed resource.
Name string: The name of the ScalingConfig

Id string: The provider-assigned unique ID for this managed resource.
Name string: The name of the ScalingConfig

id string: The provider-assigned unique ID for this managed resource.
name string: The name of the ScalingConfig

id str: The provider-assigned unique ID for this managed resource.
name str: The name of the ScalingConfig

Look up an Existing GameServerConfig Resource

Get an existing GameServerConfig 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?: GameServerConfigState, opts?: CustomResourceOptions): GameServerConfig

static get(resource_name, id, opts=None, config_id=None, deployment_id=None, description=None, fleet_configs=None, labels=None, location=None, name=None, project=None, scaling_configs=None, __props__=None);

func GetGameServerConfig(ctx *Context, name string, id IDInput, state *GameServerConfigState, opts ...ResourceOption) (*GameServerConfig, error)

public static GameServerConfig Get(string name, Input<string> id, GameServerConfigState? 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:

ConfigId string: A unique id for the deployment config.
DeploymentId string: A unique id for the deployment.
Description string: The description of the game server config.
FleetConfigs List<GameServerConfigFleetConfigArgs>: The fleet config contains list of fleet specs. In the Single Cloud, there will be only one. Structure is documented below.
Labels Dictionary<string, string>: Set of labels to group by.
Location string: Location of the Deployment.
Name string: The name of the ScalingConfig
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
ScalingConfigs List<GameServerConfigScalingConfigArgs>: Optional. This contains the autoscaling settings. Structure is documented below.

ConfigId string: A unique id for the deployment config.
DeploymentId string: A unique id for the deployment.
Description string: The description of the game server config.
FleetConfigs []GameServerConfigFleetConfig: The fleet config contains list of fleet specs. In the Single Cloud, there will be only one. Structure is documented below.
Labels map[string]string: Set of labels to group by.
Location string: Location of the Deployment.
Name string: The name of the ScalingConfig
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
ScalingConfigs []GameServerConfigScalingConfig: Optional. This contains the autoscaling settings. Structure is documented below.

configId string: A unique id for the deployment config.
deploymentId string: A unique id for the deployment.
description string: The description of the game server config.
fleetConfigs GameServerConfigFleetConfig[]: The fleet config contains list of fleet specs. In the Single Cloud, there will be only one. Structure is documented below.
labels {[key: string]: string}: Set of labels to group by.
location string: Location of the Deployment.
name string: The name of the ScalingConfig
project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
scalingConfigs GameServerConfigScalingConfig[]: Optional. This contains the autoscaling settings. Structure is documented below.

config_id str: A unique id for the deployment config.
deployment_id str: A unique id for the deployment.
description str: The description of the game server config.
fleet_configs List[GameServerConfigFleetConfig]: The fleet config contains list of fleet specs. In the Single Cloud, there will be only one. Structure is documented below.
labels Dict[str, str]: Set of labels to group by.
location str: Location of the Deployment.
name str: The name of the ScalingConfig
project str: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
scaling_configs List[GameServerConfigScalingConfig]: Optional. This contains the autoscaling settings. Structure is documented below.

Supporting Types

GameServerConfigFleetConfig

See the input and output API doc for this type.

FleetSpec string: The fleet spec, which is sent to Agones to configure fleet. The spec can be passed as inline json but it is recommended to use a file reference instead. File references can contain the json or yaml format of the fleet spec. Eg: * fleet_spec = jsonencode(yamldecode(file(“fleet_configs.yaml”))) * fleet_spec = file(“fleet_configs.json”) The format of the spec can be found : https://agones.dev/site/docs/reference/fleet/.
Name string: The name of the ScalingConfig

FleetSpec string: The fleet spec, which is sent to Agones to configure fleet. The spec can be passed as inline json but it is recommended to use a file reference instead. File references can contain the json or yaml format of the fleet spec. Eg: * fleet_spec = jsonencode(yamldecode(file(“fleet_configs.yaml”))) * fleet_spec = file(“fleet_configs.json”) The format of the spec can be found : https://agones.dev/site/docs/reference/fleet/.
Name string: The name of the ScalingConfig

fleetSpec string: The fleet spec, which is sent to Agones to configure fleet. The spec can be passed as inline json but it is recommended to use a file reference instead. File references can contain the json or yaml format of the fleet spec. Eg: * fleet_spec = jsonencode(yamldecode(file(“fleet_configs.yaml”))) * fleet_spec = file(“fleet_configs.json”) The format of the spec can be found : https://agones.dev/site/docs/reference/fleet/.
name string: The name of the ScalingConfig

fleetSpec str: The fleet spec, which is sent to Agones to configure fleet. The spec can be passed as inline json but it is recommended to use a file reference instead. File references can contain the json or yaml format of the fleet spec. Eg: * fleet_spec = jsonencode(yamldecode(file(“fleet_configs.yaml”))) * fleet_spec = file(“fleet_configs.json”) The format of the spec can be found : https://agones.dev/site/docs/reference/fleet/.
name str: The name of the ScalingConfig

GameServerConfigScalingConfig

See the input and output API doc for this type.

FleetAutoscalerSpec string: Fleet autoscaler spec, which is sent to Agones. Example spec can be found : https://agones.dev/site/docs/reference/fleetautoscaler/
Name string: The name of the ScalingConfig
Schedules List<GameServerConfigScalingConfigScheduleArgs>: The schedules to which this scaling config applies. Structure is documented below.
Selectors List<GameServerConfigScalingConfigSelectorArgs>: Labels used to identify the clusters to which this scaling config applies. A cluster is subject to this scaling config if its labels match any of the selector entries. Structure is documented below.

FleetAutoscalerSpec string: Fleet autoscaler spec, which is sent to Agones. Example spec can be found : https://agones.dev/site/docs/reference/fleetautoscaler/
Name string: The name of the ScalingConfig
Schedules []GameServerConfigScalingConfigSchedule: The schedules to which this scaling config applies. Structure is documented below.
Selectors []GameServerConfigScalingConfigSelector: Labels used to identify the clusters to which this scaling config applies. A cluster is subject to this scaling config if its labels match any of the selector entries. Structure is documented below.

fleetAutoscalerSpec string: Fleet autoscaler spec, which is sent to Agones. Example spec can be found : https://agones.dev/site/docs/reference/fleetautoscaler/
name string: The name of the ScalingConfig
schedules GameServerConfigScalingConfigSchedule[]: The schedules to which this scaling config applies. Structure is documented below.
selectors GameServerConfigScalingConfigSelector[]: Labels used to identify the clusters to which this scaling config applies. A cluster is subject to this scaling config if its labels match any of the selector entries. Structure is documented below.

fleetAutoscalerSpec str: Fleet autoscaler spec, which is sent to Agones. Example spec can be found : https://agones.dev/site/docs/reference/fleetautoscaler/
name str: The name of the ScalingConfig
schedules List[GameServerConfigScalingConfigSchedule]: The schedules to which this scaling config applies. Structure is documented below.
selectors List[GameServerConfigScalingConfigSelector]: Labels used to identify the clusters to which this scaling config applies. A cluster is subject to this scaling config if its labels match any of the selector entries. Structure is documented below.

GameServerConfigScalingConfigSchedule

See the input and output API doc for this type.

CronJobDuration string: The duration for the cron job event. The duration of the event is effective after the cron job’s start time. A duration in seconds with up to nine fractional digits, terminated by ’s’. Example: “3.5s”.
CronSpec string: The cron definition of the scheduled event. See https://en.wikipedia.org/wiki/Cron. Cron spec specifies the local time as defined by the realm.
EndTime string: The end time of the event. A timestamp in RFC3339 UTC “Zulu” format, accurate to nanoseconds. Example: “2014-10-02T15:01:23.045123456Z”.
StartTime string: The start time of the event. A timestamp in RFC3339 UTC “Zulu” format, accurate to nanoseconds. Example: “2014-10-02T15:01:23.045123456Z”.

CronJobDuration string: The duration for the cron job event. The duration of the event is effective after the cron job’s start time. A duration in seconds with up to nine fractional digits, terminated by ’s’. Example: “3.5s”.
CronSpec string: The cron definition of the scheduled event. See https://en.wikipedia.org/wiki/Cron. Cron spec specifies the local time as defined by the realm.
EndTime string: The end time of the event. A timestamp in RFC3339 UTC “Zulu” format, accurate to nanoseconds. Example: “2014-10-02T15:01:23.045123456Z”.
StartTime string: The start time of the event. A timestamp in RFC3339 UTC “Zulu” format, accurate to nanoseconds. Example: “2014-10-02T15:01:23.045123456Z”.

cronJobDuration string: The duration for the cron job event. The duration of the event is effective after the cron job’s start time. A duration in seconds with up to nine fractional digits, terminated by ’s’. Example: “3.5s”.
cronSpec string: The cron definition of the scheduled event. See https://en.wikipedia.org/wiki/Cron. Cron spec specifies the local time as defined by the realm.
endTime string: The end time of the event. A timestamp in RFC3339 UTC “Zulu” format, accurate to nanoseconds. Example: “2014-10-02T15:01:23.045123456Z”.
startTime string: The start time of the event. A timestamp in RFC3339 UTC “Zulu” format, accurate to nanoseconds. Example: “2014-10-02T15:01:23.045123456Z”.

cronJobDuration str: The duration for the cron job event. The duration of the event is effective after the cron job’s start time. A duration in seconds with up to nine fractional digits, terminated by ’s’. Example: “3.5s”.
cronSpec str: The cron definition of the scheduled event. See https://en.wikipedia.org/wiki/Cron. Cron spec specifies the local time as defined by the realm.
endTime str: The end time of the event. A timestamp in RFC3339 UTC “Zulu” format, accurate to nanoseconds. Example: “2014-10-02T15:01:23.045123456Z”.
startTime str: The start time of the event. A timestamp in RFC3339 UTC “Zulu” format, accurate to nanoseconds. Example: “2014-10-02T15:01:23.045123456Z”.

GameServerConfigScalingConfigSelector

See the input and output API doc for this type.

Labels Dictionary<string, string>: Set of labels to group by.

Labels map[string]string: Set of labels to group by.

labels {[key: string]: string}: Set of labels to group by.

labels Dict[str, str]: Set of labels to group by.

Package Details

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

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

GameServerConfig

Create a GameServerConfig Resource

GameServerConfig Resource Properties

Inputs

Outputs

Look up an Existing GameServerConfig Resource

Supporting Types

GameServerConfigFleetConfig

GameServerConfigScalingConfig

GameServerConfigScalingConfigSchedule

GameServerConfigScalingConfigSelector

Package Details

On This Page