Google Cloud Compute V1 API - Class Google::Cloud::Compute::V1::CustomerEncryptionKey (v3.5.0)

Reference documentation and code samples for the Google Cloud Compute V1 API class Google::Cloud::Compute::V1::CustomerEncryptionKey.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#kms_key_name

def kms_key_name() -> ::String
Returns
  • (::String) — 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

#kms_key_name=

def kms_key_name=(value) -> ::String
Parameter
  • value (::String) — 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

Returns
  • (::String) — 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

#kms_key_service_account

def kms_key_service_account() -> ::String
Returns
  • (::String) — 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/

#kms_key_service_account=

def kms_key_service_account=(value) -> ::String
Parameter
  • value (::String) — 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/

Returns
  • (::String) — 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/

#raw_key

def raw_key() -> ::String
Returns
  • (::String) — 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="

#raw_key=

def raw_key=(value) -> ::String
Parameter
  • value (::String) — 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="

Returns
  • (::String) — 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="

#rsa_encrypted_key

def rsa_encrypted_key() -> ::String
Returns
  • (::String) — 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

#rsa_encrypted_key=

def rsa_encrypted_key=(value) -> ::String
Parameter
  • value (::String) — 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

Returns
  • (::String) — 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

#sha256

def sha256() -> ::String
Returns
  • (::String) — [Output only] TheRFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

#sha256=

def sha256=(value) -> ::String
Parameter
  • value (::String) — [Output only] TheRFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
Returns
  • (::String) — [Output only] TheRFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.