Reference documentation and code samples for the Cloud KMS V1 Client class KeyHandle.
Resource-oriented representation of a request to Cloud KMS Autokey and the resulting provisioning of a CryptoKey .
Generated from protobuf message google.cloud.kms.v1.KeyHandle
Namespace
Google \ Cloud \ Kms \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ name
string
Identifier. Name of the KeyHandle
resource, e.g. projects/{PROJECT_ID}/locations/{LOCATION}/keyHandles/{KEY_HANDLE_ID}
.
↳ kms_key
string
Output only. Name of a CryptoKey that has been provisioned for Customer Managed Encryption Key (CMEK) use in the KeyHandle project and location for the requested resource type. The CryptoKey project will reflect the value configured in the AutokeyConfig on the resource project's ancestor folder at the time of the KeyHandle creation. If more than one ancestor folder has a configured AutokeyConfig , the nearest of these configurations is used.
↳ resource_type_selector
string
Required. Indicates the resource type that the resulting CryptoKey
is meant to protect, e.g. {SERVICE}.googleapis.com/{TYPE}
. See documentation for supported resource types.
getName
Identifier. Name of the KeyHandle resource, e.g.
projects/{PROJECT_ID}/locations/{LOCATION}/keyHandles/{KEY_HANDLE_ID}
.
string
setName
Identifier. Name of the KeyHandle resource, e.g.
projects/{PROJECT_ID}/locations/{LOCATION}/keyHandles/{KEY_HANDLE_ID}
.
var
string
$this
getKmsKey
Output only. Name of a CryptoKey that has been provisioned for Customer Managed Encryption Key (CMEK) use in the KeyHandle project and location for the requested resource type. The CryptoKey project will reflect the value configured in the AutokeyConfig on the resource project's ancestor folder at the time of the KeyHandle creation. If more than one ancestor folder has a configured AutokeyConfig , the nearest of these configurations is used.
string
setKmsKey
Output only. Name of a CryptoKey that has been provisioned for Customer Managed Encryption Key (CMEK) use in the KeyHandle project and location for the requested resource type. The CryptoKey project will reflect the value configured in the AutokeyConfig on the resource project's ancestor folder at the time of the KeyHandle creation. If more than one ancestor folder has a configured AutokeyConfig , the nearest of these configurations is used.
var
string
$this
getResourceTypeSelector
Required. Indicates the resource type that the resulting CryptoKey is meant to protect, e.g.
{SERVICE}.googleapis.com/{TYPE}
. See documentation for supported resource
types.
string
setResourceTypeSelector
Required. Indicates the resource type that the resulting CryptoKey is meant to protect, e.g.
{SERVICE}.googleapis.com/{TYPE}
. See documentation for supported resource
types.
var
string
$this
