Cloud KMS V1 Client - Class EkmConfig (1.21.4)

Reference documentation and code samples for the Cloud KMS V1 Client class EkmConfig.

An EkmConfig is a singleton resource that represents configuration parameters that apply to all CryptoKeys and CryptoKeyVersions with a ProtectionLevel of EXTERNAL_VPC in a given project and location.

Generated from protobuf message google.cloud.kms.v1.EkmConfig

Namespace

Google \ Cloud \ Kms \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ name string

Output only. The resource name for the EkmConfig in the format projects/*/locations/*/ekmConfig.

↳ default_ekm_connection string

Optional. Resource name of the default EkmConnection. Setting this field to the empty string removes the default.

getName

Output only. The resource name for the EkmConfig in the format projects/*/locations/*/ekmConfig.

Returns
Type Description
string

setName

Output only. The resource name for the EkmConfig in the format projects/*/locations/*/ekmConfig.

Parameter
Name Description
var string
Returns
Type Description
$this

getDefaultEkmConnection

Optional. Resource name of the default EkmConnection. Setting this field to the empty string removes the default.

Returns
Type Description
string

setDefaultEkmConnection

Optional. Resource name of the default EkmConnection. Setting this field to the empty string removes the default.

Parameter
Name Description
var string
Returns
Type Description
$this