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.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Output only. The resource name for the EkmConnection in the format |
↳ create_time |
Google\Protobuf\Timestamp
Output only. The time at which the EkmConnection was created. |
↳ 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 |
string
Optional. Etag of the currently stored EkmConnection. |
↳ 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/*.
| Returns | |
|---|---|
| Type | Description |
string | |
setName
Output only. The resource name for the
EkmConnection in the format
projects/*/locations/*/ekmConnections/*.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getCreateTime
Output only. The time at which the EkmConnection was created.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasCreateTime
clearCreateTime
setCreateTime
Output only. The time at which the EkmConnection was created.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$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.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
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.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\Kms\V1\EkmConnection\ServiceResolver>
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getEtag
Optional. Etag of the currently stored EkmConnection.
| Returns | |
|---|---|
| Type | Description |
string | |
setEtag
Optional. Etag of the currently stored EkmConnection.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getKeyManagementMode
Optional. Describes who can perform control plane operations on the EKM. If unset, this defaults to MANUAL.
| Returns | |
|---|---|
| Type | Description |
int | |
setKeyManagementMode
Optional. Describes who can perform control plane operations on the EKM. If unset, this defaults to MANUAL.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getCryptoSpacePath
Optional. Identifies the EKM Crypto Space that this EkmConnection maps to. Note: This field is required if KeyManagementMode is CLOUD_KMS.
| Returns | |
|---|---|
| Type | Description |
string | |
setCryptoSpacePath
Optional. Identifies the EKM Crypto Space that this EkmConnection maps to. Note: This field is required if KeyManagementMode is CLOUD_KMS.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |