Reference documentation and code samples for the Cloud KMS V1 Client class EkmConnection.
An EkmConnection represents an individual EKM connection. It can be used for creating CryptoKeys and CryptoKeyVersions with a ProtectionLevel of EXTERNAL_VPC , as well as performing cryptographic operations using keys created within the EkmConnection .
Generated from protobuf message google.cloud.kms.v1.EkmConnection
Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ name
string
Output only. The resource name for the EkmConnection
in the format projects/*/locations/*/ekmConnections/*
.
↳ create_time
↳ service_resolvers
array< Google\Cloud\Kms\V1\EkmConnection\ServiceResolver
>
A list of ServiceResolvers where the EKM can be reached. There should be one ServiceResolver per EKM replica. Currently, only a single ServiceResolver is supported.
↳ etag
↳ key_management_mode
int
Optional. Describes who can perform control plane operations on the EKM. If unset, this defaults to MANUAL .
↳ crypto_space_path
string
Optional. Identifies the EKM Crypto Space that this EkmConnection maps to. Note: This field is required if KeyManagementMode is CLOUD_KMS .
getName
Output only. The resource name for the EkmConnection
in the format projects/*/locations/*/ekmConnections/*
.
string
setName
Output only. The resource name for the EkmConnection
in the format projects/*/locations/*/ekmConnections/*
.
var
string
$this
getCreateTime
Output only. The time at which the EkmConnection was created.
hasCreateTime
clearCreateTime
setCreateTime
Output only. The time at which the EkmConnection was created.
$this
getServiceResolvers
A list of ServiceResolvers where the EKM can be reached. There should be one ServiceResolver per EKM replica. Currently, only a single ServiceResolver is supported.
setServiceResolvers
A list of ServiceResolvers where the EKM can be reached. There should be one ServiceResolver per EKM replica. Currently, only a single ServiceResolver is supported.
$this
getEtag
Optional. Etag of the currently stored EkmConnection .
string
setEtag
Optional. Etag of the currently stored EkmConnection .
var
string
$this
getKeyManagementMode
Optional. Describes who can perform control plane operations on the EKM. If unset, this defaults to MANUAL .
int
setKeyManagementMode
Optional. Describes who can perform control plane operations on the EKM. If unset, this defaults to MANUAL .
var
int
$this
getCryptoSpacePath
Optional. Identifies the EKM Crypto Space that this EkmConnection maps to. Note: This field is required if KeyManagementMode is CLOUD_KMS .
string
setCryptoSpacePath
Optional. Identifies the EKM Crypto Space that this EkmConnection maps to. Note: This field is required if KeyManagementMode is CLOUD_KMS .
var
string
$this
