Stackdriver Logging V2 Client - Class CmekSettings (1.31.1)

Reference documentation and code samples for the Stackdriver Logging V2 Client class CmekSettings.

Describes the customer-managed encryption key (CMEK) settings associated with a project, folder, organization, billing account, or flexible resource.

Note: CMEK for the Log Router can currently only be configured for Google Cloud organizations. Once configured, it applies to all projects and folders in the Google Cloud organization. See Enabling CMEK for Log Router for more information.

Generated from protobuf message google.logging.v2.CmekSettings

Namespace

Google \ Cloud \ Logging \ V2

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ name string

Output only. The resource name of the CMEK settings.
↳ kms_key_name string

The resource name for the configured Cloud KMS key. KMS key name format: "projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]" For example: "projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key" To enable CMEK for the Log Router, set this field to a valid kms_key_name for which the associated service account has the required cloudkms.cryptoKeyEncrypterDecrypter roles assigned for the key. The Cloud KMS key used by the Log Router can be updated by changing the kms_key_name to a new valid key name or disabled by setting the key name to an empty string. Encryption operations that are in progress will be completed with the key that was in use when they started. Decryption operations will be completed using the key that was used at the time of encryption unless access to that key has been revoked. To disable CMEK for the Log Router, set this field to an empty string. See Enabling CMEK for Log Router for more information.
↳ kms_key_version_name string

The CryptoKeyVersion resource name for the configured Cloud KMS key. KMS key name format: "projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]/cryptoKeyVersions/[VERSION]" For example: "projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key/cryptoKeyVersions/1" This is a read-only field used to convey the specific configured CryptoKeyVersion of kms_key that has been configured. It will be populated in cases where the CMEK settings are bound to a single key version. If this field is populated, the kms_key is tied to a specific CryptoKeyVersion.
↳ service_account_id string

Output only. The service account that will be used by the Log Router to access your Cloud KMS key. Before enabling CMEK for Log Router, you must first assign the cloudkms.cryptoKeyEncrypterDecrypter role to the service account that the Log Router will use to access your Cloud KMS key. Use GetCmekSettings to obtain the service account ID. See Enabling CMEK for Log Router for more information.

getName

Output only. The resource name of the CMEK settings.

Returns
Type Description
string

setName

Output only. The resource name of the CMEK settings.

Parameter
Name Description
var string
Returns
Type Description
$this

getKmsKeyName

The resource name for the configured Cloud KMS key.

KMS key name format: "projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]" For example: "projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key" To enable CMEK for the Log Router, set this field to a valid kms_key_name for which the associated service account has the required cloudkms.cryptoKeyEncrypterDecrypter roles assigned for the key. The Cloud KMS key used by the Log Router can be updated by changing the kms_key_name to a new valid key name or disabled by setting the key name to an empty string. Encryption operations that are in progress will be completed with the key that was in use when they started. Decryption operations will be completed using the key that was used at the time of encryption unless access to that key has been revoked. To disable CMEK for the Log Router, set this field to an empty string. See Enabling CMEK for Log Router for more information.

Returns
Type Description
string

setKmsKeyName

The resource name for the configured Cloud KMS key.

KMS key name format: "projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]" For example: "projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key" To enable CMEK for the Log Router, set this field to a valid kms_key_name for which the associated service account has the required cloudkms.cryptoKeyEncrypterDecrypter roles assigned for the key. The Cloud KMS key used by the Log Router can be updated by changing the kms_key_name to a new valid key name or disabled by setting the key name to an empty string. Encryption operations that are in progress will be completed with the key that was in use when they started. Decryption operations will be completed using the key that was used at the time of encryption unless access to that key has been revoked. To disable CMEK for the Log Router, set this field to an empty string. See Enabling CMEK for Log Router for more information.

Parameter
Name Description
var string
Returns
Type Description
$this

getKmsKeyVersionName

The CryptoKeyVersion resource name for the configured Cloud KMS key.

KMS key name format: "projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]/cryptoKeyVersions/[VERSION]" For example: "projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key/cryptoKeyVersions/1" This is a read-only field used to convey the specific configured CryptoKeyVersion of kms_key that has been configured. It will be populated in cases where the CMEK settings are bound to a single key version. If this field is populated, the kms_key is tied to a specific CryptoKeyVersion.

Returns
Type Description
string

setKmsKeyVersionName

The CryptoKeyVersion resource name for the configured Cloud KMS key.

KMS key name format: "projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]/cryptoKeyVersions/[VERSION]" For example: "projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key/cryptoKeyVersions/1" This is a read-only field used to convey the specific configured CryptoKeyVersion of kms_key that has been configured. It will be populated in cases where the CMEK settings are bound to a single key version. If this field is populated, the kms_key is tied to a specific CryptoKeyVersion.

Parameter
Name Description
var string
Returns
Type Description
$this

getServiceAccountId

Output only. The service account that will be used by the Log Router to access your Cloud KMS key.

Before enabling CMEK for Log Router, you must first assign the cloudkms.cryptoKeyEncrypterDecrypter role to the service account that the Log Router will use to access your Cloud KMS key. Use GetCmekSettings to obtain the service account ID. See Enabling CMEK for Log Router for more information.

Returns
Type Description
string

setServiceAccountId

Output only. The service account that will be used by the Log Router to access your Cloud KMS key.

Before enabling CMEK for Log Router, you must first assign the cloudkms.cryptoKeyEncrypterDecrypter role to the service account that the Log Router will use to access your Cloud KMS key. Use GetCmekSettings to obtain the service account ID. See Enabling CMEK for Log Router for more information.

Parameter
Name Description
var string
Returns
Type Description
$this