single_tenant_hsm_instances

Creates, updates, deletes, gets or lists a single_tenant_hsm_instances resource.

Overview

Name	single_tenant_hsm_instances
Type	Resource
Id	google.cloudkms.single_tenant_hsm_instances

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
name	string	Identifier. The resource name for this SingleTenantHsmInstance in the format projects/*/locations/*/singleTenantHsmInstances/*.
createTime	string (google-datetime)	Output only. The time at which the SingleTenantHsmInstance was created.
deleteTime	string (google-datetime)	Output only. The time at which the SingleTenantHsmInstance was deleted.
disableTime	string (google-datetime)	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.
keyPortabilityEnabled	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.
quorumAuth	object	Required. The quorum auth configuration for the SingleTenantHsmInstance. (id: QuorumAuth)
state	string	Output only. The state of the SingleTenantHsmInstance. (STATE_UNSPECIFIED, CREATING, PENDING_TWO_FACTOR_AUTH_REGISTRATION, ACTIVE, DISABLING, DISABLED, DELETING, DELETED, FAILED)
unrefreshedDurationUntilDisable	string (google-duration)	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.

list

Name	Datatype	Description
name	string	Identifier. The resource name for this SingleTenantHsmInstance in the format projects/*/locations/*/singleTenantHsmInstances/*.
createTime	string (google-datetime)	Output only. The time at which the SingleTenantHsmInstance was created.
deleteTime	string (google-datetime)	Output only. The time at which the SingleTenantHsmInstance was deleted.
disableTime	string (google-datetime)	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.
keyPortabilityEnabled	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.
quorumAuth	object	Required. The quorum auth configuration for the SingleTenantHsmInstance. (id: QuorumAuth)
state	string	Output only. The state of the SingleTenantHsmInstance. (STATE_UNSPECIFIED, CREATING, PENDING_TWO_FACTOR_AUTH_REGISTRATION, ACTIVE, DISABLING, DISABLED, DELETING, DELETED, FAILED)
unrefreshedDurationUntilDisable	string (google-duration)	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.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, singleTenantHsmInstancesId		Returns metadata for a given SingleTenantHsmInstance.
list	select	projectsId, locationsId	pageSize, pageToken, showDeleted, filter, orderBy	Lists SingleTenantHsmInstances.
create	insert	projectsId, locationsId	singleTenantHsmInstanceId	Creates a new SingleTenantHsmInstance in a given Project and Location. User must create a RegisterTwoFactorAuthKeys proposal with this single-tenant HSM instance to finish setup of the instance.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
locationsId	string
projectsId	string
singleTenantHsmInstancesId	string
filter	string
orderBy	string
pageSize	integer (int32)
pageToken	string
showDeleted	boolean
singleTenantHsmInstanceId	string

SELECT examples

get

Returns metadata for a given SingleTenantHsmInstance.

SELECT
name,
createTime,
deleteTime,
disableTime,
keyPortabilityEnabled,
quorumAuth,
state,
unrefreshedDurationUntilDisable
FROM google.cloudkms.single_tenant_hsm_instances
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND singleTenantHsmInstancesId = '{{ singleTenantHsmInstancesId }}' -- required
;

list

Lists SingleTenantHsmInstances.

SELECT
name,
createTime,
deleteTime,
disableTime,
keyPortabilityEnabled,
quorumAuth,
state,
unrefreshedDurationUntilDisable
FROM google.cloudkms.single_tenant_hsm_instances
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND showDeleted = '{{ showDeleted }}'
AND filter = '{{ filter }}'
AND orderBy = '{{ orderBy }}'
;

INSERT examples

create

Creates a new SingleTenantHsmInstance in a given Project and Location. User must create a RegisterTwoFactorAuthKeys proposal with this single-tenant HSM instance to finish setup of the instance.

INSERT INTO google.cloudkms.single_tenant_hsm_instances (
data__name,
data__quorumAuth,
data__keyPortabilityEnabled,
projectsId,
locationsId,
singleTenantHsmInstanceId
)
SELECT 
'{{ name }}',
'{{ quorumAuth }}',
{{ keyPortabilityEnabled }},
'{{ projectsId }}',
'{{ locationsId }}',
'{{ singleTenantHsmInstanceId }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: single_tenant_hsm_instances
props:
  - name: projectsId
    value: "{{ projectsId }}"
    description: Required parameter for the single_tenant_hsm_instances resource.
  - name: locationsId
    value: "{{ locationsId }}"
    description: Required parameter for the single_tenant_hsm_instances resource.
  - name: name
    value: "{{ name }}"
    description: |
      Identifier. The resource name for this SingleTenantHsmInstance in the format `projects/*/locations/*/singleTenantHsmInstances/*`.
  - name: quorumAuth
    description: |
      Required. The quorum auth configuration for the SingleTenantHsmInstance.
    value:
      requiredApproverCount: {{ requiredApproverCount }}
      totalApproverCount: {{ totalApproverCount }}
      twoFactorPublicKeyPems:
        - "{{ twoFactorPublicKeyPems }}"
  - name: keyPortabilityEnabled
    value: {{ keyPortabilityEnabled }}
    description: |
      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.
  - name: singleTenantHsmInstanceId
    value: "{{ singleTenantHsmInstanceId }}"