gcloud kms keys set-rotation-schedule

NAME
gcloud kms keys set-rotation-schedule - update the rotation schedule for a key
SYNOPSIS
gcloud kms keys set-rotation-schedule(KEY :--keyring=KEYRING--location=LOCATION)[--next-rotation-time=NEXT_ROTATION_TIME][--rotation-period=ROTATION_PERIOD][GCLOUD_WIDE_FLAG …]
DESCRIPTION
Updates the rotation schedule for the given key. The schedule automaticallycreates a new primary version for the key according to the--next-rotation-time and--rotation-period flags.

The flag--next-rotation-time must be in ISO or RFC3339 format, and--rotation-period must be in the form INTEGER[UNIT], where unitscan be one of seconds (s), minutes (m), hours (h) or days (d).

Key rotations performed manually viaupdate-primary-version and theversioncreate do not affect the stored--next-rotation-time.

EXAMPLES
The following command sets a 30 day rotation period for the key namedfrodo within the keyringfellowship and locationglobal starting at the specified time:
gcloudkmskeysset-rotation-schedulefrodo--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 tospecify the attributes of this resource. (NOTE) Some attributes are not givenarguments in this group but can be set in other ways.

To set theproject attribute:

  • provide the argumentkey on the command line with a fully specifiedname;
  • set the propertycore/project.

This must be specified.

KEY
ID of the key or fully qualified identifier for the key.

To set thekey attribute:

  • provide the argumentkey on the command line.

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

--keyring=KEYRING
The KMS keyring of the key.

To set thekeyring attribute:

  • provide the argumentkey on the command line with a fully specifiedname;
  • provide the argument--keyring on the command line.
--location=LOCATION
The Google Cloud location for the key.

To set thelocation attribute:

  • provide the argumentkey on the command line with a fully specifiedname;
  • provide the argument--location on the command line.
FLAGS
--next-rotation-time=NEXT_ROTATION_TIME
Next automatic rotation time of the key. See $gcloud topic datetimes forinformation on time formats.
--rotation-period=ROTATION_PERIOD
Automatic rotation period of the key. See $gcloud topic datetimes forinformation 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 help for details.

NOTES
These variants are also available:
gcloudalphakmskeysset-rotation-schedule
gcloudbetakmskeysset-rotation-schedule

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-05-07 UTC.