Class: Google::Apis::CloudkmsV1::EkmConnection

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
lib/google/apis/cloudkms_v1/classes.rb,
lib/google/apis/cloudkms_v1/representations.rb,
lib/google/apis/cloudkms_v1/representations.rb

Overview

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.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ EkmConnection

Returns a new instance of EkmConnection.



1068
1069
1070
 
# File 'lib/google/apis/cloudkms_v1/classes.rb', line 1068

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#create_time ⇒ String

Output only. The time at which the EkmConnection was created. Corresponds to the JSON property createTime

Returns:

  • (String) 


1036
1037
1038
 
# File 'lib/google/apis/cloudkms_v1/classes.rb', line 1036

def create_time
  @create_time
end

#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. Corresponds to the JSON property cryptoSpacePath

Returns:

  • (String) 


1042
1043
1044
 
# File 'lib/google/apis/cloudkms_v1/classes.rb', line 1042

def crypto_space_path
  @crypto_space_path
end

#etag ⇒ String

Optional. Etag of the currently stored EkmConnection. Corresponds to the JSON property etag

Returns:

  • (String) 


1047
1048
1049
 
# File 'lib/google/apis/cloudkms_v1/classes.rb', line 1047

def etag
  @etag
end

#key_management_mode ⇒ String

Optional. Describes who can perform control plane operations on the EKM. If unset, this defaults to MANUAL. Corresponds to the JSON property keyManagementMode

Returns:

  • (String) 


1053
1054
1055
 
# File 'lib/google/apis/cloudkms_v1/classes.rb', line 1053

def key_management_mode
  @key_management_mode
end

#name ⇒ String

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

Returns:

  • (String) 


1059
1060
1061
 
# File 'lib/google/apis/cloudkms_v1/classes.rb', line 1059

def name
  @name
end

#service_resolvers ⇒ Array<Google::Apis::CloudkmsV1::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. Corresponds to the JSON property serviceResolvers

Returns:



1066
1067
1068
 
# File 'lib/google/apis/cloudkms_v1/classes.rb', line 1066

def service_resolvers
  @service_resolvers
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1073
1074
1075
1076
1077
1078
1079
1080
 
# File 'lib/google/apis/cloudkms_v1/classes.rb', line 1073

def update!(**args)
  @create_time = args[:create_time] if args.key?(:create_time)
  @crypto_space_path = args[:crypto_space_path] if args.key?(:crypto_space_path)
  @etag = args[:etag] if args.key?(:etag)
  @key_management_mode = args[:key_management_mode] if args.key?(:key_management_mode)
  @name = args[:name] if args.key?(:name)
  @service_resolvers = args[:service_resolvers] if args.key?(:service_resolvers)
end