Docs Packages
  1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. gameservices
  5. GameServerCluster
Google Cloud Classic v6.66.0 published on Monday, Sep 18, 2023 by Pulumi
pulumi/pulumi-gcp

gcp.gameservices.GameServerCluster

Explore with Pulumi AI

gcp logo
Google Cloud Classic v6.66.0 published on Monday, Sep 18, 2023 by Pulumi
pulumi/pulumi-gcp

    A game server cluster resource.

    To get more information about GameServerCluster, see:

    Create GameServerCluster Resource

    new GameServerCluster(name: string, args: GameServerClusterArgs, opts?: CustomResourceOptions);
    @overload
def GameServerCluster(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      cluster_id: Optional[str] = None,
                      connection_info: Optional[GameServerClusterConnectionInfoArgs] = None,
                      description: Optional[str] = None,
                      labels: Optional[Mapping[str, str]] = None,
                      location: 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: gcp:gameservices: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:

    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 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 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 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 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 GameServerClusterConnectionInfoArgs

    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 Mapping[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.

    clusterId String

    Required. The resource name of the game server cluster

    connectionInfo Property Map

    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>

    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.

    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 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.

    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.

    Look up 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
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        cluster_id: Optional[str] = None,
        connection_info: Optional[GameServerClusterConnectionInfoArgs] = None,
        description: 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) -> GameServerCluster
    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)
    public static GameServerCluster get(String name, Output<String> id, GameServerClusterState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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.
    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 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 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 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 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 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 GameServerClusterConnectionInfoArgs

    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 Mapping[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.

    clusterId String

    Required. The resource name of the game server cluster

    connectionInfo Property Map

    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>

    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.

    Supporting Types

    GameServerClusterConnectionInfo, GameServerClusterConnectionInfoArgs

    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 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.

    gke_cluster_reference 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.

    gkeClusterReference Property Map

    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.

    GameServerClusterConnectionInfoGkeClusterReference, GameServerClusterConnectionInfoGkeClusterReferenceArgs

    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 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.
    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.

    Import

    GameServerCluster can be imported using any of these accepted formats

     $ pulumi import gcp:gameservices/gameServerCluster:GameServerCluster default projects/{{project}}/locations/{{location}}/realms/{{realm_id}}/gameServerClusters/{{cluster_id}}

     $ pulumi import gcp:gameservices/gameServerCluster:GameServerCluster default {{project}}/{{location}}/{{realm_id}}/{{cluster_id}}

     $ pulumi import gcp:gameservices/gameServerCluster:GameServerCluster default {{location}}/{{realm_id}}/{{cluster_id}}

    Package Details

    Repository
    Google Cloud (GCP) Classic pulumi/pulumi-gcp
    License
    Apache-2.0
    Notes

    This Pulumi package is based on the google-beta Terraform Provider.

    gcp logo
    Google Cloud Classic v6.66.0 published on Monday, Sep 18, 2023 by Pulumi
    pulumi/pulumi-gcp