NAME

gcloud alpha game servers realms update - update a Realm

SYNOPSIS

gcloud alpha game servers realms update (REALM : --location=LOCATION) --dry-run [--description=DESCRIPTION] [--preview-time=PREVIEW_TIME] [--time-zone=TIME_ZONE] [--update-labels=[KEY=VALUE,...]] [--clear-labels | --remove-labels=[KEY,...]] [GCLOUD_WIDE_FLAG ...]

DESCRIPTION

(ALPHA) Update a Cloud Game Server Realm.

EXAMPLES

To update Realm 'my-realm' in project 'my-project' and location in 'my-location' with a new time-zone run:

$ gcloud alpha game servers realms update my-realm \ --project=my-project --location=my-location --time-zone=EST \ --no-dry-run

To preview Realm update for 'my-realm' in project 'my-project' and location in 'my-location' with a new time-zone run:

$ gcloud alpha game servers realms update my-realm \ --project=my-project --location=my-location --time-zone=EST \ --dry-run

To update labels for Realm 'my-realm' in project 'my-project' and location in 'my-location' run:

$ gcloud alpha game servers realms update my-realm \ --project=my-project --location=my-location \ --update-labels="key1=val1" --no-dry-run

POSITIONAL ARGUMENTS

Realm resource - Cloud Game Server Realm to update. The arguments in this group

can be used to specify the attributes of this resource. (NOTE) Some attributes are not given arguments in this group but can be set in other ways. To set the project attribute:

—

provide the argument realm on the command line with a fully specified name;

—

set the property core/project;

—

provide the argument --project on the command line.

This must be specified.

REALM

ID of the realm or fully qualified identifier for the realm. To set the realm attribute:

• provide the argument realm on the command line.

This positional argument must be specified if any of the other arguments in this group are specified.

--location=LOCATION

Google Cloud location. To set the location attribute:

• provide the argument realm on the command line with a fully specified name;

• provide the argument --location on the command line;

• set the property game_services/location.

REQUIRED FLAGS

--dry-run

Validate the changes, but do not execute it.

OPTIONAL FLAGS

--description=DESCRIPTION

Description for the realm.

--preview-time=PREVIEW_TIME

This attribute is only relevant for preview (--dry-run). It is used to validate the state for a future time.

--time-zone=TIME_ZONE

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.

--update-labels=[KEY=VALUE,...]

List of label KEY=VALUE pairs to update. If a label exists, its value is modified. Otherwise, a new label is created.

Keys must start with a lowercase character and contain only hyphens (-), underscores (_), lowercase characters, and numbers. Values must contain only hyphens (-), underscores (_), lowercase characters, and numbers.

At most one of these can be specified:

--clear-labels

Remove all labels. If --update-labels is also specified then --clear-labels is applied first.

For example, to remove all labels:

$ gcloud alpha game servers realms update --clear-labels

To remove all existing labels and create two new labels, foo and baz:

$ gcloud alpha game servers realms update --clear-labels \ --update-labels foo=bar,baz=qux

--remove-labels=[KEY,...]

List of label keys to remove. If a label does not exist it is silently ignored. If --update-labels is also specified then --update-labels is applied first.

GCLOUD WIDE FLAGS

These flags are available to all commands: --access-token-file, --account, --billing-project, --configuration, --flags-file, --flatten, --format, --help, --impersonate-service-account, --log-http, --project, --quiet, --trace-token, --user-output-enabled, --verbosity.

Run $ gcloud help for details.

API REFERENCE

This command uses the gameservices/v1alpha API. The full documentation for this API can be found at: https://cloud.google.com/solutions/gaming/

NOTES

This command is currently in alpha and might change without notice. If this command fails with API permission errors despite specifying the correct project, you might be trying to access an API with an invitation-only early access allowlist. These variants are also available:

$ gcloud game servers realms update

$ gcloud beta game servers realms update