Google Native

Pulumi Official
Package maintained by Pulumi
v0.20.0 published on Monday, Jun 6, 2022 by Pulumi

GameServerCluster

Creates a new game server cluster in a given project and location.

Create a GameServerCluster Resource

new GameServerCluster(name: string, args: GameServerClusterArgs, opts?: CustomResourceOptions);
@overload
def GameServerCluster(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      connection_info: Optional[GameServerClusterConnectionInfoArgs] = None,
                      description: Optional[str] = None,
                      etag: Optional[str] = None,
                      game_server_cluster_id: Optional[str] = None,
                      labels: Optional[Mapping[str, str]] = None,
                      location: Optional[str] = None,
                      name: Optional[str] = None,
                      project: Optional[str] = None,
                      realm_id: Optional[str] = None)
@overload
def GameServerCluster(resource_name: str,
                      args: GameServerClusterArgs,
                      opts: Optional[ResourceOptions] = None)
func NewGameServerCluster(ctx *Context, name string, args GameServerClusterArgs, opts ...ResourceOption) (*GameServerCluster, error)
public GameServerCluster(string name, GameServerClusterArgs args, CustomResourceOptions? opts = null)
public GameServerCluster(String name, GameServerClusterArgs args)
public GameServerCluster(String name, GameServerClusterArgs args, CustomResourceOptions options)
type: google-native:gameservices/v1beta:GameServerCluster
properties: # The arguments to resource properties.
options: # 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.
resource_name str
The unique name of the resource.
args GameServerClusterArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control 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.
name String
The unique name of the resource.
args GameServerClusterArgs
The arguments to resource properties.
options 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 Architecture and Concepts docs.

Inputs

The GameServerCluster resource accepts the following input properties:

GameServerClusterId string

Required. The ID of the game server cluster resource to create.

RealmId string
ConnectionInfo Pulumi.GoogleNative.GameServices.V1Beta.Inputs.GameServerClusterConnectionInfoArgs

The game server cluster connection information. This information is used to manage game server clusters.

Description string

Human readable description of the cluster.

Etag string

Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.

Labels Dictionary<string, string>

The labels associated with this game server cluster. Each label is a key-value pair.

Location string
Name string

The resource name of the game server cluster, in the following form: projects/{project}/locations/{locationId}/realms/{realmId}/gameServerClusters/{gameServerClusterId}. For example, projects/my-project/locations/global/realms/zanzibar/gameServerClusters/my-gke-cluster.

Project string
GameServerClusterId string

Required. The ID of the game server cluster resource to create.

RealmId string
ConnectionInfo GameServerClusterConnectionInfoArgs

The game server cluster connection information. This information is used to manage game server clusters.

Description string

Human readable description of the cluster.

Etag string

Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.

Labels map[string]string

The labels associated with this game server cluster. Each label is a key-value pair.

Location string
Name string

The resource name of the game server cluster, in the following form: projects/{project}/locations/{locationId}/realms/{realmId}/gameServerClusters/{gameServerClusterId}. For example, projects/my-project/locations/global/realms/zanzibar/gameServerClusters/my-gke-cluster.

Project string
gameServerClusterId String

Required. The ID of the game server cluster resource to create.

realmId String
connectionInfo GameServerClusterConnectionInfoArgs

The game server cluster connection information. This information is used to manage game server clusters.

description String

Human readable description of the cluster.

etag String

Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.

labels Map<String,String>

The labels associated with this game server cluster. Each label is a key-value pair.

location String
name String

The resource name of the game server cluster, in the following form: projects/{project}/locations/{locationId}/realms/{realmId}/gameServerClusters/{gameServerClusterId}. For example, projects/my-project/locations/global/realms/zanzibar/gameServerClusters/my-gke-cluster.

project String
gameServerClusterId string

Required. The ID of the game server cluster resource to create.

realmId string
connectionInfo GameServerClusterConnectionInfoArgs

The game server cluster connection information. This information is used to manage game server clusters.

description string

Human readable description of the cluster.

etag string

Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.

labels {[key: string]: string}

The labels associated with this game server cluster. Each label is a key-value pair.

location string
name string

The resource name of the game server cluster, in the following form: projects/{project}/locations/{locationId}/realms/{realmId}/gameServerClusters/{gameServerClusterId}. For example, projects/my-project/locations/global/realms/zanzibar/gameServerClusters/my-gke-cluster.

project string
game_server_cluster_id str

Required. The ID of the game server cluster resource to create.

realm_id str
connection_info GameServerClusterConnectionInfoArgs

The game server cluster connection information. This information is used to manage game server clusters.

description str

Human readable description of the cluster.

etag str

Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.

labels Mapping[str, str]

The labels associated with this game server cluster. Each label is a key-value pair.

location str
name str

The resource name of the game server cluster, in the following form: projects/{project}/locations/{locationId}/realms/{realmId}/gameServerClusters/{gameServerClusterId}. For example, projects/my-project/locations/global/realms/zanzibar/gameServerClusters/my-gke-cluster.

project str
gameServerClusterId String

Required. The ID of the game server cluster resource to create.

realmId String
connectionInfo Property Map

The game server cluster connection information. This information is used to manage game server clusters.

description String

Human readable description of the cluster.

etag String

Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.

labels Map<String>

The labels associated with this game server cluster. Each label is a key-value pair.

location String
name String

The resource name of the game server cluster, in the following form: projects/{project}/locations/{locationId}/realms/{realmId}/gameServerClusters/{gameServerClusterId}. For example, projects/my-project/locations/global/realms/zanzibar/gameServerClusters/my-gke-cluster.

project String

Outputs

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

ClusterState Pulumi.GoogleNative.GameServices.V1Beta.Outputs.KubernetesClusterStateResponse

The state of the Kubernetes cluster in preview. This will be available if view is set to FULL in the relevant list/get/preview request.

CreateTime string

The creation time.

Id string

The provider-assigned unique ID for this managed resource.

UpdateTime string

The last-modified time.

ClusterState KubernetesClusterStateResponse

The state of the Kubernetes cluster in preview. This will be available if view is set to FULL in the relevant list/get/preview request.

CreateTime string

The creation time.

Id string

The provider-assigned unique ID for this managed resource.

UpdateTime string

The last-modified time.

clusterState KubernetesClusterStateResponse

The state of the Kubernetes cluster in preview. This will be available if view is set to FULL in the relevant list/get/preview request.

createTime String

The creation time.

id String

The provider-assigned unique ID for this managed resource.

updateTime String

The last-modified time.

clusterState KubernetesClusterStateResponse

The state of the Kubernetes cluster in preview. This will be available if view is set to FULL in the relevant list/get/preview request.

createTime string

The creation time.

id string

The provider-assigned unique ID for this managed resource.

updateTime string

The last-modified time.

cluster_state KubernetesClusterStateResponse

The state of the Kubernetes cluster in preview. This will be available if view is set to FULL in the relevant list/get/preview request.

create_time str

The creation time.

id str

The provider-assigned unique ID for this managed resource.

update_time str

The last-modified time.

clusterState Property Map

The state of the Kubernetes cluster in preview. This will be available if view is set to FULL in the relevant list/get/preview request.

createTime String

The creation time.

id String

The provider-assigned unique ID for this managed resource.

updateTime String

The last-modified time.

Supporting Types

GameServerClusterConnectionInfo

GkeClusterReference Pulumi.GoogleNative.GameServices.V1Beta.Inputs.GkeClusterReference

Reference to the GKE cluster where the game servers are installed.

Namespace string

Namespace designated on the game server cluster where the Agones game server instances will be created. Existence of the namespace will be validated during creation.

GkeClusterReference GkeClusterReference

Reference to the GKE cluster where the game servers are installed.

Namespace string

Namespace designated on the game server cluster where the Agones game server instances will be created. Existence of the namespace will be validated during creation.

gkeClusterReference GkeClusterReference

Reference to the GKE cluster where the game servers are installed.

namespace String

Namespace designated on the game server cluster where the Agones game server instances will be created. Existence of the namespace will be validated during creation.

gkeClusterReference GkeClusterReference

Reference to the GKE cluster where the game servers are installed.

namespace string

Namespace designated on the game server cluster where the Agones game server instances will be created. Existence of the namespace will be validated during creation.

gke_cluster_reference GkeClusterReference

Reference to the GKE cluster where the game servers are installed.

namespace str

Namespace designated on the game server cluster where the Agones game server instances will be created. Existence of the namespace will be validated during creation.

gkeClusterReference Property Map

Reference to the GKE cluster where the game servers are installed.

namespace String

Namespace designated on the game server cluster where the Agones game server instances will be created. Existence of the namespace will be validated during creation.

GameServerClusterConnectionInfoResponse

GkeClusterReference Pulumi.GoogleNative.GameServices.V1Beta.Inputs.GkeClusterReferenceResponse

Reference to the GKE cluster where the game servers are installed.

Namespace string

Namespace designated on the game server cluster where the Agones game server instances will be created. Existence of the namespace will be validated during creation.

GkeClusterReference GkeClusterReferenceResponse

Reference to the GKE cluster where the game servers are installed.

Namespace string

Namespace designated on the game server cluster where the Agones game server instances will be created. Existence of the namespace will be validated during creation.

gkeClusterReference GkeClusterReferenceResponse

Reference to the GKE cluster where the game servers are installed.

namespace String

Namespace designated on the game server cluster where the Agones game server instances will be created. Existence of the namespace will be validated during creation.

gkeClusterReference GkeClusterReferenceResponse

Reference to the GKE cluster where the game servers are installed.

namespace string

Namespace designated on the game server cluster where the Agones game server instances will be created. Existence of the namespace will be validated during creation.

gke_cluster_reference GkeClusterReferenceResponse

Reference to the GKE cluster where the game servers are installed.

namespace str

Namespace designated on the game server cluster where the Agones game server instances will be created. Existence of the namespace will be validated during creation.

gkeClusterReference Property Map

Reference to the GKE cluster where the game servers are installed.

namespace String

Namespace designated on the game server cluster where the Agones game server instances will be created. Existence of the namespace will be validated during creation.

GkeClusterReference

Cluster string

The full or partial name of a GKE cluster, using one of the following forms: * projects/{project}/locations/{locationId}/clusters/{cluster} * locations/{locationId}/clusters/{cluster} * {cluster} 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}/locations/{locationId}/clusters/{cluster} * locations/{locationId}/clusters/{cluster} * {cluster} 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}/locations/{locationId}/clusters/{cluster} * locations/{locationId}/clusters/{cluster} * {cluster} 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}/locations/{locationId}/clusters/{cluster} * locations/{locationId}/clusters/{cluster} * {cluster} 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}/locations/{locationId}/clusters/{cluster} * locations/{locationId}/clusters/{cluster} * {cluster} 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}/locations/{locationId}/clusters/{cluster} * locations/{locationId}/clusters/{cluster} * {cluster} 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.

GkeClusterReferenceResponse

Cluster string

The full or partial name of a GKE cluster, using one of the following forms: * projects/{project}/locations/{locationId}/clusters/{cluster} * locations/{locationId}/clusters/{cluster} * {cluster} 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}/locations/{locationId}/clusters/{cluster} * locations/{locationId}/clusters/{cluster} * {cluster} 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}/locations/{locationId}/clusters/{cluster} * locations/{locationId}/clusters/{cluster} * {cluster} 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}/locations/{locationId}/clusters/{cluster} * locations/{locationId}/clusters/{cluster} * {cluster} 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}/locations/{locationId}/clusters/{cluster} * locations/{locationId}/clusters/{cluster} * {cluster} 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}/locations/{locationId}/clusters/{cluster} * locations/{locationId}/clusters/{cluster} * {cluster} 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.

KubernetesClusterStateResponse

AgonesVersionInstalled string

The version of Agones currently installed in the registered Kubernetes cluster.

AgonesVersionTargeted string

The version of Agones that is targeted to be installed in the cluster.

InstallationState string

The state for the installed versions of Agones/Kubernetes.

KubernetesVersionInstalled string

The version of Kubernetes that is currently used in the registered Kubernetes cluster (as detected by the Cloud Game Servers service).

Provider string

The cloud provider type reported by the first node's providerID in the list of nodes on the Kubernetes endpoint. On Kubernetes platforms that support zero-node clusters (like GKE-on-GCP), the provider type will be empty.

VersionInstalledErrorMessage string

The detailed error message for the installed versions of Agones/Kubernetes.

AgonesVersionInstalled string

The version of Agones currently installed in the registered Kubernetes cluster.

AgonesVersionTargeted string

The version of Agones that is targeted to be installed in the cluster.

InstallationState string

The state for the installed versions of Agones/Kubernetes.

KubernetesVersionInstalled string

The version of Kubernetes that is currently used in the registered Kubernetes cluster (as detected by the Cloud Game Servers service).

Provider string

The cloud provider type reported by the first node's providerID in the list of nodes on the Kubernetes endpoint. On Kubernetes platforms that support zero-node clusters (like GKE-on-GCP), the provider type will be empty.

VersionInstalledErrorMessage string

The detailed error message for the installed versions of Agones/Kubernetes.

agonesVersionInstalled String

The version of Agones currently installed in the registered Kubernetes cluster.

agonesVersionTargeted String

The version of Agones that is targeted to be installed in the cluster.

installationState String

The state for the installed versions of Agones/Kubernetes.

kubernetesVersionInstalled String

The version of Kubernetes that is currently used in the registered Kubernetes cluster (as detected by the Cloud Game Servers service).

provider String

The cloud provider type reported by the first node's providerID in the list of nodes on the Kubernetes endpoint. On Kubernetes platforms that support zero-node clusters (like GKE-on-GCP), the provider type will be empty.

versionInstalledErrorMessage String

The detailed error message for the installed versions of Agones/Kubernetes.

agonesVersionInstalled string

The version of Agones currently installed in the registered Kubernetes cluster.

agonesVersionTargeted string

The version of Agones that is targeted to be installed in the cluster.

installationState string

The state for the installed versions of Agones/Kubernetes.

kubernetesVersionInstalled string

The version of Kubernetes that is currently used in the registered Kubernetes cluster (as detected by the Cloud Game Servers service).

provider string

The cloud provider type reported by the first node's providerID in the list of nodes on the Kubernetes endpoint. On Kubernetes platforms that support zero-node clusters (like GKE-on-GCP), the provider type will be empty.

versionInstalledErrorMessage string

The detailed error message for the installed versions of Agones/Kubernetes.

agones_version_installed str

The version of Agones currently installed in the registered Kubernetes cluster.

agones_version_targeted str

The version of Agones that is targeted to be installed in the cluster.

installation_state str

The state for the installed versions of Agones/Kubernetes.

kubernetes_version_installed str

The version of Kubernetes that is currently used in the registered Kubernetes cluster (as detected by the Cloud Game Servers service).

provider str

The cloud provider type reported by the first node's providerID in the list of nodes on the Kubernetes endpoint. On Kubernetes platforms that support zero-node clusters (like GKE-on-GCP), the provider type will be empty.

version_installed_error_message str

The detailed error message for the installed versions of Agones/Kubernetes.

agonesVersionInstalled String

The version of Agones currently installed in the registered Kubernetes cluster.

agonesVersionTargeted String

The version of Agones that is targeted to be installed in the cluster.

installationState String

The state for the installed versions of Agones/Kubernetes.

kubernetesVersionInstalled String

The version of Kubernetes that is currently used in the registered Kubernetes cluster (as detected by the Cloud Game Servers service).

provider String

The cloud provider type reported by the first node's providerID in the list of nodes on the Kubernetes endpoint. On Kubernetes platforms that support zero-node clusters (like GKE-on-GCP), the provider type will be empty.

versionInstalledErrorMessage String

The detailed error message for the installed versions of Agones/Kubernetes.

Package Details

Repository
https://github.com/pulumi/pulumi-google-native
License
Apache-2.0