GameServerCluster

A game server cluster resource.

To get more information about GameServerCluster, see:

API documentation
How-to Guides
- Official Documentation

Create a GameServerCluster Resource

new GameServerCluster(name: string, args: GameServerClusterArgs, opts?: CustomResourceOptions);

def GameServerCluster(resource_name, opts=None, cluster_id=None, connection_info=None, description=None, labels=None, location=None, project=None, realm_id=None, __props__=None);

func NewGameServerCluster(ctx *Context, name string, args GameServerClusterArgs, opts ...ResourceOption) (*GameServerCluster, error)

public GameServerCluster(string name, GameServerClusterArgs args, CustomResourceOptions? opts = null)

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

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

GameServerCluster Resource Properties

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

Inputs

The GameServerCluster resource accepts the following input properties:

ClusterId string: Required. The resource name of the game server cluster
ConnectionInfo GameServerClusterConnectionInfoArgs: Game server cluster connection information. This information is used to manage game server clusters. Structure is documented below.
RealmId string: The realm id of the game server realm.
Description string: Human readable description of the cluster.
Labels Dictionary<string, string>: The labels associated with this game server cluster. Each label is a key-value pair.
Location string: Location of the Cluster.
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

ClusterId string: Required. The resource name of the game server cluster
ConnectionInfo GameServerClusterConnectionInfo: Game server cluster connection information. This information is used to manage game server clusters. Structure is documented below.
RealmId string: The realm id of the game server realm.
Description string: Human readable description of the cluster.
Labels map[string]string: The labels associated with this game server cluster. Each label is a key-value pair.
Location string: Location of the Cluster.
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

clusterId string: Required. The resource name of the game server cluster
connectionInfo GameServerClusterConnectionInfo: Game server cluster connection information. This information is used to manage game server clusters. Structure is documented below.
realmId string: The realm id of the game server realm.
description string: Human readable description of the cluster.
labels {[key: string]: string}: The labels associated with this game server cluster. Each label is a key-value pair.
location string: Location of the Cluster.
project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

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

Outputs

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

Id string: The provider-assigned unique ID for this managed resource.
Name string: 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’.

Id string: The provider-assigned unique ID for this managed resource.
Name string: 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’.

id string: The provider-assigned unique ID for this managed resource.
name string: 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’.

id str: The provider-assigned unique ID for this managed resource.
name 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’.

Look up an Existing GameServerCluster Resource

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

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

func GetGameServerCluster(ctx *Context, name string, id IDInput, state *GameServerClusterState, opts ...ResourceOption) (*GameServerCluster, error)

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

ClusterId string: Required. The resource name of the game server cluster
ConnectionInfo GameServerClusterConnectionInfoArgs: Game server cluster connection information. This information is used to manage game server clusters. Structure is documented below.
Description string: Human readable description of the cluster.
Labels Dictionary<string, string>: The labels associated with this game server cluster. Each label is a key-value pair.
Location string: Location of the Cluster.
Name string: 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 string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
RealmId string: The realm id of the game server realm.

ClusterId string: Required. The resource name of the game server cluster
ConnectionInfo GameServerClusterConnectionInfo: Game server cluster connection information. This information is used to manage game server clusters. Structure is documented below.
Description string: Human readable description of the cluster.
Labels map[string]string: The labels associated with this game server cluster. Each label is a key-value pair.
Location string: Location of the Cluster.
Name string: 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 string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
RealmId string: The realm id of the game server realm.

clusterId string: Required. The resource name of the game server cluster
connectionInfo GameServerClusterConnectionInfo: Game server cluster connection information. This information is used to manage game server clusters. Structure is documented below.
description string: Human readable description of the cluster.
labels {[key: string]: string}: The labels associated with this game server cluster. Each label is a key-value pair.
location string: Location of the Cluster.
name string: 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 string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
realmId string: The realm id of the game server realm.

cluster_id str: Required. The resource name of the game server cluster
connection_info Dict[GameServerClusterConnectionInfo]: Game server cluster connection information. This information is used to manage game server clusters. Structure is documented below.
description str: Human readable description of the cluster.
labels Dict[str, str]: The labels associated with this game server cluster. Each label is a key-value pair.
location str: Location of the Cluster.
name 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 str: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
realm_id str: The realm id of the game server realm.

Supporting Types

GameServerClusterConnectionInfo

See the input and output API doc for this type.

GkeClusterReference GameServerClusterConnectionInfoGkeClusterReferenceArgs: Reference of the GKE cluster where the game servers are installed. Structure is documented below.
Namespace string: Namespace designated on the game server cluster where the game server instances will be created. The namespace existence will be validated during creation.

GkeClusterReference GameServerClusterConnectionInfoGkeClusterReference: Reference of the GKE cluster where the game servers are installed. Structure is documented below.
Namespace string: Namespace designated on the game server cluster where the game server instances will be created. The namespace existence will be validated during creation.

gkeClusterReference GameServerClusterConnectionInfoGkeClusterReference: Reference of the GKE cluster where the game servers are installed. Structure is documented below.
namespace string: Namespace designated on the game server cluster where the game server instances will be created. The namespace existence will be validated during creation.

gkeClusterReference Dict[GameServerClusterConnectionInfoGkeClusterReference]: Reference of the GKE cluster where the game servers are installed. Structure is documented below.
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.

GameServerClusterConnectionInfoGkeClusterReference

See the input and output API doc for this type.

Cluster string: 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.

Cluster string: 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.

cluster string: 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.

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.

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