Reference documentation and code samples for the Cloud Key Management Service (KMS) V1 API class Google::Cloud::Kms::V1::SingleTenantHsmInstance.
A SingleTenantHsmInstance represents a single-tenant HSM instance. It can be used for creating CryptoKeys with a ProtectionLevel of [HSM_SINGLE_TENANT][CryptoKeyVersion.ProtectionLevel.HSM_SINGLE_TENANT], as well as performing cryptographic operations using keys created within the SingleTenantHsmInstance.
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 SingleTenantHsmInstance was created.
#delete_time
def delete_time() -> ::Google::Protobuf::Timestamp
Returns
- (::Google::Protobuf::Timestamp) — Output only. The time at which the SingleTenantHsmInstance was deleted.
#disable_time
def disable_time() -> ::Google::Protobuf::Timestamp
Returns
- (::Google::Protobuf::Timestamp) — 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.
#key_portability_enabled
def key_portability_enabled() -> ::Boolean
Returns
- (::Boolean) — 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 and not yet available in GA.
#key_portability_enabled=
def key_portability_enabled=(value) -> ::Boolean
Parameter
- value (::Boolean) — 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 and not yet available in GA.
Returns
- (::Boolean) — 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 and not yet available in GA.
#name
def name() -> ::String
Returns
-
(::String) — Identifier. The resource name for this
SingleTenantHsmInstance in
the format
projects/*/locations/*/singleTenantHsmInstances/*.
#name=
def name=(value) -> ::String
Parameter
-
value (::String) — Identifier. The resource name for this
SingleTenantHsmInstance in
the format
projects/*/locations/*/singleTenantHsmInstances/*.
Returns
-
(::String) — Identifier. The resource name for this
SingleTenantHsmInstance in
the format
projects/*/locations/*/singleTenantHsmInstances/*.
#quorum_auth
def quorum_auth() -> ::Google::Cloud::Kms::V1::SingleTenantHsmInstance::QuorumAuth
Returns
- (::Google::Cloud::Kms::V1::SingleTenantHsmInstance::QuorumAuth) — Required. The quorum auth configuration for the SingleTenantHsmInstance.
#quorum_auth=
def quorum_auth=(value) -> ::Google::Cloud::Kms::V1::SingleTenantHsmInstance::QuorumAuth
Parameter
- value (::Google::Cloud::Kms::V1::SingleTenantHsmInstance::QuorumAuth) — Required. The quorum auth configuration for the SingleTenantHsmInstance.
Returns
- (::Google::Cloud::Kms::V1::SingleTenantHsmInstance::QuorumAuth) — Required. The quorum auth configuration for the SingleTenantHsmInstance.
#state
def state() -> ::Google::Cloud::Kms::V1::SingleTenantHsmInstance::State
Returns
- (::Google::Cloud::Kms::V1::SingleTenantHsmInstance::State) — Output only. The state of the SingleTenantHsmInstance.
#unrefreshed_duration_until_disable
def unrefreshed_duration_until_disable() -> ::Google::Protobuf::Duration
Returns
- (::Google::Protobuf::Duration) — Output only. The system-defined duration that an instance can remain unrefreshed until it is automatically disabled. This will have a value of 120 days.