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

gameservices¶

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-gcp repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-google repo.

class pulumi_gcp.gameservices.GameServerCluster(resource_name, opts=None, cluster_id=None, connection_info=None, description=None, labels=None, location=None, project=None, realm_id=None, __props__=None, __name__=None, __opts__=None)¶

A game server cluster resource.

To get more information about GameServerCluster, see:

API documentation
How-to Guides
- Official Documentation

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
cluster_id (pulumi.Input[str]) – Required. The resource name of the game server cluster
connection_info (pulumi.Input[dict]) – Game server cluster connection information. This information is used to manage game server clusters. Structure is documented below.
description (pulumi.Input[str]) – Human readable description of the cluster.
labels (pulumi.Input[dict]) – The labels associated with this game server cluster. Each label is a key-value pair.
location (pulumi.Input[str]) – Location of the Cluster.
project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
realm_id (pulumi.Input[str]) – The realm id of the game server realm.

The connection_info object supports the following:

gkeClusterReference (pulumi.Input[dict]) - Reference of the GKE cluster where the game servers are installed. Structure is documented below.
- cluster (pulumi.Input[str]) - The full or partial name of a GKE cluster, using one of the following forms:
  - projects/{project_id}/locations/{location}/clusters/{cluster_id}
  - locations/{location}/clusters/{cluster_id}
  - {cluster_id} If project and location are not specified, the project and location of the GameServerCluster resource are used to generate the full name of the GKE cluster.
namespace (pulumi.Input[str]) - Namespace designated on the game server cluster where the game server instances will be created. The namespace existence will be validated during creation.

cluster_id: pulumi.Output[str] = None¶: Required. The resource name of the game server cluster

connection_info: pulumi.Output[dict] = None¶

Game server cluster connection information. This information is used to manage game server clusters. Structure is documented below.

gkeClusterReference (dict) - Reference of the GKE cluster where the game servers are installed. Structure is documented below.
- cluster (str) - The full or partial name of a GKE cluster, using one of the following forms:
  - projects/{project_id}/locations/{location}/clusters/{cluster_id}
  - locations/{location}/clusters/{cluster_id}
  - {cluster_id} If project and location are not specified, the project and location of the GameServerCluster resource are used to generate the full name of the GKE cluster.
namespace (str) - Namespace designated on the game server cluster where the game server instances will be created. The namespace existence will be validated during creation.

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

labels: pulumi.Output[dict] = None¶: The labels associated with this game server cluster. Each label is a key-value pair.

location: pulumi.Output[str] = None¶: Location of the Cluster.

name: pulumi.Output[str] = None¶: The resource id of the game server cluster, eg: ‘projects/{project_id}/locations/{location}/realms/{realm_id}/gameServerClusters/{cluster_id}’. For example, ‘projects/my-project/locations/{location}/realms/zanzibar/gameServerClusters/my-onprem-cluster’.

project: pulumi.Output[str] = None¶: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

realm_id: pulumi.Output[str] = None¶: The realm id of the game server realm.

static get(resource_name, id, opts=None, cluster_id=None, connection_info=None, description=None, labels=None, location=None, name=None, project=None, realm_id=None)¶

Get an existing GameServerCluster 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.
cluster_id (pulumi.Input[str]) – Required. The resource name of the game server cluster
connection_info (pulumi.Input[dict]) – Game server cluster connection information. This information is used to manage game server clusters. Structure is documented below.
description (pulumi.Input[str]) – Human readable description of the cluster.
labels (pulumi.Input[dict]) – The labels associated with this game server cluster. Each label is a key-value pair.
location (pulumi.Input[str]) – Location of the Cluster.
name (pulumi.Input[str]) – The resource id of the game server cluster, eg: ‘projects/{project_id}/locations/{location}/realms/{realm_id}/gameServerClusters/{cluster_id}’. For example, ‘projects/my-project/locations/{location}/realms/zanzibar/gameServerClusters/my-onprem-cluster’.
project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
realm_id (pulumi.Input[str]) – The realm id of the game server realm.

The connection_info object supports the following:

gkeClusterReference (pulumi.Input[dict]) - Reference of the GKE cluster where the game servers are installed. Structure is documented below.
- cluster (pulumi.Input[str]) - The full or partial name of a GKE cluster, using one of the following forms:
  - projects/{project_id}/locations/{location}/clusters/{cluster_id}
  - locations/{location}/clusters/{cluster_id}
  - {cluster_id} If project and location are not specified, the project and location of the GameServerCluster resource are used to generate the full name of the GKE cluster.
namespace (pulumi.Input[str]) - Namespace designated on the game server cluster where the game server instances will be created. The namespace existence will be validated during creation.

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_gcp.gameservices.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, __name__=None, __opts__=None)¶

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

To get more information about GameServerConfig, see:

API documentation
How-to Guides
- Official Documentation

import pulumi
import json
import pulumi_gcp as gcp

default_game_server_deployment = gcp.gameservices.GameServerDeployment("defaultGameServerDeployment",
    deployment_id="tf-test-deployment",
    description="a deployment description")
default_game_server_config = gcp.gameservices.GameServerConfig("defaultGameServerConfig",
    config_id="tf-test-config",
    deployment_id=default_game_server_deployment.deployment_id,
    description="a config description",
    fleet_configs=[{
        "name": "something-unique",
        "fleetSpec": json.dumps({
            "replicas": 1,
            "scheduling": "Packed",
            "template": {
                "metadata": {
                    "name": "tf-test-game-server-template",
                },
                "spec": {
                    "template": {
                        "spec": {
                            "containers": [{
                                "name": "simple-udp-server",
                                "image": "gcr.io/agones-images/udp-server:0.14",
                            }],
                        },
                    },
                },
            },
        }),
    }],
    scaling_configs=[{
        "name": "scaling-config-name",
        "fleetAutoscalerSpec": json.dumps({
            "policy": {
                "type": "Webhook",
                "webhook": {
                    "service": {
                        "name": "autoscaler-webhook-service",
                        "namespace": "default",
                        "path": "scale",
                    },
                },
            },
        }),
        "selectors": [{
            "labels": {
                "one": "two",
            },
        }],
        "schedules": [{
            "cronJobDuration": "3.500s",
            "cronSpec": "0 0 * * 0",
        }],
    }])

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
config_id (pulumi.Input[str]) – A unique id for the deployment config.
deployment_id (pulumi.Input[str]) – A unique id for the deployment.
description (pulumi.Input[str]) – The description of the game server config.
fleet_configs (pulumi.Input[list]) – The fleet config contains list of fleet specs. In the Single Cloud, there will be only one. Structure is documented below.
labels (pulumi.Input[dict]) – Set of labels to group by.
location (pulumi.Input[str]) – Location of the Deployment.
project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
scaling_configs (pulumi.Input[list]) – Optional. This contains the autoscaling settings. Structure is documented below.

The fleet_configs object supports the following:

fleetSpec (pulumi.Input[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 (pulumi.Input[str]) - The name of the ScalingConfig

The scaling_configs object supports the following:

fleetAutoscalerSpec (pulumi.Input[str]) - Fleet autoscaler spec, which is sent to Agones. Example spec can be found : https://agones.dev/site/docs/reference/fleetautoscaler/
name (pulumi.Input[str]) - The name of the ScalingConfig
schedules (pulumi.Input[list]) - The schedules to which this scaling config applies. Structure is documented below.
- cronJobDuration (pulumi.Input[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 (pulumi.Input[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 (pulumi.Input[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 (pulumi.Input[str]) - The start time of the event. A timestamp in RFC3339 UTC “Zulu” format, accurate to nanoseconds. Example: “2014-10-02T15:01:23.045123456Z”.
selectors (pulumi.Input[list]) - 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.
- labels (pulumi.Input[dict]) - Set of labels to group by.

config_id: pulumi.Output[str] = None¶: A unique id for the deployment config.

deployment_id: pulumi.Output[str] = None¶: A unique id for the deployment.

description: pulumi.Output[str] = None¶: The description of the game server config.

fleet_configs: pulumi.Output[list] = None¶

The fleet config contains list of fleet specs. In the Single Cloud, there will be only one. Structure is documented below.

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

labels: pulumi.Output[dict] = None¶: Set of labels to group by.

location: pulumi.Output[str] = None¶: Location of the Deployment.

name: pulumi.Output[str] = None¶: The name of the ScalingConfig

project: pulumi.Output[str] = None¶: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

scaling_configs: pulumi.Output[list] = None¶

Optional. This contains the autoscaling settings. 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) - The schedules to which this scaling config applies. Structure is documented below.
- 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”.
selectors (list) - 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.
- labels (dict) - Set of labels to group by.

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

Get an existing GameServerConfig 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.
config_id (pulumi.Input[str]) – A unique id for the deployment config.
deployment_id (pulumi.Input[str]) – A unique id for the deployment.
description (pulumi.Input[str]) – The description of the game server config.
fleet_configs (pulumi.Input[list]) – The fleet config contains list of fleet specs. In the Single Cloud, there will be only one. Structure is documented below.
labels (pulumi.Input[dict]) – Set of labels to group by.
location (pulumi.Input[str]) – Location of the Deployment.
name (pulumi.Input[str]) – The name of the ScalingConfig
project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
scaling_configs (pulumi.Input[list]) – Optional. This contains the autoscaling settings. Structure is documented below.

The fleet_configs object supports the following:

fleetSpec (pulumi.Input[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 (pulumi.Input[str]) - The name of the ScalingConfig

The scaling_configs object supports the following:

fleetAutoscalerSpec (pulumi.Input[str]) - Fleet autoscaler spec, which is sent to Agones. Example spec can be found : https://agones.dev/site/docs/reference/fleetautoscaler/
name (pulumi.Input[str]) - The name of the ScalingConfig
schedules (pulumi.Input[list]) - The schedules to which this scaling config applies. Structure is documented below.
- cronJobDuration (pulumi.Input[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 (pulumi.Input[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 (pulumi.Input[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 (pulumi.Input[str]) - The start time of the event. A timestamp in RFC3339 UTC “Zulu” format, accurate to nanoseconds. Example: “2014-10-02T15:01:23.045123456Z”.
selectors (pulumi.Input[list]) - 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.
- labels (pulumi.Input[dict]) - Set of labels to group by.

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_gcp.gameservices.GameServerDeployment(resource_name, opts=None, deployment_id=None, description=None, labels=None, location=None, project=None, __props__=None, __name__=None, __opts__=None)¶

A game server deployment resource.

To get more information about GameServerDeployment, see:

API documentation
How-to Guides
- Official Documentation

import pulumi
import pulumi_gcp as gcp

default = gcp.gameservices.GameServerDeployment("default",
    deployment_id="tf-test-deployment",
    description="a deployment description")

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
deployment_id (pulumi.Input[str]) – A unique id for the deployment.
description (pulumi.Input[str]) – Human readable description of the game server deployment.
labels (pulumi.Input[dict]) – The labels associated with this game server deployment. Each label is a key-value pair.
location (pulumi.Input[str]) – Location of the Deployment.
project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

deployment_id: pulumi.Output[str] = None¶: A unique id for the deployment.

description: pulumi.Output[str] = None¶: Human readable description of the game server deployment.

labels: pulumi.Output[dict] = None¶: The labels associated with this game server deployment. Each label is a key-value pair.

location: pulumi.Output[str] = None¶: Location of the Deployment.

name: pulumi.Output[str] = None¶: The resource id of the game server deployment, eg: ‘projects/{project_id}/locations/{location}/gameServerDeployments/{deployment_id}’. For example, ‘projects/my-project/locations/{location}/gameServerDeployments/my-deployment’.

project: pulumi.Output[str] = None¶: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

static get(resource_name, id, opts=None, deployment_id=None, description=None, labels=None, location=None, name=None, project=None)¶

Get an existing GameServerDeployment 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.
deployment_id (pulumi.Input[str]) – A unique id for the deployment.
description (pulumi.Input[str]) – Human readable description of the game server deployment.
labels (pulumi.Input[dict]) – The labels associated with this game server deployment. Each label is a key-value pair.
location (pulumi.Input[str]) – Location of the Deployment.
name (pulumi.Input[str]) – The resource id of the game server deployment, eg: ‘projects/{project_id}/locations/{location}/gameServerDeployments/{deployment_id}’. For example, ‘projects/my-project/locations/{location}/gameServerDeployments/my-deployment’.
project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

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_gcp.gameservices.GameServerDeploymentRollout(resource_name, opts=None, default_game_server_config=None, deployment_id=None, game_server_config_overrides=None, project=None, __props__=None, __name__=None, __opts__=None)¶

This represents the rollout state. This is part of the game server deployment.

To get more information about GameServerDeploymentRollout, see:

API documentation
How-to Guides
- Official Documentation

import pulumi
import json
import pulumi_gcp as gcp

default_game_server_deployment = gcp.gameservices.GameServerDeployment("defaultGameServerDeployment",
    deployment_id="tf-test-deployment",
    description="a deployment description")
default_game_server_config = gcp.gameservices.GameServerConfig("defaultGameServerConfig",
    config_id="tf-test-config",
    deployment_id=default_game_server_deployment.deployment_id,
    description="a config description",
    fleet_configs=[{
        "name": "some-non-guid",
        "fleetSpec": json.dumps({
            "replicas": 1,
            "scheduling": "Packed",
            "template": {
                "metadata": {
                    "name": "tf-test-game-server-template",
                },
                "spec": {
                    "template": {
                        "spec": {
                            "containers": [{
                                "name": "simple-udp-server",
                                "image": "gcr.io/agones-images/udp-server:0.14",
                            }],
                        },
                    },
                },
            },
        }),
    }])
default_game_server_deployment_rollout = gcp.gameservices.GameServerDeploymentRollout("defaultGameServerDeploymentRollout",
    deployment_id=default_game_server_deployment.deployment_id,
    default_game_server_config=default_game_server_config.name)

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
default_game_server_config (pulumi.Input[str]) – This field points to the game server config that is applied by default to all realms and clusters. For example, projects/my-project/locations/global/gameServerDeployments/my-game/configs/my-config.
deployment_id (pulumi.Input[str]) – The deployment to rollout the new config to. Only 1 rollout must be associated with each deployment.
game_server_config_overrides (pulumi.Input[list]) – The game_server_config_overrides contains the per game server config overrides. The overrides are processed in the order they are listed. As soon as a match is found for a cluster, the rest of the list is not processed. Structure is documented below.
project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

The game_server_config_overrides object supports the following:

configVersion (pulumi.Input[str]) - Version of the configuration.
realmsSelector (pulumi.Input[dict]) - Selection by realms. Structure is documented below.
- realms (pulumi.Input[list]) - List of realms to match against.

default_game_server_config: pulumi.Output[str] = None¶: This field points to the game server config that is applied by default to all realms and clusters. For example, projects/my-project/locations/global/gameServerDeployments/my-game/configs/my-config.

deployment_id: pulumi.Output[str] = None¶: The deployment to rollout the new config to. Only 1 rollout must be associated with each deployment.

game_server_config_overrides: pulumi.Output[list] = None¶

The game_server_config_overrides contains the per game server config overrides. The overrides are processed in the order they are listed. As soon as a match is found for a cluster, the rest of the list is not processed. Structure is documented below.

configVersion (str) - Version of the configuration.
realmsSelector (dict) - Selection by realms. Structure is documented below.
- realms (list) - List of realms to match against.

name: pulumi.Output[str] = None¶: The resource id of the game server deployment eg: ‘projects/my-project/locations/global/gameServerDeployments/my-deployment/rollout’.

project: pulumi.Output[str] = None¶: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

static get(resource_name, id, opts=None, default_game_server_config=None, deployment_id=None, game_server_config_overrides=None, name=None, project=None)¶

Get an existing GameServerDeploymentRollout 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.
default_game_server_config (pulumi.Input[str]) – This field points to the game server config that is applied by default to all realms and clusters. For example, projects/my-project/locations/global/gameServerDeployments/my-game/configs/my-config.
deployment_id (pulumi.Input[str]) – The deployment to rollout the new config to. Only 1 rollout must be associated with each deployment.
game_server_config_overrides (pulumi.Input[list]) – The game_server_config_overrides contains the per game server config overrides. The overrides are processed in the order they are listed. As soon as a match is found for a cluster, the rest of the list is not processed. Structure is documented below.
name (pulumi.Input[str]) – The resource id of the game server deployment eg: ‘projects/my-project/locations/global/gameServerDeployments/my-deployment/rollout’.
project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

The game_server_config_overrides object supports the following:

configVersion (pulumi.Input[str]) - Version of the configuration.
realmsSelector (pulumi.Input[dict]) - Selection by realms. Structure is documented below.
- realms (pulumi.Input[list]) - List of realms to match against.

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_gcp.gameservices.Realm(resource_name, opts=None, description=None, labels=None, location=None, project=None, realm_id=None, time_zone=None, __props__=None, __name__=None, __opts__=None)¶

A Realm resource.

To get more information about Realm, see:

API documentation
How-to Guides
- Official Documentation

import pulumi
import pulumi_gcp as gcp

default = gcp.gameservices.Realm("default",
    realm_id="tf-test-realm",
    time_zone="EST",
    location="global",
    description="one of the nine")

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
description (pulumi.Input[str]) – Human readable description of the realm.
labels (pulumi.Input[dict]) – The labels associated with this realm. Each label is a key-value pair.
location (pulumi.Input[str]) – Location of the Realm.
project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
realm_id (pulumi.Input[str]) – GCP region of the Realm.
time_zone (pulumi.Input[str]) – Required. Time zone where all realm-specific policies are evaluated. The value of this field must be from the IANA time zone database: https://www.iana.org/time-zones.

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

etag: pulumi.Output[str] = None¶: ETag of the resource.

labels: pulumi.Output[dict] = None¶: The labels associated with this realm. Each label is a key-value pair.

location: pulumi.Output[str] = None¶: Location of the Realm.

name: pulumi.Output[str] = None¶: The resource id of the realm, of the form: ‘projects/{project_id}/locations/{location}/realms/{realm_id}’. For example, ‘projects/my-project/locations/{location}/realms/my-realm’.

project: pulumi.Output[str] = None¶: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

realm_id: pulumi.Output[str] = None¶: GCP region of the Realm.

time_zone: pulumi.Output[str] = None¶: Required. Time zone where all realm-specific policies are evaluated. The value of this field must be from the IANA time zone database: https://www.iana.org/time-zones.

static get(resource_name, id, opts=None, description=None, etag=None, labels=None, location=None, name=None, project=None, realm_id=None, time_zone=None)¶

Get an existing Realm 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.
description (pulumi.Input[str]) – Human readable description of the realm.
etag (pulumi.Input[str]) – ETag of the resource.
labels (pulumi.Input[dict]) – The labels associated with this realm. Each label is a key-value pair.
location (pulumi.Input[str]) – Location of the Realm.
name (pulumi.Input[str]) – The resource id of the realm, of the form: ‘projects/{project_id}/locations/{location}/realms/{realm_id}’. For example, ‘projects/my-project/locations/{location}/realms/my-realm’.
project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
realm_id (pulumi.Input[str]) – GCP region of the Realm.
time_zone (pulumi.Input[str]) – Required. Time zone where all realm-specific policies are evaluated. The value of this field must be from the IANA time zone database: https://www.iana.org/time-zones.

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

gameservices¶

On This Page