close()

Close httplib2 connections.

create(parent, body=None, singleTenantHsmInstanceId=None, x__xgafv=None)

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.

Args:
parent: string, Required. The resource name of the location associated with the SingleTenantHsmInstance, in the format `projects/*/locations/*`. (required)
body: object, The request body.
The object takes the form of:

{ # A SingleTenantHsmInstance represents a single-tenant HSM instance. It can be used for creating CryptoKeys with a ProtectionLevel of HSM_SINGLE_TENANT, as well as performing cryptographic operations using keys created within the SingleTenantHsmInstance.
"createTime": "A String", # Output only. The time at which the SingleTenantHsmInstance was created.
"deleteTime": "A String", # Output only. The time at which the SingleTenantHsmInstance was deleted.
"disableTime": "A String", # 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.
"name": "A String", # Identifier. The resource name for this SingleTenantHsmInstance in the format `projects/*/locations/*/singleTenantHsmInstances/*`.
"quorumAuth": { # Configuration for M of N quorum auth. # Required. The quorum auth configuration for the SingleTenantHsmInstance.
"requiredApproverCount": 42, # Output only. The required numbers of approvers. The M value used for M of N quorum auth. Must be greater than or equal to 2 and less than or equal to total_approver_count - 1.
"totalApproverCount": 42, # Required. The total number of approvers. This is the N value used for M of N quorum auth. Must be greater than or equal to 3 and less than or equal to 16.
"twoFactorPublicKeyPems": [ # Output only. The public keys associated with the 2FA keys for M of N quorum auth.
"A String",
],
},
"state": "A String", # Output only. The state of the SingleTenantHsmInstance.
"unrefreshedDurationUntilDisable": "A String", # 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.
}

singleTenantHsmInstanceId: string, Optional. It must be unique within a location and match the regular expression `[a-zA-Z0-9_-]{1,63}`.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}

get(name, x__xgafv=None)

Returns metadata for a given SingleTenantHsmInstance.

Args:
name: string, Required. The name of the SingleTenantHsmInstance to get. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # A SingleTenantHsmInstance represents a single-tenant HSM instance. It can be used for creating CryptoKeys with a ProtectionLevel of HSM_SINGLE_TENANT, as well as performing cryptographic operations using keys created within the SingleTenantHsmInstance.
"createTime": "A String", # Output only. The time at which the SingleTenantHsmInstance was created.
"deleteTime": "A String", # Output only. The time at which the SingleTenantHsmInstance was deleted.
"disableTime": "A String", # 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.
"name": "A String", # Identifier. The resource name for this SingleTenantHsmInstance in the format `projects/*/locations/*/singleTenantHsmInstances/*`.
"quorumAuth": { # Configuration for M of N quorum auth. # Required. The quorum auth configuration for the SingleTenantHsmInstance.
"requiredApproverCount": 42, # Output only. The required numbers of approvers. The M value used for M of N quorum auth. Must be greater than or equal to 2 and less than or equal to total_approver_count - 1.
"totalApproverCount": 42, # Required. The total number of approvers. This is the N value used for M of N quorum auth. Must be greater than or equal to 3 and less than or equal to 16.
"twoFactorPublicKeyPems": [ # Output only. The public keys associated with the 2FA keys for M of N quorum auth.
"A String",
],
},
"state": "A String", # Output only. The state of the SingleTenantHsmInstance.
"unrefreshedDurationUntilDisable": "A String", # 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.
}

list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, showDeleted=None, x__xgafv=None)

Lists SingleTenantHsmInstances.

Args:
parent: string, Required. The resource name of the location associated with the SingleTenantHsmInstances to list, in the format `projects/*/locations/*`. (required)
filter: string, Optional. Only include resources that match the filter in the response. For more information, see [Sorting and filtering list results](https://cloud.google.com/kms/docs/sorting-and-filtering).
orderBy: string, Optional. Specify how the results should be sorted. If not specified, the results will be sorted in the default order. For more information, see [Sorting and filtering list results](https://cloud.google.com/kms/docs/sorting-and-filtering).
pageSize: integer, Optional. Optional limit on the number of SingleTenantHsmInstances to include in the response. Further SingleTenantHsmInstances can subsequently be obtained by including the ListSingleTenantHsmInstancesResponse.next_page_token in a subsequent request. If unspecified, the server will pick an appropriate default.
pageToken: string, Optional. Optional pagination token, returned earlier via ListSingleTenantHsmInstancesResponse.next_page_token.
showDeleted: boolean, Optional. If set to true, HsmManagement.ListSingleTenantHsmInstances will also return SingleTenantHsmInstances in DELETED state.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # Response message for HsmManagement.ListSingleTenantHsmInstances.
"nextPageToken": "A String", # A token to retrieve next page of results. Pass this value in ListSingleTenantHsmInstancesRequest.page_token to retrieve the next page of results.
"singleTenantHsmInstances": [ # The list of SingleTenantHsmInstances.
{ # A SingleTenantHsmInstance represents a single-tenant HSM instance. It can be used for creating CryptoKeys with a ProtectionLevel of HSM_SINGLE_TENANT, as well as performing cryptographic operations using keys created within the SingleTenantHsmInstance.
"createTime": "A String", # Output only. The time at which the SingleTenantHsmInstance was created.
"deleteTime": "A String", # Output only. The time at which the SingleTenantHsmInstance was deleted.
"disableTime": "A String", # 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.
"name": "A String", # Identifier. The resource name for this SingleTenantHsmInstance in the format `projects/*/locations/*/singleTenantHsmInstances/*`.
"quorumAuth": { # Configuration for M of N quorum auth. # Required. The quorum auth configuration for the SingleTenantHsmInstance.
"requiredApproverCount": 42, # Output only. The required numbers of approvers. The M value used for M of N quorum auth. Must be greater than or equal to 2 and less than or equal to total_approver_count - 1.
"totalApproverCount": 42, # Required. The total number of approvers. This is the N value used for M of N quorum auth. Must be greater than or equal to 3 and less than or equal to 16.
"twoFactorPublicKeyPems": [ # Output only. The public keys associated with the 2FA keys for M of N quorum auth.
"A String",
],
},
"state": "A String", # Output only. The state of the SingleTenantHsmInstance.
"unrefreshedDurationUntilDisable": "A String", # 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.
},
],
"totalSize": 42, # The total number of SingleTenantHsmInstances that matched the query. This field is not populated if ListSingleTenantHsmInstancesRequest.filter is applied.
}

list_next()

Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call 'execute()' on to request the next
          page. Returns None if there are no more items in the collection.

Cloud Key Management Service (KMS) API . projects . locations . singleTenantHsmInstances

Instance Methods

Method Details