- NAME
-
- gcloud alpha kms keys set-rotation-schedule - update the rotation schedule for a key
- SYNOPSIS
-
-
gcloud alpha kms keys set-rotation-schedule(KEY:--keyring=KEYRING--location=LOCATION) [--next-rotation-time=NEXT_ROTATION_TIME] [--rotation-period=ROTATION_PERIOD] [GCLOUD_WIDE_FLAG …]
-
- DESCRIPTION
-
(ALPHA)Updates the rotation schedule for the given key. The schedule automatically creates a new primary version for the key according to the--next-rotation-timeand--rotation-periodflags.The flag
--next-rotation-timemust be in ISO or RFC3339 format, and--rotation-periodmust be in the form INTEGER[UNIT], where units can be one of seconds (s), minutes (m), hours (h) or days (d).Key rotations performed manually via
update-primary-versionand the versioncreatedo not affect the stored--next-rotation-time. - EXAMPLES
-
The following command sets a 30 day rotation period for the key named
frodowithin the keyringfellowshipand locationglobalstarting at the specified time:gcloud alpha kms keys set-rotation-schedule frodo --location=global --keyring=fellowship --rotation-period=30d --next-rotation-time=2017-10-12T12:34:56.1234Z - POSITIONAL ARGUMENTS
-
-
Key resource - The KMS key resource. 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
projectattribute:-
provide the argument
keyon the command line with a fully specified name; -
set the property
core/project.
This must be specified.
KEY-
ID of the key or fully qualified identifier for the key.
To set the
keyattribute:-
provide the argument
keyon the command line.
This positional argument must be specified if any of the other arguments in this group are specified.
-
provide the argument
--keyring=KEYRING-
The KMS keyring of the key.
To set the
keyringattribute:-
provide the argument
keyon the command line with a fully specified name; -
provide the argument
--keyringon the command line.
-
provide the argument
--location=LOCATION-
The Google Cloud location for the key.
To set the
locationattribute:-
provide the argument
keyon the command line with a fully specified name; -
provide the argument
--locationon the command line.
-
provide the argument
-
provide the argument
-
Key resource - The KMS key resource. 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.
- FLAGS
-
--next-rotation-time=NEXT_ROTATION_TIME- Next automatic rotation time of the key. See $ gcloud topic datetimes for information on time formats.
--rotation-period=ROTATION_PERIOD- Automatic rotation period of the key. See $ gcloud topic datetimes for information on duration formats.
- 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 helpfor details. - 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 kms keys set-rotation-schedulegcloud beta kms keys set-rotation-schedule
gcloud alpha kms keys set-rotation-schedule
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-05-07 UTC.