1. Docs
  2. Reference
  3. API
  4. GCP
  5. gameservices
  6. Realm

Realm

A Realm resource.

To get more information about Realm, see:

Create a Realm Resource

new Realm(name: string, args: RealmArgs, opts?: CustomResourceOptions);
def Realm(resource_name, opts=None, description=None, labels=None, location=None, project=None, realm_id=None, time_zone=None, __props__=None);
func NewRealm(ctx *Context, name string, args RealmArgs, opts ...ResourceOption) (*Realm, error)
public Realm(string name, RealmArgs args, CustomResourceOptions? opts = null)
name string
The unique name of the resource.
args RealmArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
opts ResourceOptions
A bag of options that control this resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args RealmArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args RealmArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

Realm Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The Realm resource accepts the following input properties:

RealmId string

GCP region of the Realm.

TimeZone string

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.

Description string

Human readable description of the realm.

Labels Dictionary<string, string>

The labels associated with this realm. Each label is a key-value pair.

Location string

Location of the Realm.

Project string

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

RealmId string

GCP region of the Realm.

TimeZone string

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.

Description string

Human readable description of the realm.

Labels map[string]string

The labels associated with this realm. Each label is a key-value pair.

Location string

Location of the Realm.

Project string

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

realmId string

GCP region of the Realm.

timeZone string

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.

description string

Human readable description of the realm.

labels {[key: string]: string}

The labels associated with this realm. Each label is a key-value pair.

location string

Location of the Realm.

project string

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

realm_id str

GCP region of the Realm.

time_zone str

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.

description str

Human readable description of the realm.

labels Dict[str, str]

The labels associated with this realm. Each label is a key-value pair.

location str

Location of the Realm.

project str

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 Realm resource produces the following output properties:

Etag string

ETag of the resource.

Id string
The provider-assigned unique ID for this managed resource.
Name string

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

Etag string

ETag of the resource.

Id string
The provider-assigned unique ID for this managed resource.
Name string

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

etag string

ETag of the resource.

id string
The provider-assigned unique ID for this managed resource.
name string

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

etag str

ETag of the resource.

id str
The provider-assigned unique ID for this managed resource.
name str

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

Look up an Existing Realm Resource

Get an existing Realm 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?: RealmState, opts?: CustomResourceOptions): Realm
static get(resource_name, id, opts=None, description=None, etag=None, labels=None, location=None, name=None, project=None, realm_id=None, time_zone=None, __props__=None);
func GetRealm(ctx *Context, name string, id IDInput, state *RealmState, opts ...ResourceOption) (*Realm, error)
public static Realm Get(string name, Input<string> id, RealmState? state, CustomResourceOptions? opts = null)
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.

The following state arguments are supported:

Description string

Human readable description of the realm.

Etag string

ETag of the resource.

Labels Dictionary<string, string>

The labels associated with this realm. Each label is a key-value pair.

Location string

Location of the Realm.

Name string

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

Project string

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

RealmId string

GCP region of the Realm.

TimeZone string

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.

Description string

Human readable description of the realm.

Etag string

ETag of the resource.

Labels map[string]string

The labels associated with this realm. Each label is a key-value pair.

Location string

Location of the Realm.

Name string

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

Project string

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

RealmId string

GCP region of the Realm.

TimeZone string

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.

description string

Human readable description of the realm.

etag string

ETag of the resource.

labels {[key: string]: string}

The labels associated with this realm. Each label is a key-value pair.

location string

Location of the Realm.

name string

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

project string

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

realmId string

GCP region of the Realm.

timeZone string

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.

description str

Human readable description of the realm.

etag str

ETag of the resource.

labels Dict[str, str]

The labels associated with this realm. Each label is a key-value pair.

location str

Location of the Realm.

name str

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

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

GCP region of the Realm.

time_zone str

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.

Package Details

Repository
https://github.com/pulumi/pulumi-gcp
License
Apache-2.0
Notes
This Pulumi package is based on the google-beta Terraform Provider.