Cloud KMS V1 Client - Class ImportJob (2.8.0)

Reference documentation and code samples for the Cloud KMS V1 Client class ImportJob.

An ImportJob can be used to create CryptoKeys and CryptoKeyVersions using pre-existing key material, generated outside of Cloud KMS.

When an ImportJob is created, Cloud KMS will generate a "wrapping key", which is a public/private key pair. You use the wrapping key to encrypt (also known as wrap) the pre-existing key material to protect it during the import process. The nature of the wrapping key depends on the choice of import_method. When the wrapping key generation is complete, the state will be set to ACTIVE and the public_key can be fetched. The fetched public key can then be used to wrap your pre-existing key material. Once the key material is wrapped, it can be imported into a new CryptoKeyVersion in an existing CryptoKey by calling ImportCryptoKeyVersion. Multiple CryptoKeyVersions can be imported with a single ImportJob. Cloud KMS uses the private key portion of the wrapping key to unwrap the key material. Only Cloud KMS has access to the private key. An ImportJob expires 3 days after it is created. Once expired, Cloud KMS will no longer be able to import or unwrap any key material that was wrapped with the ImportJob's public key. For more information, see Importing a key.

Generated from protobuf message google.cloud.kms.v1.ImportJob

Constructor.

Output only. The resource name for this ImportJob in the format projects/*/locations/*/keyRings/*/importJobs/*.

Output only. The resource name for this ImportJob in the format projects/*/locations/*/keyRings/*/importJobs/*.

Required. Immutable. The wrapping method to be used for incoming key material.

Required. Immutable. The wrapping method to be used for incoming key material.

Required. Immutable. The protection level of the ImportJob. This must match the protection_level of the version_template on the CryptoKey you attempt to import into.

Required. Immutable. The protection level of the ImportJob. This must match the protection_level of the version_template on the CryptoKey you attempt to import into.

Output only. The time at which this ImportJob was created.

Output only. The time at which this ImportJob was created.

Output only. The time this ImportJob's key material was generated.

Output only. The time this ImportJob's key material was generated.

Output only. The time at which this ImportJob is scheduled for expiration and can no longer be used to import key material.

Output only. The time at which this ImportJob is scheduled for expiration and can no longer be used to import key material.

Output only. The time this ImportJob expired. Only present if state is EXPIRED.

Output only. The time this ImportJob expired. Only present if state is EXPIRED.

Output only. The current state of the ImportJob, indicating if it can be used.

Output only. The current state of the ImportJob, indicating if it can be used.

Output only. The public key with which to wrap key material prior to import. Only returned if state is ACTIVE.

Output only. The public key with which to wrap key material prior to import. Only returned if state is ACTIVE.

Output only. Statement that was generated and signed by the key creator (for example, an HSM) at key creation time. Use this statement to verify attributes of the key as stored on the HSM, independently of Google.

Only present if the chosen ImportMethod is one with a protection level of HSM.

Output only. Statement that was generated and signed by the key creator (for example, an HSM) at key creation time. Use this statement to verify attributes of the key as stored on the HSM, independently of Google.

Only present if the chosen ImportMethod is one with a protection level of HSM.

Immutable. The resource name of the backend environment where the key material for the wrapping key resides and where all related cryptographic operations are performed. Currently, this field is only populated for keys stored in HSM_SINGLE_TENANT. Note, this list is non-exhaustive and may apply to additional ProtectionLevels in the future. Supported resources:

• "projects/*/locations/*/singleTenantHsmInstances/*"

Immutable. The resource name of the backend environment where the key material for the wrapping key resides and where all related cryptographic operations are performed. Currently, this field is only populated for keys stored in HSM_SINGLE_TENANT. Note, this list is non-exhaustive and may apply to additional ProtectionLevels in the future. Supported resources:

• "projects/*/locations/*/singleTenantHsmInstances/*"