Class SingleTenantHsmInstanceProposal (3.10.0)

Version latest

• 3.10.0 (latest)
• 3.9.0
• 3.8.0
• 3.7.0
• 3.6.0
• 3.5.1
• 3.4.0
• 3.3.1
• 3.2.2
• 3.1.1
• 3.0.0
• 2.24.2
• 2.23.0
• 2.22.0
• 2.21.4
• 2.20.0
• 2.19.2
• 2.18.0
• 2.17.0
• 2.16.1
• 2.15.0
• 2.14.1
• 2.13.0
• 2.12.3
• 2.11.2
• 2.10.1
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.1
• 2.5.0
• 2.4.3
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.1
• 1.4.2
• 1.3.0
• 1.2.1
• 1.1.0

SingleTenantHsmInstanceProposal(
    mapping=None, *, ignore_unknown_fields=False, **kwargs
)

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

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Attributes
Name	Description
name	str Identifier. The resource name for this SingleTenantHsmInstance in the format projects/*/locations/*/singleTenantHsmInstances/*/proposals/*.
create_time	google.protobuf.timestamp_pb2.Timestamp Output only. The time at which the SingleTenantHsmInstanceProposal was created.
state	google.cloud.kms_v1.types.SingleTenantHsmInstanceProposal.State Output only. The state of the SingleTenantHsmInstanceProposal.
failure_reason	str Output only. The root cause of the most recent failure. Only present if state is FAILED][SingleTenantHsmInstanceProposal.FAILED].
quorum_parameters	google.cloud.kms_v1.types.SingleTenantHsmInstanceProposal.QuorumParameters Output only. The quorum approval parameters for the SingleTenantHsmInstanceProposal. This field is a member of oneof_ approval_parameters.
required_action_quorum_parameters	google.cloud.kms_v1.types.SingleTenantHsmInstanceProposal.RequiredActionQuorumParameters Output only. Parameters for an approval of a SingleTenantHsmInstanceProposal that has both required challenges and a quorum. This field is a member of oneof_ approval_parameters.
expire_time	google.protobuf.timestamp_pb2.Timestamp The time at which the SingleTenantHsmInstanceProposal will expire if not approved and executed. This field is a member of oneof_ expiration.
ttl	google.protobuf.duration_pb2.Duration Input only. The TTL for the SingleTenantHsmInstanceProposal. Proposals will expire after this duration. This field is a member of oneof_ expiration.
delete_time	google.protobuf.timestamp_pb2.Timestamp Output only. The time at which the SingleTenantHsmInstanceProposal was deleted.
purge_time	google.protobuf.timestamp_pb2.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).
register_two_factor_auth_keys	google.cloud.kms_v1.types.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. This field is a member of oneof_ operation.
disable_single_tenant_hsm_instance	google.cloud.kms_v1.types.SingleTenantHsmInstanceProposal.DisableSingleTenantHsmInstance Disable the SingleTenantHsmInstance. The SingleTenantHsmInstance must be in the ACTIVE state to perform this operation. This field is a member of oneof_ operation.
enable_single_tenant_hsm_instance	google.cloud.kms_v1.types.SingleTenantHsmInstanceProposal.EnableSingleTenantHsmInstance Enable the SingleTenantHsmInstance. The SingleTenantHsmInstance must be in the DISABLED state to perform this operation. This field is a member of oneof_ operation.
delete_single_tenant_hsm_instance	google.cloud.kms_v1.types.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. This field is a member of oneof_ operation.
add_quorum_member	google.cloud.kms_v1.types.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. This field is a member of oneof_ operation.
remove_quorum_member	google.cloud.kms_v1.types.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. This field is a member of oneof_ operation.
refresh_single_tenant_hsm_instance	google.cloud.kms_v1.types.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. This field is a member of oneof_ operation.

Classes

AddQuorumMember

AddQuorumMember(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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.

DeleteSingleTenantHsmInstance

DeleteSingleTenantHsmInstance(
    mapping=None, *, ignore_unknown_fields=False, **kwargs
)

Delete the SingleTenantHsmInstance. Deleting a SingleTenantHsmInstance will make all CryptoKeys attached to the SingleTenantHsmInstance unusable. The SingleTenantHsmInstance must not be in the DELETING or DELETED state to perform this operation.

DisableSingleTenantHsmInstance

DisableSingleTenantHsmInstance(
    mapping=None, *, ignore_unknown_fields=False, **kwargs
)

Disable the SingleTenantHsmInstance. The SingleTenantHsmInstance must be in the ACTIVE state to perform this operation.

EnableSingleTenantHsmInstance

EnableSingleTenantHsmInstance(
    mapping=None, *, ignore_unknown_fields=False, **kwargs
)

Enable the SingleTenantHsmInstance. The SingleTenantHsmInstance must be in the DISABLED state to perform this operation.

QuorumParameters

QuorumParameters(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Parameters of quorum approval for the SingleTenantHsmInstanceProposal.

RefreshSingleTenantHsmInstance

RefreshSingleTenantHsmInstance(
    mapping=None, *, ignore_unknown_fields=False, **kwargs
)

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.

RegisterTwoFactorAuthKeys

RegisterTwoFactorAuthKeys(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Register 2FA keys for the SingleTenantHsmInstance. This operation requires all Challenges to be signed by 2FA keys. The SingleTenantHsmInstance must be in the PENDING_TWO_FACTOR_AUTH_REGISTRATION state to perform this operation.

RemoveQuorumMember

RemoveQuorumMember(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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.

RequiredActionQuorumParameters

RequiredActionQuorumParameters(
    mapping=None, *, ignore_unknown_fields=False, **kwargs
)

Parameters for an approval that has both required challenges and a quorum.

State

State(value)

The set of states of a SingleTenantHsmInstanceProposal.