Class GameServerCluster
A game server cluster resource.
To get more information about GameServerCluster, see:
- API documentation
- How-to Guides
- Official Documentation
Inherited Members
Namespace: Pulumi.Gcp.GameServices
Assembly: Pulumi.Gcp.dll
Syntax
public class GameServerCluster : CustomResource
Constructors
View SourceGameServerCluster(String, GameServerClusterArgs, CustomResourceOptions)
Create a GameServerCluster resource with the given unique name, arguments, and options.
Declaration
public GameServerCluster(string name, GameServerClusterArgs args, CustomResourceOptions options = null)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | name | The unique name of the resource |
| GameServerClusterArgs | args | The arguments used to populate this resource's properties |
| CustomResourceOptions | options | A bag of options that control this resource's behavior |
Properties
View SourceClusterId
Required. The resource name of the game server cluster
Declaration
public Output<string> ClusterId { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.String> |
ConnectionInfo
Game server cluster connection information. This information is used to manage game server clusters. Structure is documented below.
Declaration
public Output<GameServerClusterConnectionInfo> ConnectionInfo { get; }
Property Value
| Type | Description |
|---|---|
| Output<GameServerClusterConnectionInfo> |
Description
Human readable description of the cluster.
Declaration
public Output<string> Description { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.String> |
Labels
The labels associated with this game server cluster. Each label is a key-value pair.
Declaration
public Output<ImmutableDictionary<string, string>> Labels { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.Collections.Immutable.ImmutableDictionary<System.String, System.String>> |
Location
Location of the Cluster.
Declaration
public Output<string> Location { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.String> |
Name
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'.
Declaration
public Output<string> Name { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.String> |
Project
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
Declaration
public Output<string> Project { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.String> |
RealmId
The realm id of the game server realm.
Declaration
public Output<string> RealmId { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.String> |
Methods
View SourceGet(String, Input<String>, GameServerClusterState, CustomResourceOptions)
Get an existing GameServerCluster resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
Declaration
public static GameServerCluster Get(string name, Input<string> id, GameServerClusterState state = null, CustomResourceOptions options = null)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | name | The unique name of the resulting resource. |
| Input<System.String> | id | The unique provider ID of the resource to lookup. |
| GameServerClusterState | state | Any extra arguments used during the lookup. |
| CustomResourceOptions | options | A bag of options that control this resource's behavior |
Returns
| Type | Description |
|---|---|
| GameServerCluster |