KmsHsmClusterClientCompositeOperations

class oci.key_management.KmsHsmClusterClientCompositeOperations(client, **kwargs)

This class provides a wrapper around KmsHsmClusterClient and offers convenience methods for operations that would otherwise need to be chained together. For example, instead of performing an action on a resource (e.g. launching an instance, creating a load balancer) and then using a waiter to wait for the resource to enter a given state, you can call a single method in this class to accomplish the same functionality

Methods

__init__(client, **kwargs)	Creates a new KmsHsmClusterClientCompositeOperations object
cancel_hsm_cluster_deletion_and_wait_for_state(…)	Calls cancel_hsm_cluster_deletion() and waits for the HsmCluster acted upon to enter the given state(s).
create_hsm_cluster_and_wait_for_state(…[, …])	Calls create_hsm_cluster() and waits for the HsmCluster acted upon to enter the given state(s).
schedule_hsm_cluster_deletion_and_wait_for_state(…)	Calls schedule_hsm_cluster_deletion() and waits for the HsmCluster acted upon to enter the given state(s).
update_hsm_cluster_and_wait_for_state(…[, …])	Calls update_hsm_cluster() and waits for the HsmCluster acted upon to enter the given state(s).

__init__(client, **kwargs)

Creates a new KmsHsmClusterClientCompositeOperations object

Parameters:client (KmsHsmClusterClient) – The service client which will be wrapped by this object

cancel_hsm_cluster_deletion_and_wait_for_state(hsm_cluster_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls cancel_hsm_cluster_deletion() and waits for the HsmCluster acted upon to enter the given state(s).

Parameters:

• hsm_cluster_id (str) – (required) The OCID of the HSM Cluster. This is a unique identifier assigned to each hsmCluster.
• wait_for_states (list[str]) – An array of states to wait on. These should be valid values for lifecycle_state
• operation_kwargs (dict) – A dictionary of keyword arguments to pass to cancel_hsm_cluster_deletion()
• waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait

create_hsm_cluster_and_wait_for_state(create_hsm_cluster_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls create_hsm_cluster() and waits for the HsmCluster acted upon to enter the given state(s).

Parameters:

• create_hsm_cluster_details (oci.key_management.models.CreateHsmClusterDetails) – (required) Details for the new HsmCluster resource
• wait_for_states (list[str]) – An array of states to wait on. These should be valid values for lifecycle_state
• operation_kwargs (dict) – A dictionary of keyword arguments to pass to create_hsm_cluster()
• waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait

schedule_hsm_cluster_deletion_and_wait_for_state(hsm_cluster_id, schedule_hsm_cluster_deletion_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls schedule_hsm_cluster_deletion() and waits for the HsmCluster acted upon to enter the given state(s).

Parameters:

• hsm_cluster_id (str) – (required) The OCID of the HSM Cluster. This is a unique identifier assigned to each hsmCluster.
• schedule_hsm_cluster_deletion_details (oci.key_management.models.ScheduleHsmClusterDeletionDetails) – (required) Details of ScheduleHsmClusterDeletionDetails
• wait_for_states (list[str]) – An array of states to wait on. These should be valid values for lifecycle_state
• operation_kwargs (dict) – A dictionary of keyword arguments to pass to schedule_hsm_cluster_deletion()
• waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait

update_hsm_cluster_and_wait_for_state(hsm_cluster_id, update_hsm_cluster_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls update_hsm_cluster() and waits for the HsmCluster acted upon to enter the given state(s).

Parameters:

• hsm_cluster_id (str) – (required) The OCID of the HSM Cluster. This is a unique identifier assigned to each hsmCluster.
• update_hsm_cluster_details (oci.key_management.models.UpdateHsmClusterDetails) – (required) Details of the HsmCluster Resource
• wait_for_states (list[str]) – An array of states to wait on. These should be valid values for lifecycle_state
• operation_kwargs (dict) – A dictionary of keyword arguments to pass to update_hsm_cluster()
• waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_interval_seconds as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait