Class: OCI::KeyManagement::KmsHsmClusterClient

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/key_management/kms_hsm_cluster_client.rb

Overview

Use the Key Management API to manage vaults and keys. For more information, see Managing Vaults and Managing Keys.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) ⇒ KmsHsmClusterClient

Creates a new KmsHsmClusterClient. Notes: If a config is not specified, then the global OCI.config will be used.

This client is not thread-safe

Either a region or an endpoint must be specified. If an endpoint is specified, it will be used instead of the region. A region may be specified in the config or via or the region parameter. If specified in both, then the region parameter will be used.

Parameters:

  • config (Config) (defaults to: nil) —

    A Config object.

  • region (String) (defaults to: nil) —

    A region used to determine the service endpoint. This will usually correspond to a value in Regions::REGION_ENUM, but may be an arbitrary string.

  • endpoint (String) (defaults to: nil) —

    The fully qualified endpoint URL

  • signer (OCI::BaseSigner) (defaults to: nil) —

    A signer implementation which can be used by this client. If this is not provided then a signer will be constructed via the provided config. One use case of this parameter is instance principals authentication, so that the instance principals signer can be provided to the client

  • proxy_settings (OCI::ApiClientProxySettings) (defaults to: nil) —

    If your environment requires you to use a proxy server for outgoing HTTP requests the details for the proxy can be provided in this parameter

  • retry_config (OCI::Retry::RetryConfig) (defaults to: nil) —

    The retry configuration for this service client. This represents the default retry configuration to apply across all operations. This can be overridden on a per-operation basis. The default retry configuration value is nil, which means that an operation will not perform any retries



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/oci/key_management/kms_hsm_cluster_client.rb', line 55

def initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil)
  # If the signer is an InstancePrincipalsSecurityTokenSigner or SecurityTokenSigner and no config was supplied (they are self-sufficient signers)
  # then create a dummy config to pass to the ApiClient constructor. If customers wish to create a client which uses instance principals
  # and has config (either populated programmatically or loaded from a file), they must construct that config themselves and then
  # pass it to this constructor.
  #
  # If there is no signer (or the signer is not an instance principals signer) and no config was supplied, this is not valid
  # so try and load the config from the default file.
  config = OCI::Config.validate_and_build_config_with_signer(config, signer)

  signer = OCI::Signer.config_file_auth_builder(config) if signer.nil?

  @api_client = OCI::ApiClient.new(config, signer, proxy_settings: proxy_settings)
  @retry_config = retry_config

  if endpoint
    @endpoint = endpoint + '/'
  else
    region ||= config.region
    region ||= signer.region if signer.respond_to?(:region)
    self.region = region
  end
  logger.info "KmsHsmClusterClient endpoint set to '#{@endpoint}'." if logger
end

Instance Attribute Details

#api_client ⇒ OCI::ApiClient (readonly)

Client used to make HTTP requests.

Returns:



15
16
17
 
# File 'lib/oci/key_management/kms_hsm_cluster_client.rb', line 15

def api_client
  @api_client
end

#endpoint ⇒ String (readonly)

Fully qualified endpoint URL

Returns:

  • (String) 


19
20
21
 
# File 'lib/oci/key_management/kms_hsm_cluster_client.rb', line 19

def endpoint
  @endpoint
end

#region ⇒ String

The region, which will usually correspond to a value in Regions::REGION_ENUM.

Returns:

  • (String) 


29
30
31
 
# File 'lib/oci/key_management/kms_hsm_cluster_client.rb', line 29

def region
  @region
end

#retry_config ⇒ OCI::Retry::RetryConfig (readonly)

The default retry configuration to apply to all operations in this service client. This can be overridden on a per-operation basis. The default retry configuration value is nil, which means that an operation will not perform any retries

Returns:



25
26
27
 
# File 'lib/oci/key_management/kms_hsm_cluster_client.rb', line 25

def retry_config
  @retry_config
end

Instance Method Details

#cancel_hsm_cluster_deletion(hsm_cluster_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use cancel_hsm_cluster_deletion API.

Cancels deletion of specified HSM Cluster, restores it and associated HSM partitions to pre-deletion states.

Parameters:

  • hsm_cluster_id (String) —

    The OCID of the HSM Cluster. This is a unique identifier assigned to each hsmCluster.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique identifier for the request. If provided, the returned request ID will include this value. Otherwise, a random request ID will be generated by the service.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (e.g., if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).

Returns:



127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/oci/key_management/kms_hsm_cluster_client.rb', line 127

def cancel_hsm_cluster_deletion(hsm_cluster_id, opts = {})
  logger.debug 'Calling operation KmsHsmClusterClient#cancel_hsm_cluster_deletion.' if logger

  raise "Missing the required parameter 'hsm_cluster_id' when calling cancel_hsm_cluster_deletion." if hsm_cluster_id.nil?
  raise "Parameter value for 'hsm_cluster_id' must not be blank" if OCI::Internal::Util.blank_string?(hsm_cluster_id)

  path = '/20180608/hsmClusters/{hsmClusterId}/actions/cancelDeletion'.sub('{hsmClusterId}', hsm_cluster_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'KmsHsmClusterClient#cancel_hsm_cluster_deletion') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::KeyManagement::Models::HsmCluster'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#change_hsm_cluster_compartment(hsm_cluster_id, change_hsm_cluster_compartment_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use change_hsm_cluster_compartment API.

Moves a HSM Cluster resource to a different compartment within the same tenancy.

Parameters:

  • hsm_cluster_id (String) —

    The OCID of the HSM Cluster. This is a unique identifier assigned to each hsmCluster.

  • change_hsm_cluster_compartment_details (OCI::KeyManagement::Models::ChangeHsmClusterCompartmentDetails) —

    Details of change HSM Cluster compartment.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique identifier for the request. If provided, the returned request ID will include this value. Otherwise, a random request ID will be generated by the service.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (e.g., if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).

Returns:

  • (Response) —

    A Response object with data of type nil



202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
 
# File 'lib/oci/key_management/kms_hsm_cluster_client.rb', line 202

def change_hsm_cluster_compartment(hsm_cluster_id, change_hsm_cluster_compartment_details, opts = {})
  logger.debug 'Calling operation KmsHsmClusterClient#change_hsm_cluster_compartment.' if logger

  raise "Missing the required parameter 'hsm_cluster_id' when calling change_hsm_cluster_compartment." if hsm_cluster_id.nil?
  raise "Missing the required parameter 'change_hsm_cluster_compartment_details' when calling change_hsm_cluster_compartment." if change_hsm_cluster_compartment_details.nil?
  raise "Parameter value for 'hsm_cluster_id' must not be blank" if OCI::Internal::Util.blank_string?(hsm_cluster_id)

  path = '/20180608/hsmClusters/{hsmClusterId}/actions/changeCompartment'.sub('{hsmClusterId}', hsm_cluster_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(change_hsm_cluster_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'KmsHsmClusterClient#change_hsm_cluster_compartment') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_hsm_cluster(create_hsm_cluster_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use create_hsm_cluster API.

Creates a new HSM cluster resource.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request. If provided, the returned request ID will include this value. Otherwise, a random request ID will be generated by the service.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (e.g., if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).

Returns:



270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
 
# File 'lib/oci/key_management/kms_hsm_cluster_client.rb', line 270

def create_hsm_cluster(create_hsm_cluster_details, opts = {})
  logger.debug 'Calling operation KmsHsmClusterClient#create_hsm_cluster.' if logger

  raise "Missing the required parameter 'create_hsm_cluster_details' when calling create_hsm_cluster." if create_hsm_cluster_details.nil?

  path = '/20180608/hsmClusters'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(create_hsm_cluster_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'KmsHsmClusterClient#create_hsm_cluster') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::KeyManagement::Models::HsmCluster'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#disable_audit_mgmt_logging(hsm_cluster_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use disable_audit_mgmt_logging API.

Disables management audit logging for the given HSM Cluster resource. This requires the Crypto Officer (CO) password. This operation is idempotent: if audit logging is already disabled, the call is a no-op and returns success.

Parameters:

  • hsm_cluster_id (String) —

    The OCID of the HSM Cluster. This is a unique identifier assigned to each hsmCluster.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique identifier for the request. If provided, the returned request ID will include this value. Otherwise, a random request ID will be generated by the service.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (e.g., if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).

Returns:

  • (Response) —

    A Response object with data of type nil



342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
 
# File 'lib/oci/key_management/kms_hsm_cluster_client.rb', line 342

def disable_audit_mgmt_logging(hsm_cluster_id, opts = {})
  logger.debug 'Calling operation KmsHsmClusterClient#disable_audit_mgmt_logging.' if logger

  raise "Missing the required parameter 'hsm_cluster_id' when calling disable_audit_mgmt_logging." if hsm_cluster_id.nil?
  raise "Parameter value for 'hsm_cluster_id' must not be blank" if OCI::Internal::Util.blank_string?(hsm_cluster_id)

  path = '/20180608/hsmClusters/{hsmClusterId}/actions/disableAuditMgmtLogging'.sub('{hsmClusterId}', hsm_cluster_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'KmsHsmClusterClient#disable_audit_mgmt_logging') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#download_certificate_signing_request(hsm_cluster_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use download_certificate_signing_request API.

Retrieves the certificate signing request for the designated HSM Cluster resource.

Parameters:

  • hsm_cluster_id (String) —

    The OCID of the HSM Cluster. This is a unique identifier assigned to each hsmCluster.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request. If provided, the returned request ID will include this value. Otherwise, a random request ID will be generated by the service.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (e.g., if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:

  • (Response) —

    A Response object with data of type String



415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
 
# File 'lib/oci/key_management/kms_hsm_cluster_client.rb', line 415

def download_certificate_signing_request(hsm_cluster_id, opts = {})
  logger.debug 'Calling operation KmsHsmClusterClient#download_certificate_signing_request.' if logger

  raise "Missing the required parameter 'hsm_cluster_id' when calling download_certificate_signing_request." if hsm_cluster_id.nil?
  raise "Parameter value for 'hsm_cluster_id' must not be blank" if OCI::Internal::Util.blank_string?(hsm_cluster_id)

  path = '/20180608/hsmClusters/{hsmClusterId}/actions/downloadCertificateSigningRequest'.sub('{hsmClusterId}', hsm_cluster_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'KmsHsmClusterClient#download_certificate_signing_request') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'String'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#enable_audit_mgmt_logging(hsm_cluster_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use enable_audit_mgmt_logging API.

Validates that the Dynamic Group and bucket policy supplied during EnableAuditLogging / CreateHsmCluster are now in place. If the cluster is in WAITING_FOR_CUSTOMER, and validation is successful, status is progressed and a work request is started. If the cluster has already progressed past that gate, the call is idempotent and returns 202 with the current cluster representation.

Parameters:

  • hsm_cluster_id (String) —

    The OCID of the HSM Cluster. This is a unique identifier assigned to each hsmCluster.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (e.g., if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).

  • :opc_request_id (String) —

    Unique identifier for the request. If provided, the returned request ID will include this value. Otherwise, a random request ID will be generated by the service.

Returns:



491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
 
# File 'lib/oci/key_management/kms_hsm_cluster_client.rb', line 491

def enable_audit_mgmt_logging(hsm_cluster_id, opts = {})
  logger.debug 'Calling operation KmsHsmClusterClient#enable_audit_mgmt_logging.' if logger

  raise "Missing the required parameter 'hsm_cluster_id' when calling enable_audit_mgmt_logging." if hsm_cluster_id.nil?
  raise "Parameter value for 'hsm_cluster_id' must not be blank" if OCI::Internal::Util.blank_string?(hsm_cluster_id)

  path = '/20180608/hsmClusters/{hsmClusterId}/actions/enableAuditMgmtLogging'.sub('{hsmClusterId}', hsm_cluster_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'KmsHsmClusterClient#enable_audit_mgmt_logging') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::KeyManagement::Models::EnableAuditMgmtLogging'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_hsm_cluster(hsm_cluster_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_hsm_cluster API.

Retrieves configuration details for the specified HSM Cluster resource.

As a provisioning operation, this call is subject to a Key Management limit that applies to the total number of requests across all provisioning read operations. Key Management might throttle this call to reject an otherwise valid request when the total rate of provisioning read operations exceeds 10 requests per second for a given tenancy.

Parameters:

  • hsm_cluster_id (String) —

    The OCID of the HSM Cluster. This is a unique identifier assigned to each hsmCluster.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request. If provided, the returned request ID will include this value. Otherwise, a random request ID will be generated by the service.

Returns:



557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
 
# File 'lib/oci/key_management/kms_hsm_cluster_client.rb', line 557

def get_hsm_cluster(hsm_cluster_id, opts = {})
  logger.debug 'Calling operation KmsHsmClusterClient#get_hsm_cluster.' if logger

  raise "Missing the required parameter 'hsm_cluster_id' when calling get_hsm_cluster." if hsm_cluster_id.nil?
  raise "Parameter value for 'hsm_cluster_id' must not be blank" if OCI::Internal::Util.blank_string?(hsm_cluster_id)

  path = '/20180608/hsmClusters/{hsmClusterId}'.sub('{hsmClusterId}', hsm_cluster_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'KmsHsmClusterClient#get_hsm_cluster') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::KeyManagement::Models::HsmCluster'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_hsm_partition(hsm_cluster_id, hsm_partition_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_hsm_partition API.

Retrieves HSM partition details for the specified HSM cluster.

Parameters:

  • hsm_cluster_id (String) —

    The OCID of the HSM Cluster. This is a unique identifier assigned to each hsmCluster.

  • hsm_partition_id (String) —

    The OCID of the HSM Partition. This is a unique identifier which each hsmPartition will have.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request. If provided, the returned request ID will include this value. Otherwise, a random request ID will be generated by the service.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (e.g., if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).

Returns:



623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
 
# File 'lib/oci/key_management/kms_hsm_cluster_client.rb', line 623

def get_hsm_partition(hsm_cluster_id, hsm_partition_id, opts = {})
  logger.debug 'Calling operation KmsHsmClusterClient#get_hsm_partition.' if logger

  raise "Missing the required parameter 'hsm_cluster_id' when calling get_hsm_partition." if hsm_cluster_id.nil?
  raise "Missing the required parameter 'hsm_partition_id' when calling get_hsm_partition." if hsm_partition_id.nil?
  raise "Parameter value for 'hsm_cluster_id' must not be blank" if OCI::Internal::Util.blank_string?(hsm_cluster_id)
  raise "Parameter value for 'hsm_partition_id' must not be blank" if OCI::Internal::Util.blank_string?(hsm_partition_id)

  path = '/20180608/hsmClusters/{hsmClusterId}/hsmPartitions/{hsmPartitionId}'.sub('{hsmClusterId}', hsm_cluster_id.to_s).sub('{hsmPartitionId}', hsm_partition_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'KmsHsmClusterClient#get_hsm_partition') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::KeyManagement::Models::HsmPartition'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_pre_co_user_credentials(hsm_cluster_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_pre_co_user_credentials API.

Retrieves Pre Crypto Officer user credentials for the specified HSM cluster.

Parameters:

  • hsm_cluster_id (String) —

    The OCID of the HSM Cluster. This is a unique identifier assigned to each hsmCluster.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request. If provided, the returned request ID will include this value. Otherwise, a random request ID will be generated by the service.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (e.g., if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).

Returns:



692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
 
# File 'lib/oci/key_management/kms_hsm_cluster_client.rb', line 692

def get_pre_co_user_credentials(hsm_cluster_id, opts = {})
  logger.debug 'Calling operation KmsHsmClusterClient#get_pre_co_user_credentials.' if logger

  raise "Missing the required parameter 'hsm_cluster_id' when calling get_pre_co_user_credentials." if hsm_cluster_id.nil?
  raise "Parameter value for 'hsm_cluster_id' must not be blank" if OCI::Internal::Util.blank_string?(hsm_cluster_id)

  path = '/20180608/hsmClusters/{hsmClusterId}/preCoUserCredentials'.sub('{hsmClusterId}', hsm_cluster_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'KmsHsmClusterClient#get_pre_co_user_credentials') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::KeyManagement::Models::PreCoUserCredentials'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#initiate_audit_logging(hsm_cluster_id, initiate_audit_logging_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use initiate_audit_logging API.

Initiates the process of enabling audit logs for a HSM cluster resource by taking in the required parameters.

Parameters:

  • hsm_cluster_id (String) —

    The OCID of the HSM Cluster. This is a unique identifier assigned to each hsmCluster.

  • initiate_audit_logging_details (OCI::KeyManagement::Models::InitiateAuditLoggingDetails) —

    The information need to make changes for management audit logs.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request. If provided, the returned request ID will include this value. Otherwise, a random request ID will be generated by the service.

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (e.g., if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).

Returns:



765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
 
# File 'lib/oci/key_management/kms_hsm_cluster_client.rb', line 765

def initiate_audit_logging(hsm_cluster_id, initiate_audit_logging_details, opts = {})
  logger.debug 'Calling operation KmsHsmClusterClient#initiate_audit_logging.' if logger

  raise "Missing the required parameter 'hsm_cluster_id' when calling initiate_audit_logging." if hsm_cluster_id.nil?
  raise "Missing the required parameter 'initiate_audit_logging_details' when calling initiate_audit_logging." if initiate_audit_logging_details.nil?
  raise "Parameter value for 'hsm_cluster_id' must not be blank" if OCI::Internal::Util.blank_string?(hsm_cluster_id)

  path = '/20180608/hsmClusters/{hsmClusterId}/actions/initiateAuditLogging'.sub('{hsmClusterId}', hsm_cluster_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(initiate_audit_logging_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'KmsHsmClusterClient#initiate_audit_logging') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::KeyManagement::Models::AuditLogging'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_hsm_clusters(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_hsm_clusters API.

Lists all HSM cluster resources contained within the specified compartment.

As a provisioning operation, this call is subject to a Key Management limit that applies to the total number of requests across all provisioning read operations. Key Management might throttle this call to reject an otherwise valid request when the total rate of provisioning read operations exceeds 10 requests per second for a given tenancy.

Parameters:

  • compartment_id (String) —

    The OCID of the compartment.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :limit (Integer) —

    The maximum number of items to return in a paginated "List" call.

  • :page (String) —

    The value of the opc-next-page response header from the previous "List" call.

  • :opc_request_id (String) —

    Unique identifier for the request. If provided, the returned request ID will include this value. Otherwise, a random request ID will be generated by the service.

  • :sort_by (String) —

    The field to sort by. You can specify only one sort order. The default order for TIMECREATED is descending. The default order for DISPLAYNAME is ascending.

    Allowed values are: TIMECREATED, DISPLAYNAME

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC).

    Allowed values are: ASC, DESC

Returns:



845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
 
# File 'lib/oci/key_management/kms_hsm_cluster_client.rb', line 845

def list_hsm_clusters(compartment_id, opts = {})
  logger.debug 'Calling operation KmsHsmClusterClient#list_hsm_clusters.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_hsm_clusters." if compartment_id.nil?

  if opts[:sort_by] && !%w[TIMECREATED DISPLAYNAME].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIMECREATED, DISPLAYNAME.'
  end

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end

  path = '/20180608/hsmClusters'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'KmsHsmClusterClient#list_hsm_clusters') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::KeyManagement::Models::HsmClusterCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_hsm_partitions(hsm_cluster_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_hsm_partitions API.

Lists all HSM partitions within the specified HSM Cluster resource.

Parameters:

  • hsm_cluster_id (String) —

    The OCID of the HSM Cluster. This is a unique identifier assigned to each hsmCluster.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :limit (Integer) —

    The maximum number of items to return in a paginated "List" call.

  • :page (String) —

    The value of the opc-next-page response header from the previous "List" call.

  • :opc_request_id (String) —

    Unique identifier for the request. If provided, the returned request ID will include this value. Otherwise, a random request ID will be generated by the service.

  • :sort_by (String) —

    The field to sort by. You can specify only one sort order. The default order for TIMECREATED is descending. The default order for DISPLAYNAME is ascending.

    Allowed values are: TIMECREATED, DISPLAYNAME

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC).

    Allowed values are: ASC, DESC

  • :lifecycle_state (String) —

    A filter that returns only resources that match the specified lifecycle state. The state value is case-insensitive.

Returns:



929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
 
# File 'lib/oci/key_management/kms_hsm_cluster_client.rb', line 929

def list_hsm_partitions(hsm_cluster_id, opts = {})
  logger.debug 'Calling operation KmsHsmClusterClient#list_hsm_partitions.' if logger

  raise "Missing the required parameter 'hsm_cluster_id' when calling list_hsm_partitions." if hsm_cluster_id.nil?

  if opts[:sort_by] && !%w[TIMECREATED DISPLAYNAME].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIMECREATED, DISPLAYNAME.'
  end

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end

  if opts[:lifecycle_state] && !OCI::KeyManagement::Models::HsmPartition::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::KeyManagement::Models::HsmPartition::LIFECYCLE_STATE_ENUM.'
  end
  raise "Parameter value for 'hsm_cluster_id' must not be blank" if OCI::Internal::Util.blank_string?(hsm_cluster_id)

  path = '/20180608/hsmClusters/{hsmClusterId}/hsmPartitions'.sub('{hsmClusterId}', hsm_cluster_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'KmsHsmClusterClient#list_hsm_partitions') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::KeyManagement::Models::HsmPartitionCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#logger ⇒ Logger

Returns The logger for this client. May be nil.

Returns:

  • (Logger) —

    The logger for this client. May be nil.



94
95
96
 
# File 'lib/oci/key_management/kms_hsm_cluster_client.rb', line 94

def logger
  @api_client.config.logger
end

#schedule_hsm_cluster_deletion(hsm_cluster_id, schedule_hsm_cluster_deletion_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use schedule_hsm_cluster_deletion API.

Schedules HSM cluster for deletion, update its lifecycle state to 'PENDING_DELETION' and deletes it after the retention period.

Parameters:

  • hsm_cluster_id (String) —

    The OCID of the HSM Cluster. This is a unique identifier assigned to each hsmCluster.

  • schedule_hsm_cluster_deletion_details (OCI::KeyManagement::Models::ScheduleHsmClusterDeletionDetails) —

    Details of ScheduleHsmClusterDeletionDetails

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique identifier for the request. If provided, the returned request ID will include this value. Otherwise, a random request ID will be generated by the service.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (e.g., if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).

Returns:



1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
 
# File 'lib/oci/key_management/kms_hsm_cluster_client.rb', line 1019

def schedule_hsm_cluster_deletion(hsm_cluster_id, schedule_hsm_cluster_deletion_details, opts = {})
  logger.debug 'Calling operation KmsHsmClusterClient#schedule_hsm_cluster_deletion.' if logger

  raise "Missing the required parameter 'hsm_cluster_id' when calling schedule_hsm_cluster_deletion." if hsm_cluster_id.nil?
  raise "Missing the required parameter 'schedule_hsm_cluster_deletion_details' when calling schedule_hsm_cluster_deletion." if schedule_hsm_cluster_deletion_details.nil?
  raise "Parameter value for 'hsm_cluster_id' must not be blank" if OCI::Internal::Util.blank_string?(hsm_cluster_id)

  path = '/20180608/hsmClusters/{hsmClusterId}/actions/scheduleDeletion'.sub('{hsmClusterId}', hsm_cluster_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(schedule_hsm_cluster_deletion_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'KmsHsmClusterClient#schedule_hsm_cluster_deletion') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::KeyManagement::Models::HsmCluster'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_audit_logging_destination(hsm_cluster_id, update_audit_logging_destination_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_audit_logging_destination API.

update bucket details of management audit logs for a HSM cluster resource by hsmClusterId.

Parameters:

  • hsm_cluster_id (String) —

    The OCID of the HSM Cluster. This is a unique identifier assigned to each hsmCluster.

  • update_audit_logging_destination_details (OCI::KeyManagement::Models::UpdateAuditLoggingDestinationDetails) —

    The information need to make changes for management audit logs.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request. If provided, the returned request ID will include this value. Otherwise, a random request ID will be generated by the service.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (e.g., if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:



1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
 
# File 'lib/oci/key_management/kms_hsm_cluster_client.rb', line 1094

def update_audit_logging_destination(hsm_cluster_id, update_audit_logging_destination_details, opts = {})
  logger.debug 'Calling operation KmsHsmClusterClient#update_audit_logging_destination.' if logger

  raise "Missing the required parameter 'hsm_cluster_id' when calling update_audit_logging_destination." if hsm_cluster_id.nil?
  raise "Missing the required parameter 'update_audit_logging_destination_details' when calling update_audit_logging_destination." if update_audit_logging_destination_details.nil?
  raise "Parameter value for 'hsm_cluster_id' must not be blank" if OCI::Internal::Util.blank_string?(hsm_cluster_id)

  path = '/20180608/hsmClusters/{hsmClusterId}/actions/updateAuditLoggingDestination'.sub('{hsmClusterId}', hsm_cluster_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(update_audit_logging_destination_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'KmsHsmClusterClient#update_audit_logging_destination') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::KeyManagement::Models::AuditLogging'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_hsm_cluster(hsm_cluster_id, update_hsm_cluster_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_hsm_cluster API.

Modifies properties of an HSM cluster resource, including displayName, freeformTags and definedTags.

As a provisioning operation, this call is subject to a Key Management limit that applies to the total number of requests across all provisioning write operations. Key Management might throttle this call to reject an otherwise valid request when the total rate of provisioning write operations exceeds 10 requests per second for a given tenancy.

Parameters:

  • hsm_cluster_id (String) —

    The OCID of the HSM Cluster. This is a unique identifier assigned to each hsmCluster.

  • update_hsm_cluster_details (OCI::KeyManagement::Models::UpdateHsmClusterDetails) —

    Details of the HsmCluster Resource

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique identifier for the request. If provided, the returned request ID will include this value. Otherwise, a random request ID will be generated by the service.

Returns:



1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
 
# File 'lib/oci/key_management/kms_hsm_cluster_client.rb', line 1168

def update_hsm_cluster(hsm_cluster_id, update_hsm_cluster_details, opts = {})
  logger.debug 'Calling operation KmsHsmClusterClient#update_hsm_cluster.' if logger

  raise "Missing the required parameter 'hsm_cluster_id' when calling update_hsm_cluster." if hsm_cluster_id.nil?
  raise "Missing the required parameter 'update_hsm_cluster_details' when calling update_hsm_cluster." if update_hsm_cluster_details.nil?
  raise "Parameter value for 'hsm_cluster_id' must not be blank" if OCI::Internal::Util.blank_string?(hsm_cluster_id)

  path = '/20180608/hsmClusters/{hsmClusterId}'.sub('{hsmClusterId}', hsm_cluster_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_hsm_cluster_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'KmsHsmClusterClient#update_hsm_cluster') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::KeyManagement::Models::HsmCluster'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#upload_partition_certificates(hsm_cluster_id, upload_partition_certificates_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use upload_partition_certificates API.

Uploads the partition owner certificates to the HSM Cluster resource.

Parameters:

  • hsm_cluster_id (String) —

    The OCID of the HSM Cluster. This is a unique identifier assigned to each hsmCluster.

  • upload_partition_certificates_details (OCI::KeyManagement::Models::UploadPartitionCertificatesDetails) —

    To upload partition certificates.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request. If provided, the returned request ID will include this value. Otherwise, a random request ID will be generated by the service.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (e.g., if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:

  • (Response) —

    A Response object with data of type nil



1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
 
# File 'lib/oci/key_management/kms_hsm_cluster_client.rb', line 1242

def upload_partition_certificates(hsm_cluster_id, upload_partition_certificates_details, opts = {})
  logger.debug 'Calling operation KmsHsmClusterClient#upload_partition_certificates.' if logger

  raise "Missing the required parameter 'hsm_cluster_id' when calling upload_partition_certificates." if hsm_cluster_id.nil?
  raise "Missing the required parameter 'upload_partition_certificates_details' when calling upload_partition_certificates." if upload_partition_certificates_details.nil?
  raise "Parameter value for 'hsm_cluster_id' must not be blank" if OCI::Internal::Util.blank_string?(hsm_cluster_id)

  path = '/20180608/hsmClusters/{hsmClusterId}/actions/uploadPartitionCertificates'.sub('{hsmClusterId}', hsm_cluster_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(upload_partition_certificates_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'KmsHsmClusterClient#upload_partition_certificates') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end