Cloud KMS V1 Client - Class State (2.6.0)

Reference documentation and code samples for the Cloud KMS V1 Client class State.

The set of states of a SingleTenantHsmInstance.

Protobuf type google.cloud.kms.v1.SingleTenantHsmInstance.State

Namespace

Google \ Cloud \ Kms \ V1 \ SingleTenantHsmInstance

Methods

static::name

Parameter
Name Description
value mixed

static::value

Parameter
Name Description
name mixed

Constants

STATE_UNSPECIFIED

Value: 0

Not specified.

Generated from protobuf enum STATE_UNSPECIFIED = 0;

CREATING

Value: 1

The SingleTenantHsmInstance is being created.

Generated from protobuf enum CREATING = 1;

PENDING_TWO_FACTOR_AUTH_REGISTRATION

Value: 2

The SingleTenantHsmInstance is waiting for 2FA keys to be registered. This can be done by calling CreateSingleTenantHsmInstanceProposal with the RegisterTwoFactorAuthKeys operation.

Generated from protobuf enum PENDING_TWO_FACTOR_AUTH_REGISTRATION = 2;

ACTIVE

Value: 3

The SingleTenantHsmInstance is ready to use. A SingleTenantHsmInstance must be in the ACTIVE state for all CryptoKeys created within the SingleTenantHsmInstance to be usable.

Generated from protobuf enum ACTIVE = 3;

DISABLING

Value: 4

The SingleTenantHsmInstance is being disabled.

Generated from protobuf enum DISABLING = 4;

DISABLED

Value: 5

The SingleTenantHsmInstance is disabled.

Generated from protobuf enum DISABLED = 5;

DELETING

Value: 6

The SingleTenantHsmInstance is being deleted. Requests to the instance will be rejected in this state.

Generated from protobuf enum DELETING = 6;

DELETED

Value: 7

The SingleTenantHsmInstance has been deleted.

Generated from protobuf enum DELETED = 7;

FAILED

Value: 8

The SingleTenantHsmInstance has failed and can not be recovered or used.

Generated from protobuf enum FAILED = 8;