Class: Google::Cloud::Kms::V1::EkmConnection

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/kms/v1/ekm_service.rb

Overview

An EkmConnection represents an individual EKM connection. It can be used for creating CryptoKeys and CryptoKeyVersions with a ProtectionLevel of [EXTERNAL_VPC][CryptoKeyVersion.ProtectionLevel.EXTERNAL_VPC], as well as performing cryptographic operations using keys created within the EkmConnection.

Defined Under Namespace

Classes: ServiceResolver

Instance Attribute Summary collapse

Instance Attribute Details

#create_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. The time at which the EkmConnection was created.

Returns:



195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'proto_docs/google/cloud/kms/v1/ekm_service.rb', line 195

class EkmConnection
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # A {::Google::Cloud::Kms::V1::EkmConnection::ServiceResolver ServiceResolver}
  # represents an EKM replica that can be reached within an
  # {::Google::Cloud::Kms::V1::EkmConnection EkmConnection}.
  # @!attribute [rw] service_directory_service
  #   @return [::String]
  #     Required. The resource name of the Service Directory service pointing to
  #     an EKM replica, in the format
  #     `projects/*/locations/*/namespaces/*/services/*`.
  # @!attribute [rw] endpoint_filter
  #   @return [::String]
  #     Optional. The filter applied to the endpoints of the resolved service. If
  #     no filter is specified, all endpoints will be considered. An endpoint
  #     will be chosen arbitrarily from the filtered list for each request.
  #
  #     For endpoint filter syntax and examples, see
  #     https://cloud.google.com/service-directory/docs/reference/rpc/google.cloud.servicedirectory.v1#resolveservicerequest.
  # @!attribute [rw] hostname
  #   @return [::String]
  #     Required. The hostname of the EKM replica used at TLS and HTTP layers.
  # @!attribute [rw] server_certificates
  #   @return [::Array<::Google::Cloud::Kms::V1::Certificate>]
  #     Required. A list of leaf server certificates used to authenticate HTTPS
  #     connections to the EKM replica. Currently, a maximum of 10
  #     {::Google::Cloud::Kms::V1::Certificate Certificate} is supported.
  class ServiceResolver
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#etag ⇒ ::String

Returns Optional. Etag of the currently stored EkmConnection.

Returns:

  • (::String) —

    Optional. Etag of the currently stored EkmConnection.



195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'proto_docs/google/cloud/kms/v1/ekm_service.rb', line 195

class EkmConnection
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # A {::Google::Cloud::Kms::V1::EkmConnection::ServiceResolver ServiceResolver}
  # represents an EKM replica that can be reached within an
  # {::Google::Cloud::Kms::V1::EkmConnection EkmConnection}.
  # @!attribute [rw] service_directory_service
  #   @return [::String]
  #     Required. The resource name of the Service Directory service pointing to
  #     an EKM replica, in the format
  #     `projects/*/locations/*/namespaces/*/services/*`.
  # @!attribute [rw] endpoint_filter
  #   @return [::String]
  #     Optional. The filter applied to the endpoints of the resolved service. If
  #     no filter is specified, all endpoints will be considered. An endpoint
  #     will be chosen arbitrarily from the filtered list for each request.
  #
  #     For endpoint filter syntax and examples, see
  #     https://cloud.google.com/service-directory/docs/reference/rpc/google.cloud.servicedirectory.v1#resolveservicerequest.
  # @!attribute [rw] hostname
  #   @return [::String]
  #     Required. The hostname of the EKM replica used at TLS and HTTP layers.
  # @!attribute [rw] server_certificates
  #   @return [::Array<::Google::Cloud::Kms::V1::Certificate>]
  #     Required. A list of leaf server certificates used to authenticate HTTPS
  #     connections to the EKM replica. Currently, a maximum of 10
  #     {::Google::Cloud::Kms::V1::Certificate Certificate} is supported.
  class ServiceResolver
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#name ⇒ ::String (readonly)

Returns Output only. The resource name for the EkmConnection in the format projects/*/locations/*/ekmConnections/*.

Returns:

  • (::String) —

    Output only. The resource name for the EkmConnection in the format projects/*/locations/*/ekmConnections/*.



195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'proto_docs/google/cloud/kms/v1/ekm_service.rb', line 195

class EkmConnection
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # A {::Google::Cloud::Kms::V1::EkmConnection::ServiceResolver ServiceResolver}
  # represents an EKM replica that can be reached within an
  # {::Google::Cloud::Kms::V1::EkmConnection EkmConnection}.
  # @!attribute [rw] service_directory_service
  #   @return [::String]
  #     Required. The resource name of the Service Directory service pointing to
  #     an EKM replica, in the format
  #     `projects/*/locations/*/namespaces/*/services/*`.
  # @!attribute [rw] endpoint_filter
  #   @return [::String]
  #     Optional. The filter applied to the endpoints of the resolved service. If
  #     no filter is specified, all endpoints will be considered. An endpoint
  #     will be chosen arbitrarily from the filtered list for each request.
  #
  #     For endpoint filter syntax and examples, see
  #     https://cloud.google.com/service-directory/docs/reference/rpc/google.cloud.servicedirectory.v1#resolveservicerequest.
  # @!attribute [rw] hostname
  #   @return [::String]
  #     Required. The hostname of the EKM replica used at TLS and HTTP layers.
  # @!attribute [rw] server_certificates
  #   @return [::Array<::Google::Cloud::Kms::V1::Certificate>]
  #     Required. A list of leaf server certificates used to authenticate HTTPS
  #     connections to the EKM replica. Currently, a maximum of 10
  #     {::Google::Cloud::Kms::V1::Certificate Certificate} is supported.
  class ServiceResolver
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#service_resolvers ⇒ ::Array<::Google::Cloud::Kms::V1::EkmConnection::ServiceResolver>

Returns 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:



195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'proto_docs/google/cloud/kms/v1/ekm_service.rb', line 195

class EkmConnection
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # A {::Google::Cloud::Kms::V1::EkmConnection::ServiceResolver ServiceResolver}
  # represents an EKM replica that can be reached within an
  # {::Google::Cloud::Kms::V1::EkmConnection EkmConnection}.
  # @!attribute [rw] service_directory_service
  #   @return [::String]
  #     Required. The resource name of the Service Directory service pointing to
  #     an EKM replica, in the format
  #     `projects/*/locations/*/namespaces/*/services/*`.
  # @!attribute [rw] endpoint_filter
  #   @return [::String]
  #     Optional. The filter applied to the endpoints of the resolved service. If
  #     no filter is specified, all endpoints will be considered. An endpoint
  #     will be chosen arbitrarily from the filtered list for each request.
  #
  #     For endpoint filter syntax and examples, see
  #     https://cloud.google.com/service-directory/docs/reference/rpc/google.cloud.servicedirectory.v1#resolveservicerequest.
  # @!attribute [rw] hostname
  #   @return [::String]
  #     Required. The hostname of the EKM replica used at TLS and HTTP layers.
  # @!attribute [rw] server_certificates
  #   @return [::Array<::Google::Cloud::Kms::V1::Certificate>]
  #     Required. A list of leaf server certificates used to authenticate HTTPS
  #     connections to the EKM replica. Currently, a maximum of 10
  #     {::Google::Cloud::Kms::V1::Certificate Certificate} is supported.
  class ServiceResolver
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end