Google Native

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

getGameServerCluster

Gets details of a single game server cluster.

Using getGameServerCluster

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getGameServerCluster(args: GetGameServerClusterArgs, opts?: InvokeOptions): Promise<GetGameServerClusterResult>
function getGameServerClusterOutput(args: GetGameServerClusterOutputArgs, opts?: InvokeOptions): Output<GetGameServerClusterResult>
def get_game_server_cluster(game_server_cluster_id: Optional[str] = None,
                            location: Optional[str] = None,
                            project: Optional[str] = None,
                            realm_id: Optional[str] = None,
                            view: Optional[str] = None,
                            opts: Optional[InvokeOptions] = None) -> GetGameServerClusterResult
def get_game_server_cluster_output(game_server_cluster_id: Optional[pulumi.Input[str]] = None,
                            location: Optional[pulumi.Input[str]] = None,
                            project: Optional[pulumi.Input[str]] = None,
                            realm_id: Optional[pulumi.Input[str]] = None,
                            view: Optional[pulumi.Input[str]] = None,
                            opts: Optional[InvokeOptions] = None) -> Output[GetGameServerClusterResult]
func LookupGameServerCluster(ctx *Context, args *LookupGameServerClusterArgs, opts ...InvokeOption) (*LookupGameServerClusterResult, error)
func LookupGameServerClusterOutput(ctx *Context, args *LookupGameServerClusterOutputArgs, opts ...InvokeOption) LookupGameServerClusterResultOutput

> Note: This function is named LookupGameServerCluster in the Go SDK.

public static class GetGameServerCluster 
{
    public static Task<GetGameServerClusterResult> InvokeAsync(GetGameServerClusterArgs args, InvokeOptions? opts = null)
    public static Output<GetGameServerClusterResult> Invoke(GetGameServerClusterInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetGameServerClusterResult> getGameServerCluster(GetGameServerClusterArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
  Function: google-native:gameservices/v1:getGameServerCluster
  Arguments:
    # Arguments dictionary

The following arguments are supported:

GameServerClusterId string
Location string
RealmId string
Project string
View string
GameServerClusterId string
Location string
RealmId string
Project string
View string
gameServerClusterId String
location String
realmId String
project String
view String
gameServerClusterId string
location string
realmId string
project string
view string
gameServerClusterId String
location String
realmId String
project String
view String

getGameServerCluster Result

The following output properties are available:

ClusterState Pulumi.GoogleNative.GameServices.V1.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.

ConnectionInfo Pulumi.GoogleNative.GameServices.V1.Outputs.GameServerClusterConnectionInfoResponse

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

CreateTime string

The creation time.

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.

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.

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.

ConnectionInfo GameServerClusterConnectionInfoResponse

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

CreateTime string

The creation time.

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.

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.

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.

connectionInfo GameServerClusterConnectionInfoResponse

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

createTime String

The creation time.

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.

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.

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.

connectionInfo GameServerClusterConnectionInfoResponse

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

createTime string

The creation time.

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.

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.

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.

connection_info GameServerClusterConnectionInfoResponse

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

create_time str

The creation time.

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.

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.

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.

connectionInfo Property Map

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

createTime String

The creation time.

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.

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.

updateTime String

The last-modified time.

Supporting Types

GameServerClusterConnectionInfoResponse

GkeClusterReference Pulumi.GoogleNative.GameServices.V1.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.

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