Reference documentation and code samples for the Cloud Key Management Service (KMS) V1 API class Google::Cloud::Kms::V1::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.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#create_time
def create_time() -> ::Google::Protobuf::Timestamp
Returns
- (::Google::Protobuf::Timestamp) — Output only. The time at which the EkmConnection was created.
#crypto_space_path
def crypto_space_path() -> ::String
Returns
- (::String) — Optional. Identifies the EKM Crypto Space that this EkmConnection maps to. Note: This field is required if KeyManagementMode is CLOUD_KMS.
#crypto_space_path=
def crypto_space_path=(value) -> ::String
Parameter
- value (::String) — Optional. Identifies the EKM Crypto Space that this EkmConnection maps to. Note: This field is required if KeyManagementMode is CLOUD_KMS.
Returns
- (::String) — Optional. Identifies the EKM Crypto Space that this EkmConnection maps to. Note: This field is required if KeyManagementMode is CLOUD_KMS.
#etag
def etag() -> ::String
Returns
- (::String) — Optional. Etag of the currently stored EkmConnection.
#etag=
def etag=(value) -> ::String
Parameter
- value (::String) — Optional. Etag of the currently stored EkmConnection.
Returns
- (::String) — Optional. Etag of the currently stored EkmConnection.
#key_management_mode
def key_management_mode() -> ::Google::Cloud::Kms::V1::EkmConnection::KeyManagementMode
Returns
- (::Google::Cloud::Kms::V1::EkmConnection::KeyManagementMode) — Optional. Describes who can perform control plane operations on the EKM. If unset, this defaults to MANUAL.
#key_management_mode=
def key_management_mode=(value) -> ::Google::Cloud::Kms::V1::EkmConnection::KeyManagementMode
Parameter
- value (::Google::Cloud::Kms::V1::EkmConnection::KeyManagementMode) — Optional. Describes who can perform control plane operations on the EKM. If unset, this defaults to MANUAL.
Returns
- (::Google::Cloud::Kms::V1::EkmConnection::KeyManagementMode) — Optional. Describes who can perform control plane operations on the EKM. If unset, this defaults to MANUAL.
#name
def name() -> ::String
Returns
-
(::String) — Output only. The resource name for the
EkmConnection in the format
projects/*/locations/*/ekmConnections/*.
#service_resolvers
def service_resolvers() -> ::Array<::Google::Cloud::Kms::V1::EkmConnection::ServiceResolver>
Returns
- (::Array<::Google::Cloud::Kms::V1::EkmConnection::ServiceResolver>) — Optional. 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.
#service_resolvers=
def service_resolvers=(value) -> ::Array<::Google::Cloud::Kms::V1::EkmConnection::ServiceResolver>
Parameter
- value (::Array<::Google::Cloud::Kms::V1::EkmConnection::ServiceResolver>) — Optional. 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
- (::Array<::Google::Cloud::Kms::V1::EkmConnection::ServiceResolver>) — Optional. 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.