Class Realm
A Realm resource.
To get more information about Realm, see:
- API documentation
- How-to Guides
- Official Documentation
Example Usage - Game Service Realm Basic
using Pulumi;
using Gcp = Pulumi.Gcp;
class MyStack : Stack
{
public MyStack()
{
var @default = new Gcp.GameServices.Realm("default", new Gcp.GameServices.RealmArgs
{
RealmId = "tf-test-realm",
TimeZone = "EST",
Location = "global",
Description = "one of the nine",
});
}
}
Inherited Members
Namespace: Pulumi.Gcp.GameServices
Assembly: Pulumi.Gcp.dll
Syntax
public class Realm : CustomResource
Constructors
View SourceRealm(String, RealmArgs, CustomResourceOptions)
Create a Realm resource with the given unique name, arguments, and options.
Declaration
public Realm(string name, RealmArgs args, CustomResourceOptions options = null)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | name | The unique name of the resource |
| RealmArgs | args | The arguments used to populate this resource's properties |
| CustomResourceOptions | options | A bag of options that control this resource's behavior |
Properties
View SourceDescription
Human readable description of the realm.
Declaration
public Output<string> Description { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.String> |
Etag
ETag of the resource.
Declaration
public Output<string> Etag { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.String> |
Labels
The labels associated with this realm. 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 Realm.
Declaration
public Output<string> Location { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.String> |
Name
The resource id of the realm, of the form: 'projects/{project_id}/locations/{location}/realms/{realm_id}'. For example, 'projects/my-project/locations/{location}/realms/my-realm'.
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
GCP region of the Realm.
Declaration
public Output<string> RealmId { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.String> |
TimeZone
Required. Time zone where all realm-specific policies are evaluated. The value of this field must be from the IANA time zone database: https://www.iana.org/time-zones.
Declaration
public Output<string> TimeZone { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.String> |
Methods
View SourceGet(String, Input<String>, RealmState, CustomResourceOptions)
Get an existing Realm resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
Declaration
public static Realm Get(string name, Input<string> id, RealmState 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. |
| RealmState | state | Any extra arguments used during the lookup. |
| CustomResourceOptions | options | A bag of options that control this resource's behavior |
Returns
| Type | Description |
|---|---|
| Realm |