Update a CryptoKey.

Scopes

You will need authorization for at least one of the following scopes to make a valid call:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloudkms

If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-platform. You can set the scope for this method like this: cloudkms1 --scope <scope> projects locations-key-rings-crypto-keys-patch ...

Required Scalar Argument

  • <name> (string)
    • Output only. The resource name for this CryptoKey in the format projects/*/locations/*/keyRings/*/cryptoKeys/*.

Required Request Value

The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely.

For example, a structure like this:

CryptoKey:
  create-time: string
  crypto-key-backend: string
  destroy-scheduled-duration: string
  import-only: boolean
  labels: { string: string }
  name: string
  next-rotation-time: string
  primary:
    algorithm: string
    attestation:
      cert-chains:
        cavium-certs: [string]
        google-card-certs: [string]
        google-partition-certs: [string]
      content: string
      format: string
    create-time: string
    destroy-event-time: string
    destroy-time: string
    external-destruction-failure-reason: string
    external-protection-level-options:
      ekm-connection-key-path: string
      external-key-uri: string
    generate-time: string
    generation-failure-reason: string
    import-failure-reason: string
    import-job: string
    import-time: string
    name: string
    protection-level: string
    reimport-eligible: boolean
    state: string
  purpose: string
  rotation-period: string
  version-template:
    algorithm: string
    protection-level: string

can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time.

  • -r . create-time=sit
    • Output only. The time at which this CryptoKey was created.
  • crypto-key-backend=sed
    • Immutable. The resource name of the backend environment where the key material for all CryptoKeyVersions associated with this CryptoKey reside and where all related cryptographic operations are performed. Only applicable if CryptoKeyVersions have a ProtectionLevel of EXTERNAL_VPC, with the resource name in the format projects/*/locations/*/ekmConnections/*. Note, this list is non-exhaustive and may apply to additional ProtectionLevels in the future.
  • destroy-scheduled-duration=eos
    • Immutable. The period of time that versions of this key spend in the DESTROY_SCHEDULED state before transitioning to DESTROYED. If not specified at creation time, the default duration is 24 hours.
  • import-only=true
    • Immutable. Whether this key may contain imported versions only.
  • labels=key=ea
    • Labels with user-defined metadata. For more information, see Labeling Keys.
    • the value will be associated with the given key
  • name=stet
    • Output only. The resource name for this CryptoKey in the format projects/*/locations/*/keyRings/*/cryptoKeys/*.
  • next-rotation-time=dolores
    • At next_rotation_time, the Key Management Service will automatically: 1. Create a new version of this CryptoKey. 2. Mark the new version as primary. Key rotations performed manually via CreateCryptoKeyVersion and UpdateCryptoKeyPrimaryVersion do not affect next_rotation_time. Keys with purpose ENCRYPT_DECRYPT support automatic rotation. For other keys, this field must be omitted.
  • primary algorithm=eos
    • Output only. The CryptoKeyVersionAlgorithm that this CryptoKeyVersion supports.
  • attestation.cert-chains cavium-certs=et
    • Cavium certificate chain corresponding to the attestation.
    • Each invocation of this argument appends the given value to the array.
  • google-card-certs=sea
    • Google card certificate chain corresponding to the attestation.
    • Each invocation of this argument appends the given value to the array.

  • google-partition-certs=et

    • Google partition certificate chain corresponding to the attestation.
    • Each invocation of this argument appends the given value to the array.

  • .. content=at

    • Output only. The attestation data provided by the HSM when the key operation was performed.

  • format=dolore

    • Output only. The format of the attestation data.

  • .. create-time=eirmod

    • Output only. The time at which this CryptoKeyVersion was created.
  • destroy-event-time=lorem
    • Output only. The time this CryptoKeyVersion's key material was destroyed. Only present if state is DESTROYED.
  • destroy-time=accusam
    • Output only. The time this CryptoKeyVersion's key material is scheduled for destruction. Only present if state is DESTROY_SCHEDULED.
  • external-destruction-failure-reason=amet
    • Output only. The root cause of the most recent external destruction failure. Only present if state is EXTERNAL_DESTRUCTION_FAILED.
  • external-protection-level-options ekm-connection-key-path=erat
    • The path to the external key material on the EKM when using EkmConnection e.g., "v0/my/key". Set this field instead of external_key_uri when using an EkmConnection.

  • external-key-uri=dolores

    • The URI for an external resource that this CryptoKeyVersion represents.

  • .. generate-time=erat

    • Output only. The time this CryptoKeyVersion's key material was generated.
  • generation-failure-reason=accusam
    • Output only. The root cause of the most recent generation failure. Only present if state is GENERATION_FAILED.
  • import-failure-reason=sea
    • Output only. The root cause of the most recent import failure. Only present if state is IMPORT_FAILED.
  • import-job=takimata
    • Output only. The name of the ImportJob used in the most recent import of this CryptoKeyVersion. Only present if the underlying key material was imported.
  • import-time=lorem
    • Output only. The time at which this CryptoKeyVersion's key material was most recently imported.
  • name=et
    • Output only. The resource name for this CryptoKeyVersion in the format projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*.
  • protection-level=at
    • Output only. The ProtectionLevel describing how crypto operations are performed with this CryptoKeyVersion.
  • reimport-eligible=true
    • Output only. Whether or not this key version is eligible for reimport, by being specified as a target in ImportCryptoKeyVersionRequest.crypto_key_version.

  • state=erat

    • The current state of the CryptoKeyVersion.

  • .. purpose=sea

    • Immutable. The immutable purpose of this CryptoKey.
  • rotation-period=nonumy
    • next_rotation_time will be advanced by this period when the service automatically rotates a key. Must be at least 24 hours and at most 876,000 hours. If rotation_period is set, next_rotation_time must also be set. Keys with purpose ENCRYPT_DECRYPT support automatic rotation. For other keys, this field must be omitted.
  • version-template algorithm=et
    • Required. Algorithm to use when creating a CryptoKeyVersion based on this template. For backwards compatibility, GOOGLE_SYMMETRIC_ENCRYPTION is implied if both this field is omitted and CryptoKey.purpose is ENCRYPT_DECRYPT.
  • protection-level=gubergren
    • ProtectionLevel to use when creating a CryptoKeyVersion based on this template. Immutable. Defaults to SOFTWARE.

About Cursors

The cursor position is key to comfortably set complex nested structures. The following rules apply:

  • The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o .
  • The cursor position is set relative to the top-level structure if it starts with ., e.g. -r .s.s
  • You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar.
  • You can move the cursor one level up by using ... Each additional . moves it up one additional level. E.g. ... would go three levels up.

Optional Output Flags

The method's return value a JSON encoded structure, which will be written to standard output by default.

  • -o out
    • out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.

Optional Method Properties

You may set the following properties to further configure the call. Please note that -p is followed by one or more key-value-pairs, and is called like this -p k1=v1 k2=v2 even though the listing below repeats the -p for completeness.

  • -p update-mask=string
    • Required. List of fields to be updated in this request.

Optional General Properties

The following properties can configure any call, and are not specific to this method.

  • -p $-xgafv=string

    • V1 error format.

  • -p access-token=string

    • OAuth access token.

  • -p alt=string

    • Data format for response.

  • -p callback=string

    • JSONP

  • -p fields=string

    • Selector specifying which fields to include in a partial response.

  • -p key=string

    • API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

  • -p oauth-token=string

    • OAuth 2.0 token for the current user.

  • -p pretty-print=boolean

    • Returns response with indentations and line breaks.

  • -p quota-user=string

    • Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • -p upload-type=string

    • Legacy upload protocol for media (e.g. "media", "multipart").

  • -p upload-protocol=string

    • Upload protocol for media (e.g. "raw", "multipart").