1
0
Fork 0
mirror of https://github.com/imjasonh/gcloud-help synced 2026-07-16 20:36:39 +00:00
gcloud-help/gcloud/kms/keys/set-rotation-schedule

93 lines
3.3 KiB
Text
Raw Normal View History

2022-03-01 04:29:52 +00:00
NAME
gcloud kms keys set-rotation-schedule - update the rotation schedule for a
key
SYNOPSIS
2023-02-15 10:13:15 +00:00
gcloud kms keys set-rotation-schedule
(KEY : --keyring=KEYRING --location=LOCATION)
[--next-rotation-time=NEXT_ROTATION_TIME]
2022-03-01 04:29:52 +00:00
[--rotation-period=ROTATION_PERIOD] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Updates the rotation schedule for the given key. The schedule automatically
creates 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 units can be one
of seconds (s), minutes (m), hours (h) or days (d).
Key rotations performed manually via update-primary-version and the version
create do not affect the stored --next-rotation-time.
EXAMPLES
The following command sets a 30 day rotation period for the key named frodo
within the keyring fellowship and location global starting at the specified
time:
2022-03-01 21:43:54 +00:00
$ gcloud kms keys set-rotation-schedule frodo --location=global \
--keyring=fellowship --rotation-period=30d \
2022-03-01 04:29:52 +00:00
--next-rotation-time=2017-10-12T12:34:56.1234Z
POSITIONAL ARGUMENTS
2023-02-15 10:13:15 +00:00
Key resource - The KMS key resource. The arguments in this group can be
used to specify the attributes of this resource. (NOTE) Some attributes
2023-05-04 10:43:54 +00:00
are not given arguments in this group but can be set in other ways.
To set the project attribute:
2023-02-15 10:13:15 +00:00
◆ provide the argument key on the command line with a fully specified
name;
◆ set the property core/project.
This must be specified.
KEY
2023-05-04 10:43:54 +00:00
ID of the key or fully qualified identifier for the key.
To set the key attribute:
2023-02-15 10:13:15 +00:00
▸ provide the argument key on the command line.
This positional argument must be specified if any of the other
arguments in this group are specified.
--keyring=KEYRING
2023-05-04 10:43:54 +00:00
The KMS keyring of the key.
To set the keyring attribute:
2023-02-15 10:13:15 +00:00
▸ provide the argument key on the command line with a fully
specified name;
▸ provide the argument --keyring on the command line.
--location=LOCATION
2023-05-04 10:43:54 +00:00
The Google Cloud location for the key.
To set the location attribute:
2023-02-15 10:13:15 +00:00
▸ provide the argument key on the command line with a fully
specified name;
▸ provide the argument --location on the command line.
2022-03-01 04:29:52 +00:00
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 help for details.
NOTES
These variants are also available:
$ gcloud alpha kms keys set-rotation-schedule
$ gcloud beta kms keys set-rotation-schedule