Cloud Key Management Service (KMS) V1 API - Class Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal (v1.10.0)

Version latest

• 1.10.0 (latest)
• 1.9.2
• 1.8.0
• 1.7.0
• 1.6.0
• 1.5.1
• 1.4.0
• 1.3.2
• 1.2.1
• 1.1.0
• 1.0.2
• 0.27.0
• 0.26.0
• 0.25.1
• 0.24.3
• 0.23.0
• 0.22.1
• 0.21.0
• 0.20.0
• 0.19.0
• 0.18.1
• 0.17.0
• 0.16.0
• 0.15.0
• 0.14.0
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.2

Reference documentation and code samples for the Cloud Key Management Service (KMS) V1 API class Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal.

A SingleTenantHsmInstanceProposal represents a proposal to perform an operation on a SingleTenantHsmInstance.

Inherits

• Object

Extended By

• Google::Protobuf::MessageExts::ClassMethods

Includes

• Google::Protobuf::MessageExts

Methods

#add_quorum_member

def add_quorum_member() -> ::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal::AddQuorumMember

Returns

• (::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal::AddQuorumMember) — Add a quorum member to the SingleTenantHsmInstance. This will increase the total_approver_count by 1. The SingleTenantHsmInstance must be in the ACTIVE state to perform this operation.

  Note: The following fields are mutually exclusive: add_quorum_member, register_two_factor_auth_keys, disable_single_tenant_hsm_instance, enable_single_tenant_hsm_instance, delete_single_tenant_hsm_instance, remove_quorum_member, refresh_single_tenant_hsm_instance. If a field in that set is populated, all other fields in the set will automatically be cleared.

#add_quorum_member=

def add_quorum_member=(value) -> ::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal::AddQuorumMember

Parameter

• value (::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal::AddQuorumMember) — Add a quorum member to the SingleTenantHsmInstance. This will increase the total_approver_count by 1. The SingleTenantHsmInstance must be in the ACTIVE state to perform this operation.

  Note: The following fields are mutually exclusive: add_quorum_member, register_two_factor_auth_keys, disable_single_tenant_hsm_instance, enable_single_tenant_hsm_instance, delete_single_tenant_hsm_instance, remove_quorum_member, refresh_single_tenant_hsm_instance. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

• (::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal::AddQuorumMember) — Add a quorum member to the SingleTenantHsmInstance. This will increase the total_approver_count by 1. The SingleTenantHsmInstance must be in the ACTIVE state to perform this operation.

  Note: The following fields are mutually exclusive: add_quorum_member, register_two_factor_auth_keys, disable_single_tenant_hsm_instance, enable_single_tenant_hsm_instance, delete_single_tenant_hsm_instance, remove_quorum_member, refresh_single_tenant_hsm_instance. If a field in that set is populated, all other fields in the set will automatically be cleared.

#create_time

def create_time() -> ::Google::Protobuf::Timestamp

Returns

• (::Google::Protobuf::Timestamp) — Output only. The time at which the SingleTenantHsmInstanceProposal was created.

#delete_single_tenant_hsm_instance

def delete_single_tenant_hsm_instance() -> ::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal::DeleteSingleTenantHsmInstance

Returns

• (::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal::DeleteSingleTenantHsmInstance) — Delete the SingleTenantHsmInstance. Deleting a SingleTenantHsmInstance will make all CryptoKeys attached to the SingleTenantHsmInstance unusable. The SingleTenantHsmInstance must be in the DISABLED or PENDING_TWO_FACTOR_AUTH_REGISTRATION state to perform this operation.

  Note: The following fields are mutually exclusive: delete_single_tenant_hsm_instance, register_two_factor_auth_keys, disable_single_tenant_hsm_instance, enable_single_tenant_hsm_instance, add_quorum_member, remove_quorum_member, refresh_single_tenant_hsm_instance. If a field in that set is populated, all other fields in the set will automatically be cleared.

#delete_single_tenant_hsm_instance=

def delete_single_tenant_hsm_instance=(value) -> ::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal::DeleteSingleTenantHsmInstance

Parameter

• value (::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal::DeleteSingleTenantHsmInstance) — Delete the SingleTenantHsmInstance. Deleting a SingleTenantHsmInstance will make all CryptoKeys attached to the SingleTenantHsmInstance unusable. The SingleTenantHsmInstance must be in the DISABLED or PENDING_TWO_FACTOR_AUTH_REGISTRATION state to perform this operation.

  Note: The following fields are mutually exclusive: delete_single_tenant_hsm_instance, register_two_factor_auth_keys, disable_single_tenant_hsm_instance, enable_single_tenant_hsm_instance, add_quorum_member, remove_quorum_member, refresh_single_tenant_hsm_instance. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

• (::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal::DeleteSingleTenantHsmInstance) — Delete the SingleTenantHsmInstance. Deleting a SingleTenantHsmInstance will make all CryptoKeys attached to the SingleTenantHsmInstance unusable. The SingleTenantHsmInstance must be in the DISABLED or PENDING_TWO_FACTOR_AUTH_REGISTRATION state to perform this operation.

  Note: The following fields are mutually exclusive: delete_single_tenant_hsm_instance, register_two_factor_auth_keys, disable_single_tenant_hsm_instance, enable_single_tenant_hsm_instance, add_quorum_member, remove_quorum_member, refresh_single_tenant_hsm_instance. If a field in that set is populated, all other fields in the set will automatically be cleared.

#delete_time

def delete_time() -> ::Google::Protobuf::Timestamp

Returns

• (::Google::Protobuf::Timestamp) — Output only. The time at which the SingleTenantHsmInstanceProposal was deleted.

#disable_single_tenant_hsm_instance

def disable_single_tenant_hsm_instance() -> ::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal::DisableSingleTenantHsmInstance

Returns

• (::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal::DisableSingleTenantHsmInstance) — Disable the SingleTenantHsmInstance. The SingleTenantHsmInstance must be in the ACTIVE state to perform this operation.

  Note: The following fields are mutually exclusive: disable_single_tenant_hsm_instance, register_two_factor_auth_keys, enable_single_tenant_hsm_instance, delete_single_tenant_hsm_instance, add_quorum_member, remove_quorum_member, refresh_single_tenant_hsm_instance. If a field in that set is populated, all other fields in the set will automatically be cleared.

#disable_single_tenant_hsm_instance=

def disable_single_tenant_hsm_instance=(value) -> ::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal::DisableSingleTenantHsmInstance

Parameter

• value (::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal::DisableSingleTenantHsmInstance) — Disable the SingleTenantHsmInstance. The SingleTenantHsmInstance must be in the ACTIVE state to perform this operation.

  Note: The following fields are mutually exclusive: disable_single_tenant_hsm_instance, register_two_factor_auth_keys, enable_single_tenant_hsm_instance, delete_single_tenant_hsm_instance, add_quorum_member, remove_quorum_member, refresh_single_tenant_hsm_instance. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

• (::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal::DisableSingleTenantHsmInstance) — Disable the SingleTenantHsmInstance. The SingleTenantHsmInstance must be in the ACTIVE state to perform this operation.

  Note: The following fields are mutually exclusive: disable_single_tenant_hsm_instance, register_two_factor_auth_keys, enable_single_tenant_hsm_instance, delete_single_tenant_hsm_instance, add_quorum_member, remove_quorum_member, refresh_single_tenant_hsm_instance. If a field in that set is populated, all other fields in the set will automatically be cleared.

#enable_single_tenant_hsm_instance

def enable_single_tenant_hsm_instance() -> ::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal::EnableSingleTenantHsmInstance

Returns

• (::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal::EnableSingleTenantHsmInstance) — Enable the SingleTenantHsmInstance. The SingleTenantHsmInstance must be in the DISABLED state to perform this operation.

  Note: The following fields are mutually exclusive: enable_single_tenant_hsm_instance, register_two_factor_auth_keys, disable_single_tenant_hsm_instance, delete_single_tenant_hsm_instance, add_quorum_member, remove_quorum_member, refresh_single_tenant_hsm_instance. If a field in that set is populated, all other fields in the set will automatically be cleared.

#enable_single_tenant_hsm_instance=

def enable_single_tenant_hsm_instance=(value) -> ::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal::EnableSingleTenantHsmInstance

Parameter

• value (::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal::EnableSingleTenantHsmInstance) — Enable the SingleTenantHsmInstance. The SingleTenantHsmInstance must be in the DISABLED state to perform this operation.

  Note: The following fields are mutually exclusive: enable_single_tenant_hsm_instance, register_two_factor_auth_keys, disable_single_tenant_hsm_instance, delete_single_tenant_hsm_instance, add_quorum_member, remove_quorum_member, refresh_single_tenant_hsm_instance. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

• (::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal::EnableSingleTenantHsmInstance) — Enable the SingleTenantHsmInstance. The SingleTenantHsmInstance must be in the DISABLED state to perform this operation.

  Note: The following fields are mutually exclusive: enable_single_tenant_hsm_instance, register_two_factor_auth_keys, disable_single_tenant_hsm_instance, delete_single_tenant_hsm_instance, add_quorum_member, remove_quorum_member, refresh_single_tenant_hsm_instance. If a field in that set is populated, all other fields in the set will automatically be cleared.

#expire_time

def expire_time() -> ::Google::Protobuf::Timestamp

Returns

• (::Google::Protobuf::Timestamp) — The time at which the SingleTenantHsmInstanceProposal will expire if not approved and executed.

  Note: The following fields are mutually exclusive: expire_time, ttl. If a field in that set is populated, all other fields in the set will automatically be cleared.

#expire_time=

def expire_time=(value) -> ::Google::Protobuf::Timestamp

Parameter

• value (::Google::Protobuf::Timestamp) — The time at which the SingleTenantHsmInstanceProposal will expire if not approved and executed.

  Note: The following fields are mutually exclusive: expire_time, ttl. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

• (::Google::Protobuf::Timestamp) — The time at which the SingleTenantHsmInstanceProposal will expire if not approved and executed.

  Note: The following fields are mutually exclusive: expire_time, ttl. If a field in that set is populated, all other fields in the set will automatically be cleared.

#failure_reason

def failure_reason() -> ::String

Returns

• (::String) — Output only. The root cause of the most recent failure. Only present if state is [FAILED][SingleTenantHsmInstanceProposal.FAILED].

#name

def name() -> ::String

Returns

• (::String) — Identifier. The resource name for this SingleTenantHsmInstance in the format projects/*/locations/*/singleTenantHsmInstances/*/proposals/*.

#name=

def name=(value) -> ::String

Parameter

• value (::String) — Identifier. The resource name for this SingleTenantHsmInstance in the format projects/*/locations/*/singleTenantHsmInstances/*/proposals/*.

Returns

• (::String) — Identifier. The resource name for this SingleTenantHsmInstance in the format projects/*/locations/*/singleTenantHsmInstances/*/proposals/*.

#purge_time

def purge_time() -> ::Google::Protobuf::Timestamp

Returns

• (::Google::Protobuf::Timestamp) — Output only. The time at which the soft-deleted SingleTenantHsmInstanceProposal will be permanently purged. This field is only populated when the state is DELETED and will be set a time after expiration of the proposal, i.e. >= expire_time or (create_time + ttl).

#quorum_parameters

def quorum_parameters() -> ::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal::QuorumParameters

Returns

• (::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal::QuorumParameters) — Output only. The quorum approval parameters for the SingleTenantHsmInstanceProposal.

  Note: The following fields are mutually exclusive: quorum_parameters, required_action_quorum_parameters. If a field in that set is populated, all other fields in the set will automatically be cleared.

#refresh_single_tenant_hsm_instance

def refresh_single_tenant_hsm_instance() -> ::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal::RefreshSingleTenantHsmInstance

Returns

• (::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal::RefreshSingleTenantHsmInstance) — Refreshes the SingleTenantHsmInstance. This operation must be performed periodically to keep the SingleTenantHsmInstance active. This operation must be performed before unrefreshed_duration_until_disable has passed. The SingleTenantHsmInstance must be in the ACTIVE state to perform this operation.

  Note: The following fields are mutually exclusive: refresh_single_tenant_hsm_instance, register_two_factor_auth_keys, disable_single_tenant_hsm_instance, enable_single_tenant_hsm_instance, delete_single_tenant_hsm_instance, add_quorum_member, remove_quorum_member. If a field in that set is populated, all other fields in the set will automatically be cleared.

#refresh_single_tenant_hsm_instance=

def refresh_single_tenant_hsm_instance=(value) -> ::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal::RefreshSingleTenantHsmInstance

Parameter

• value (::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal::RefreshSingleTenantHsmInstance) — Refreshes the SingleTenantHsmInstance. This operation must be performed periodically to keep the SingleTenantHsmInstance active. This operation must be performed before unrefreshed_duration_until_disable has passed. The SingleTenantHsmInstance must be in the ACTIVE state to perform this operation.

  Note: The following fields are mutually exclusive: refresh_single_tenant_hsm_instance, register_two_factor_auth_keys, disable_single_tenant_hsm_instance, enable_single_tenant_hsm_instance, delete_single_tenant_hsm_instance, add_quorum_member, remove_quorum_member. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

• (::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal::RefreshSingleTenantHsmInstance) — Refreshes the SingleTenantHsmInstance. This operation must be performed periodically to keep the SingleTenantHsmInstance active. This operation must be performed before unrefreshed_duration_until_disable has passed. The SingleTenantHsmInstance must be in the ACTIVE state to perform this operation.

  Note: The following fields are mutually exclusive: refresh_single_tenant_hsm_instance, register_two_factor_auth_keys, disable_single_tenant_hsm_instance, enable_single_tenant_hsm_instance, delete_single_tenant_hsm_instance, add_quorum_member, remove_quorum_member. If a field in that set is populated, all other fields in the set will automatically be cleared.

#register_two_factor_auth_keys

def register_two_factor_auth_keys() -> ::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal::RegisterTwoFactorAuthKeys

Returns

• (::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal::RegisterTwoFactorAuthKeys) — Register 2FA keys for the SingleTenantHsmInstance. This operation requires all N Challenges to be signed by 2FA keys. The SingleTenantHsmInstance must be in the PENDING_TWO_FACTOR_AUTH_REGISTRATION state to perform this operation.

  Note: The following fields are mutually exclusive: register_two_factor_auth_keys, disable_single_tenant_hsm_instance, enable_single_tenant_hsm_instance, delete_single_tenant_hsm_instance, add_quorum_member, remove_quorum_member, refresh_single_tenant_hsm_instance. If a field in that set is populated, all other fields in the set will automatically be cleared.

#register_two_factor_auth_keys=

def register_two_factor_auth_keys=(value) -> ::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal::RegisterTwoFactorAuthKeys

Parameter

• value (::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal::RegisterTwoFactorAuthKeys) — Register 2FA keys for the SingleTenantHsmInstance. This operation requires all N Challenges to be signed by 2FA keys. The SingleTenantHsmInstance must be in the PENDING_TWO_FACTOR_AUTH_REGISTRATION state to perform this operation.

  Note: The following fields are mutually exclusive: register_two_factor_auth_keys, disable_single_tenant_hsm_instance, enable_single_tenant_hsm_instance, delete_single_tenant_hsm_instance, add_quorum_member, remove_quorum_member, refresh_single_tenant_hsm_instance. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

• (::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal::RegisterTwoFactorAuthKeys) — Register 2FA keys for the SingleTenantHsmInstance. This operation requires all N Challenges to be signed by 2FA keys. The SingleTenantHsmInstance must be in the PENDING_TWO_FACTOR_AUTH_REGISTRATION state to perform this operation.

  Note: The following fields are mutually exclusive: register_two_factor_auth_keys, disable_single_tenant_hsm_instance, enable_single_tenant_hsm_instance, delete_single_tenant_hsm_instance, add_quorum_member, remove_quorum_member, refresh_single_tenant_hsm_instance. If a field in that set is populated, all other fields in the set will automatically be cleared.

#remove_quorum_member

def remove_quorum_member() -> ::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal::RemoveQuorumMember

Returns

• (::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal::RemoveQuorumMember) — Remove a quorum member from the SingleTenantHsmInstance. This will reduce total_approver_count by 1. The SingleTenantHsmInstance must be in the ACTIVE state to perform this operation.

  Note: The following fields are mutually exclusive: remove_quorum_member, register_two_factor_auth_keys, disable_single_tenant_hsm_instance, enable_single_tenant_hsm_instance, delete_single_tenant_hsm_instance, add_quorum_member, refresh_single_tenant_hsm_instance. If a field in that set is populated, all other fields in the set will automatically be cleared.

#remove_quorum_member=

def remove_quorum_member=(value) -> ::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal::RemoveQuorumMember

Parameter

• value (::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal::RemoveQuorumMember) — Remove a quorum member from the SingleTenantHsmInstance. This will reduce total_approver_count by 1. The SingleTenantHsmInstance must be in the ACTIVE state to perform this operation.

  Note: The following fields are mutually exclusive: remove_quorum_member, register_two_factor_auth_keys, disable_single_tenant_hsm_instance, enable_single_tenant_hsm_instance, delete_single_tenant_hsm_instance, add_quorum_member, refresh_single_tenant_hsm_instance. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

• (::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal::RemoveQuorumMember) — Remove a quorum member from the SingleTenantHsmInstance. This will reduce total_approver_count by 1. The SingleTenantHsmInstance must be in the ACTIVE state to perform this operation.

  Note: The following fields are mutually exclusive: remove_quorum_member, register_two_factor_auth_keys, disable_single_tenant_hsm_instance, enable_single_tenant_hsm_instance, delete_single_tenant_hsm_instance, add_quorum_member, refresh_single_tenant_hsm_instance. If a field in that set is populated, all other fields in the set will automatically be cleared.

#required_action_quorum_parameters

def required_action_quorum_parameters() -> ::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal::RequiredActionQuorumParameters

Returns

• (::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal::RequiredActionQuorumParameters) — Output only. Parameters for an approval of a SingleTenantHsmInstanceProposal that has both required challenges and a quorum.

  Note: The following fields are mutually exclusive: required_action_quorum_parameters, quorum_parameters. If a field in that set is populated, all other fields in the set will automatically be cleared.

#state

def state() -> ::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal::State

Returns

• (::Google::Cloud::Kms::V1::SingleTenantHsmInstanceProposal::State) — Output only. The state of the SingleTenantHsmInstanceProposal.

#ttl

def ttl() -> ::Google::Protobuf::Duration

Returns

• (::Google::Protobuf::Duration) — Input only. The TTL for the SingleTenantHsmInstanceProposal. Proposals will expire after this duration.

  Note: The following fields are mutually exclusive: ttl, expire_time. If a field in that set is populated, all other fields in the set will automatically be cleared.

#ttl=

def ttl=(value) -> ::Google::Protobuf::Duration

Parameter

• value (::Google::Protobuf::Duration) — Input only. The TTL for the SingleTenantHsmInstanceProposal. Proposals will expire after this duration.

  Note: The following fields are mutually exclusive: ttl, expire_time. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

• (::Google::Protobuf::Duration) — Input only. The TTL for the SingleTenantHsmInstanceProposal. Proposals will expire after this duration.

  Note: The following fields are mutually exclusive: ttl, expire_time. If a field in that set is populated, all other fields in the set will automatically be cleared.