Class: Google::Apis::CloudkmsV1::SingleTenantHsmInstance

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

A SingleTenantHsmInstance represents a single-tenant HSM instance. It can be used for creating CryptoKeys with a ProtectionLevel of HSM_SINGLE_TENANT, as well as performing cryptographic operations using keys created within the SingleTenantHsmInstance.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ SingleTenantHsmInstance

Returns a new instance of SingleTenantHsmInstance.



4006
4007
4008
 
# File 'lib/google/apis/cloudkms_v1/classes.rb', line 4006

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

Instance Attribute Details

#create_time ⇒ String

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

Returns:

  • (String) 


3959
3960
3961
 
# File 'lib/google/apis/cloudkms_v1/classes.rb', line 3959

def create_time
  @create_time
end

#delete_time ⇒ String

Output only. The time at which the SingleTenantHsmInstance was deleted. Corresponds to the JSON property deleteTime

Returns:

  • (String) 


3964
3965
3966
 
# File 'lib/google/apis/cloudkms_v1/classes.rb', line 3964

def delete_time
  @delete_time
end

#disable_time ⇒ String

Output only. The time at which the instance will be automatically disabled if not refreshed. This field is updated upon creation and after each successful refresh operation and enable. A RefreshSingleTenantHsmInstance operation must be made via a SingleTenantHsmInstanceProposal before this time otherwise the SingleTenantHsmInstance will become disabled. Corresponds to the JSON property disableTime

Returns:

  • (String) 


3973
3974
3975
 
# File 'lib/google/apis/cloudkms_v1/classes.rb', line 3973

def disable_time
  @disable_time
end

#key_portability_enabled ⇒ Boolean Also known as: key_portability_enabled?

Optional. Immutable. Indicates whether key portability is enabled for the SingleTenantHsmInstance. This can only be set at creation time. Key portability features are disabled by default. Corresponds to the JSON property keyPortabilityEnabled

Returns:

  • (Boolean) 


3980
3981
3982
 
# File 'lib/google/apis/cloudkms_v1/classes.rb', line 3980

def key_portability_enabled
  @key_portability_enabled
end

#name ⇒ String

Identifier. The resource name for this SingleTenantHsmInstance in the format projects/*/locations/*/singleTenantHsmInstances/*. Corresponds to the JSON property name

Returns:

  • (String) 


3987
3988
3989
 
# File 'lib/google/apis/cloudkms_v1/classes.rb', line 3987

def name
  @name
end

#quorum_auth ⇒ Google::Apis::CloudkmsV1::QuorumAuth

Configuration for M of N quorum auth. Corresponds to the JSON property quorumAuth

Returns:



3992
3993
3994
 
# File 'lib/google/apis/cloudkms_v1/classes.rb', line 3992

def quorum_auth
  @quorum_auth
end

#state ⇒ String

Output only. The state of the SingleTenantHsmInstance. Corresponds to the JSON property state

Returns:

  • (String) 


3997
3998
3999
 
# File 'lib/google/apis/cloudkms_v1/classes.rb', line 3997

def state
  @state
end

#unrefreshed_duration_until_disable ⇒ String

Output only. The system-defined duration that an instance can remain unrefreshed until it is automatically disabled. This will have a value of 730 days. Corresponds to the JSON property unrefreshedDurationUntilDisable

Returns:

  • (String) 


4004
4005
4006
 
# File 'lib/google/apis/cloudkms_v1/classes.rb', line 4004

def unrefreshed_duration_until_disable
  @unrefreshed_duration_until_disable
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
 
# File 'lib/google/apis/cloudkms_v1/classes.rb', line 4011

def update!(**args)
  @create_time = args[:create_time] if args.key?(:create_time)
  @delete_time = args[:delete_time] if args.key?(:delete_time)
  @disable_time = args[:disable_time] if args.key?(:disable_time)
  @key_portability_enabled = args[:key_portability_enabled] if args.key?(:key_portability_enabled)
  @name = args[:name] if args.key?(:name)
  @quorum_auth = args[:quorum_auth] if args.key?(:quorum_auth)
  @state = args[:state] if args.key?(:state)
  @unrefreshed_duration_until_disable = args[:unrefreshed_duration_until_disable] if args.key?(:unrefreshed_duration_until_disable)
end