Compute Engine v1 API - Class CustomerEncryptionKey (3.21.0) 

public sealed class CustomerEncryptionKey : IMessage<CustomerEncryptionKey>, IEquatable<CustomerEncryptionKey>, IDeepCloneable<CustomerEncryptionKey>, IBufferMessage, IMessage

Inheritance

object > CustomerEncryptionKey

Namespace

Google.Cloud.Compute.V1

Assembly

Google.Cloud.Compute.V1.dll

Constructors

CustomerEncryptionKey()

public CustomerEncryptionKey()

CustomerEncryptionKey(CustomerEncryptionKey)

public CustomerEncryptionKey(CustomerEncryptionKey other)
Parameter
Name Description
other CustomerEncryptionKey

Properties

HasKmsKeyName

public bool HasKmsKeyName { get; }

Gets whether the "kms_key_name" field is set

Property Value
Type Description
bool

HasKmsKeyServiceAccount

public bool HasKmsKeyServiceAccount { get; }

Gets whether the "kms_key_service_account" field is set

Property Value
Type Description
bool

HasRawKey

public bool HasRawKey { get; }

Gets whether the "raw_key" field is set

Property Value
Type Description
bool

HasRsaEncryptedKey

public bool HasRsaEncryptedKey { get; }

Gets whether the "rsa_encrypted_key" field is set

Property Value
Type Description
bool

HasSha256

public bool HasSha256 { get; }

Gets whether the "sha256" field is set

Property Value
Type Description
bool

KmsKeyName

public string KmsKeyName { get; set; }

The name of the encryption key that is stored in Google Cloud KMS. For example:

"kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key

The fully-qualifed key name may be returned for resource GET requests. For example:

"kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key /cryptoKeyVersions/1

Property Value
Type Description
string

KmsKeyServiceAccount

public string KmsKeyServiceAccount { get; set; }

The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used. For example:

"kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/

Property Value
Type Description
string

RawKey

public string RawKey { get; set; }

Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. You can provide either the rawKey or thersaEncryptedKey. For example:

"rawKey": "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="

Property Value
Type Description
string

RsaEncryptedKey

public string RsaEncryptedKey { get; set; }

Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or thersaEncryptedKey. For example:

"rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="

The key must meet the following requirements before you can provide it to Compute Engine:

  1. The key is wrapped using a RSA public key certificate provided by Google.
  2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding.

Gets the RSA public key certificate provided by Google at:

https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

Property Value
Type Description
string

Sha256

public string Sha256 { get; set; }

[Output only] TheRFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

Property Value
Type Description
string