Class: OCI::Dbmulticloud::DbMulticloudAwsProviderClient

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/dbmulticloud/db_multicloud_aws_provider_client.rb

Overview

Microsoft Azure:
Oracle Azure Connector Resource::&nbsp;&nbsp;The Oracle Azure Connector Resource is used to install the Azure Arc Server on an Exadata VM cluster in Oracle Exadata Database Service on Dedicated Infrastructure (ExaDB-D). The supported method to install the Azure Arc Server (Azure Identity) on the Exadata VM cluster: <ul> <li>Using a Bearer Access Token</li> </ul>

Oracle Azure Blob Container Resource:&nbsp;&nbsp;The Oracle Azure Blob Container Resource is used to capture the details of an Azure Blob Container. This resource can then be reused across multiple Exadata VM clusters in Oracle Exadata Database Service on Dedicated Infrastructure (ExaDB-D) to mount the Azure container.

Oracle Azure Blob Mount Resource:&nbsp;&nbsp;The Oracle Azure Blob Mount Resource is used to mount an Azure Blob Container on an Exadata VM cluster in Oracle Exadata Database Service on Dedicated Infrastructure (ExaDB-D). It relies on both the Oracle Azure Connector and the Oracle Azure Blob Container Resource to perform the mount operation.

Discover Azure Vaults and Keys Resource:&nbsp;&nbsp;The Discover Oracle Azure Vaults and Azure Keys Resource is used to discover Azure Vaults and the associated encryption keys available in your Azure project.

Oracle Azure Vault:&nbsp;&nbsp;The Oracle Azure Vault Resource is used to manage Azure Vaults within Oracle Cloud Infrastructure (OCI) for use with services such as Oracle Exadata Database Service on Dedicated Infrastructure.

Oracle Azure Key:&nbsp;&nbsp;Oracle Azure Key Resource is used to register and manage a Oracle Azure Key Key within Oracle Cloud Infrastructure (OCI) under an associated Azure Vault.


Google Cloud:
Oracle Google Cloud Connector Resource:&nbsp;&nbsp;The Oracle Google Cloud Connector Resource is used to install the Google Cloud Identity Connector on an Exadata VM cluster in Oracle Exadata Database Service on Dedicated Infrastructure (ExaDB-D).

Discover Google Key Rings and Keys Resource:&nbsp;&nbsp;The Discover Google Key Rings and Keys Resource is used to discover Google Cloud Key Rings and the associated encryption keys available in your Google Cloud project.

Google Key Rings Resource:&nbsp;&nbsp;The Google Key Rings Resource is used to register and manage Google Cloud Key Rings within Oracle Cloud Infrastructure (OCI) for use with services such as Oracle Exadata Database Service on Dedicated Infrastructure.

Google Key Resource:&nbsp;&nbsp;The Google Key Resource is used to register and manage a Google Cloud Key within Oracle Cloud Infrastructure (OCI) under an associated Google Key Ring.

AWS:
Oracle AWS Connector Resource:&nbsp;&nbsp;The Oracle AWS Connector Resource is used to install the AWS Identity Connector on an Exadata VM cluster in Oracle Exadata Database Service on Dedicated Infrastructure (ExaDB-D).

Oracle AWS Key Resource:&nbsp;&nbsp;The Oracle AWS Key Resource is used to register and manage a AWS Key within Oracle Cloud Infrastructure (OCI).

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) ⇒ DbMulticloudAwsProviderClient

Creates a new DbMulticloudAwsProviderClient. 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



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/oci/dbmulticloud/db_multicloud_aws_provider_client.rb', line 89

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 + '/20240501'
  else
    region ||= config.region
    region ||= signer.region if signer.respond_to?(:region)
    self.region = region
  end
  logger.info "DbMulticloudAwsProviderClient endpoint set to '#{@endpoint}'." if logger
end

Instance Attribute Details

#api_client ⇒ OCI::ApiClient (readonly)

Client used to make HTTP requests.

Returns:



49
50
51
 
# File 'lib/oci/dbmulticloud/db_multicloud_aws_provider_client.rb', line 49

def api_client
  @api_client
end

#endpoint ⇒ String (readonly)

Fully qualified endpoint URL

Returns:

  • (String) 


53
54
55
 
# File 'lib/oci/dbmulticloud/db_multicloud_aws_provider_client.rb', line 53

def endpoint
  @endpoint
end

#region ⇒ String

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

Returns:

  • (String) 


63
64
65
 
# File 'lib/oci/dbmulticloud/db_multicloud_aws_provider_client.rb', line 63

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:



59
60
61
 
# File 'lib/oci/dbmulticloud/db_multicloud_aws_provider_client.rb', line 59

def retry_config
  @retry_config
end

Instance Method Details

#change_oracle_db_aws_identity_connector_compartment(oracle_db_aws_identity_connector_id, change_oracle_db_aws_identity_connector_compartment_details, opts = {}) ⇒ Response

Note:

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

Moves the Oracle DB AWS Identity Connector resource into a different compartment. When provided, 'If-Match' is checked against 'ETag' values of the 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_retry_token (String) —

    A token that uniquely identifies a request, allowing it to be safely retried in the event of a timeout or server error without the risk of the action being executed more than once.

    Retry tokens expire after 24 hours but can be invalidated sooner if conflicting operations occur.

    For example, if a resource has been deleted and permanently purged from the system, 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.

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:

  • (Response) —

    A Response object with data of type nil



158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
 
# File 'lib/oci/dbmulticloud/db_multicloud_aws_provider_client.rb', line 158

def change_oracle_db_aws_identity_connector_compartment(oracle_db_aws_identity_connector_id, change_oracle_db_aws_identity_connector_compartment_details, opts = {})
  logger.debug 'Calling operation DbMulticloudAwsProviderClient#change_oracle_db_aws_identity_connector_compartment.' if logger

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

  path = '/oracleDbAwsIdentityConnector/{oracleDbAwsIdentityConnectorId}/actions/changeCompartment'.sub('{oracleDbAwsIdentityConnectorId}', oracle_db_aws_identity_connector_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-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  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
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(change_oracle_db_aws_identity_connector_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DbMulticloudAwsProviderClient#change_oracle_db_aws_identity_connector_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

#change_oracle_db_aws_key_compartment(oracle_db_aws_key_id, change_oracle_db_aws_key_compartment_details, opts = {}) ⇒ Response

Note:

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

Moves the AWS Key resource into a different compartment. When provided, 'If-Match' is checked against 'ETag' values of the 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_retry_token (String) —

    A token that uniquely identifies a request, allowing it to be safely retried in the event of a timeout or server error without the risk of the action being executed more than once.

    Retry tokens expire after 24 hours but can be invalidated sooner if conflicting operations occur.

    For example, if a resource has been deleted and permanently purged from the system, 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.

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:

  • (Response) —

    A Response object with data of type nil



228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
 
# File 'lib/oci/dbmulticloud/db_multicloud_aws_provider_client.rb', line 228

def change_oracle_db_aws_key_compartment(oracle_db_aws_key_id, change_oracle_db_aws_key_compartment_details, opts = {})
  logger.debug 'Calling operation DbMulticloudAwsProviderClient#change_oracle_db_aws_key_compartment.' if logger

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

  path = '/oracleDbAwsKey/{oracleDbAwsKeyId}/actions/changeCompartment'.sub('{oracleDbAwsKeyId}', oracle_db_aws_key_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-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  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
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(change_oracle_db_aws_key_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DbMulticloudAwsProviderClient#change_oracle_db_aws_key_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_oracle_db_aws_identity_connector(create_oracle_db_aws_identity_connector_details, opts = {}) ⇒ Response

Note:

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

Creates Oracle DB AWS Identity Connector 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_retry_token (String) —

    A token that uniquely identifies a request, allowing it to be safely retried in the event of a timeout or server error without the risk of the action being executed more than once.

    Retry tokens expire after 24 hours but can be invalidated sooner if conflicting operations occur.

    For example, if a resource has been deleted and permanently purged from the system, a retry of the original creation request may be rejected.

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
 
# File 'lib/oci/dbmulticloud/db_multicloud_aws_provider_client.rb', line 293

def create_oracle_db_aws_identity_connector(create_oracle_db_aws_identity_connector_details, opts = {})
  logger.debug 'Calling operation DbMulticloudAwsProviderClient#create_oracle_db_aws_identity_connector.' if logger

  raise "Missing the required parameter 'create_oracle_db_aws_identity_connector_details' when calling create_oracle_db_aws_identity_connector." if create_oracle_db_aws_identity_connector_details.nil?

  path = '/oracleDbAwsIdentityConnector'
  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-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 = @api_client.object_to_http_body(create_oracle_db_aws_identity_connector_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DbMulticloudAwsProviderClient#create_oracle_db_aws_identity_connector') 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::Dbmulticloud::Models::OracleDbAwsIdentityConnector'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_oracle_db_aws_key(create_oracle_db_aws_key_details, opts = {}) ⇒ Response

Note:

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

Create DB AWS Key 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_retry_token (String) —

    A token that uniquely identifies a request, allowing it to be safely retried in the event of a timeout or server error without the risk of the action being executed more than once.

    Retry tokens expire after 24 hours but can be invalidated sooner if conflicting operations occur.

    For example, if a resource has been deleted and permanently purged from the system, 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.

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
 
# File 'lib/oci/dbmulticloud/db_multicloud_aws_provider_client.rb', line 361

def create_oracle_db_aws_key(create_oracle_db_aws_key_details, opts = {})
  logger.debug 'Calling operation DbMulticloudAwsProviderClient#create_oracle_db_aws_key.' if logger

  raise "Missing the required parameter 'create_oracle_db_aws_key_details' when calling create_oracle_db_aws_key." if create_oracle_db_aws_key_details.nil?

  path = '/oracleDbAwsKey'
  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-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  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
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(create_oracle_db_aws_key_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DbMulticloudAwsProviderClient#create_oracle_db_aws_key') 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::Dbmulticloud::Models::OracleDbAwsKey'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#delete_oracle_db_aws_identity_connector(oracle_db_aws_identity_connector_id, opts = {}) ⇒ Response

Note:

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

Deletes a Oracle DB AWS Identity Connector resource.

Parameters:

  • oracle_db_aws_identity_connector_id (String) —

    The OCID of the Oracle DB AWS Identity Connector 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) —

    The client request ID for tracing.

Returns:

  • (Response) —

    A Response object with data of type nil



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
455
456
457
458
459
460
 
# File 'lib/oci/dbmulticloud/db_multicloud_aws_provider_client.rb', line 424

def delete_oracle_db_aws_identity_connector(oracle_db_aws_identity_connector_id, opts = {})
  logger.debug 'Calling operation DbMulticloudAwsProviderClient#delete_oracle_db_aws_identity_connector.' if logger

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

  path = '/oracleDbAwsIdentityConnector/{oracleDbAwsIdentityConnectorId}'.sub('{oracleDbAwsIdentityConnectorId}', oracle_db_aws_identity_connector_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 = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DbMulticloudAwsProviderClient#delete_oracle_db_aws_identity_connector') do
    @api_client.call_api(
      :DELETE,
      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

#delete_oracle_db_aws_key(oracle_db_aws_key_id, opts = {}) ⇒ Response

Note:

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

Delete AWS Key resource.

Parameters:

  • oracle_db_aws_key_id (String) —

    The OCID of the Oracle DB AWS Key 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) —

    The client request ID for tracing.

Returns:

  • (Response) —

    A Response object with data of type nil



485
486
487
488
489
490
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
 
# File 'lib/oci/dbmulticloud/db_multicloud_aws_provider_client.rb', line 485

def delete_oracle_db_aws_key(oracle_db_aws_key_id, opts = {})
  logger.debug 'Calling operation DbMulticloudAwsProviderClient#delete_oracle_db_aws_key.' if logger

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

  path = '/oracleDbAwsKey/{oracleDbAwsKeyId}'.sub('{oracleDbAwsKeyId}', oracle_db_aws_key_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 = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DbMulticloudAwsProviderClient#delete_oracle_db_aws_key') do
    @api_client.call_api(
      :DELETE,
      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

#get_oracle_db_aws_identity_connector(oracle_db_aws_identity_connector_id, opts = {}) ⇒ Response

Note:

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

Retrieves detailed information about a Oracle DB AWS Identity Connector resource by specifying its unique resource OCID.

Parameters:

  • oracle_db_aws_identity_connector_id (String) —

    The OCID of the Oracle DB AWS Identity Connector 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

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
 
# File 'lib/oci/dbmulticloud/db_multicloud_aws_provider_client.rb', line 540

def get_oracle_db_aws_identity_connector(oracle_db_aws_identity_connector_id, opts = {})
  logger.debug 'Calling operation DbMulticloudAwsProviderClient#get_oracle_db_aws_identity_connector.' if logger

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

  path = '/oracleDbAwsIdentityConnector/{oracleDbAwsIdentityConnectorId}'.sub('{oracleDbAwsIdentityConnectorId}', oracle_db_aws_identity_connector_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: 'DbMulticloudAwsProviderClient#get_oracle_db_aws_identity_connector') 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::Dbmulticloud::Models::OracleDbAwsIdentityConnector'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_oracle_db_aws_key(oracle_db_aws_key_id, opts = {}) ⇒ Response

Note:

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

Retrieves detailed information about a Oracle AWS Key resource by specifying its unique resource OCID.

Parameters:

  • oracle_db_aws_key_id (String) —

    The OCID of the Oracle DB AWS Key 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

  • :limit (Integer) —

    The maximum number of items to return. (default to 10)

  • :page (String) —

    The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.

  • :sort_order (String) —

    The sort order to use, either 'asc' or 'desc'. (default to DESC)

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
 
# File 'lib/oci/dbmulticloud/db_multicloud_aws_provider_client.rb', line 598

def get_oracle_db_aws_key(oracle_db_aws_key_id, opts = {})
  logger.debug 'Calling operation DbMulticloudAwsProviderClient#get_oracle_db_aws_key.' if logger

  raise "Missing the required parameter 'oracle_db_aws_key_id' when calling get_oracle_db_aws_key." if oracle_db_aws_key_id.nil?

  if opts[:sort_order] && !OCI::Dbmulticloud::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::Dbmulticloud::Models::SORT_ORDER_ENUM.'
  end
  raise "Parameter value for 'oracle_db_aws_key_id' must not be blank" if OCI::Internal::Util.blank_string?(oracle_db_aws_key_id)

  path = '/oracleDbAwsKey/{oracleDbAwsKeyId}'.sub('{oracleDbAwsKeyId}', oracle_db_aws_key_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[: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: 'DbMulticloudAwsProviderClient#get_oracle_db_aws_key') 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::Dbmulticloud::Models::OracleDbAwsKey'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

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

Note:

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

Lists all Oracle DB AWS Identity Connectors based on the specified filters.

Allowed values are: timeCreated, displayName

Parameters:

  • compartment_id (String) —

    The ID 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

  • :display_name (String) —

    A filter to return Oracle DB AWS Identity Connector Resource that match the given display name.

  • :lifecycle_state (String) —

    A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.

  • :resource_id (String) —

    A filter to return Oracle DB Identity Connector resource that match the given resource OCID.

  • :limit (Integer) —

    The maximum number of items to return. (default to 10)

  • :page (String) —

    The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.

  • :sort_order (String) —

    The sort order to use, either 'asc' or 'desc'. (default to DESC)

  • :sort_by (String) —

    The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified, default is timeCreated. (default to timeCreated)

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
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
 
# File 'lib/oci/dbmulticloud/db_multicloud_aws_provider_client.rb', line 670

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

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

  if opts[:lifecycle_state] && !OCI::Dbmulticloud::Models::OracleDbAwsIdentityConnector::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Dbmulticloud::Models::OracleDbAwsIdentityConnector::LIFECYCLE_STATE_ENUM.'
  end

  if opts[:sort_order] && !OCI::Dbmulticloud::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::Dbmulticloud::Models::SORT_ORDER_ENUM.'
  end

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

  path = '/oracleDbAwsIdentityConnector'
  operation_signing_strategy = :standard

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

  # 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: 'DbMulticloudAwsProviderClient#list_oracle_db_aws_identity_connectors') 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::Dbmulticloud::Models::OracleDbAwsIdentityConnectorSummaryCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

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

Note:

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

Lists all DB AWS Keys based on the specified filters.

Allowed values are: timeCreated, displayName

Parameters:

  • compartment_id (String) —

    The ID 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

  • :display_name (String) —

    A filter to return Oracle DB AWS Key Resource that match the given display name.

  • :oracle_db_aws_key_id (String) —

    A filter to return Oracle DB AWS Identity Connector Resource that match the given OCID](/Content/General/Concepts/identifiers.htm) of the Oracle DB AWS Key resource.

  • :lifecycle_state (String) —

    A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.

  • :oracle_db_aws_connector_id (String) —

    A filter to return Oracle DB AWS Identity Connector resources that match the specified OCID of the Oracle DB AWS Identity Connector resource.

  • :limit (Integer) —

    The maximum number of items to return. (default to 10)

  • :page (String) —

    The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.

  • :sort_order (String) —

    The sort order to use, either 'asc' or 'desc'. (default to DESC)

  • :sort_by (String) —

    The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified, default is timeCreated. (default to timeCreated)

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



755
756
757
758
759
760
761
762
763
764
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
806
807
808
809
810
811
 
# File 'lib/oci/dbmulticloud/db_multicloud_aws_provider_client.rb', line 755

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

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

  if opts[:lifecycle_state] && !OCI::Dbmulticloud::Models::OracleDbAwsKey::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Dbmulticloud::Models::OracleDbAwsKey::LIFECYCLE_STATE_ENUM.'
  end

  if opts[:sort_order] && !OCI::Dbmulticloud::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::Dbmulticloud::Models::SORT_ORDER_ENUM.'
  end

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

  path = '/oracleDbAwsKey'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:oracleDbAwsKeyId] = opts[:oracle_db_aws_key_id] if opts[:oracle_db_aws_key_id]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:oracleDbAwsConnectorId] = opts[:oracle_db_aws_connector_id] if opts[:oracle_db_aws_connector_id]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]

  # 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: 'DbMulticloudAwsProviderClient#list_oracle_db_aws_keys') 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::Dbmulticloud::Models::OracleDbAwsKeySummaryCollection'
    )
  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.



128
129
130
 
# File 'lib/oci/dbmulticloud/db_multicloud_aws_provider_client.rb', line 128

def logger
  @api_client.config.logger
end

#refresh_oracle_db_aws_identity_connector(oracle_db_aws_identity_connector_id, opts = {}) ⇒ Response

Note:

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

Refreshes the Oracle DB AWS Connector resource.

Parameters:

  • oracle_db_aws_identity_connector_id (String) —

    The OCID of the Oracle DB AWS Identity Connector 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

  • :opc_retry_token (String) —

    A token that uniquely identifies a request, allowing it to be safely retried in the event of a timeout or server error without the risk of the action being executed more than once.

    Retry tokens expire after 24 hours but can be invalidated sooner if conflicting operations occur.

    For example, if a resource has been deleted and permanently purged from the system, 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.

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:

  • (Response) —

    A Response object with data of type nil



842
843
844
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
 
# File 'lib/oci/dbmulticloud/db_multicloud_aws_provider_client.rb', line 842

def refresh_oracle_db_aws_identity_connector(oracle_db_aws_identity_connector_id, opts = {})
  logger.debug 'Calling operation DbMulticloudAwsProviderClient#refresh_oracle_db_aws_identity_connector.' if logger

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

  path = '/oracleDbAwsIdentityConnector/{oracleDbAwsIdentityConnectorId}/actions/refresh'.sub('{oracleDbAwsIdentityConnectorId}', oracle_db_aws_identity_connector_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-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  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
  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: 'DbMulticloudAwsProviderClient#refresh_oracle_db_aws_identity_connector') 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

#refresh_oracle_db_aws_key(oracle_db_aws_key_id, refresh_oracle_db_aws_key_details, opts = {}) ⇒ Response

Note:

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

Refreshes Oracle AWS Key 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_retry_token (String) —

    A token that uniquely identifies a request, allowing it to be safely retried in the event of a timeout or server error without the risk of the action being executed more than once.

    Retry tokens expire after 24 hours but can be invalidated sooner if conflicting operations occur.

    For example, if a resource has been deleted and permanently purged from the system, 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.

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:

  • (Response) —

    A Response object with data of type nil



912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
 
# File 'lib/oci/dbmulticloud/db_multicloud_aws_provider_client.rb', line 912

def refresh_oracle_db_aws_key(oracle_db_aws_key_id, refresh_oracle_db_aws_key_details, opts = {})
  logger.debug 'Calling operation DbMulticloudAwsProviderClient#refresh_oracle_db_aws_key.' if logger

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

  path = '/oracleDbAwsKey/{oracleDbAwsKeyId}/actions/refresh'.sub('{oracleDbAwsKeyId}', oracle_db_aws_key_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-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  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
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(refresh_oracle_db_aws_key_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DbMulticloudAwsProviderClient#refresh_oracle_db_aws_key') 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

#replicate_oracle_db_aws_key(oracle_db_aws_key_id, replicate_oracle_db_aws_key_details, opts = {}) ⇒ Response

Note:

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

Replicate Oracle AWS Key resource to target region.

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_retry_token (String) —

    A token that uniquely identifies a request, allowing it to be safely retried in the event of a timeout or server error without the risk of the action being executed more than once.

    Retry tokens expire after 24 hours but can be invalidated sooner if conflicting operations occur.

    For example, if a resource has been deleted and permanently purged from the system, 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.

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:

  • (Response) —

    A Response object with data of type nil



983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
 
# File 'lib/oci/dbmulticloud/db_multicloud_aws_provider_client.rb', line 983

def replicate_oracle_db_aws_key(oracle_db_aws_key_id, replicate_oracle_db_aws_key_details, opts = {})
  logger.debug 'Calling operation DbMulticloudAwsProviderClient#replicate_oracle_db_aws_key.' if logger

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

  path = '/oracleDbAwsKey/{oracleDbAwsKeyId}/actions/replicate'.sub('{oracleDbAwsKeyId}', oracle_db_aws_key_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-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  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
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(replicate_oracle_db_aws_key_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DbMulticloudAwsProviderClient#replicate_oracle_db_aws_key') 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

#update_oracle_db_aws_identity_connector(oracle_db_aws_identity_connector_id, update_oracle_db_aws_identity_connector_details, opts = {}) ⇒ Response

Note:

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

Modifies the existing Oracle DB AWS Identity Connector resource for a given OCID.

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) —

    The client request ID for tracing.

Returns:

  • (Response) —

    A Response object with data of type nil



1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
 
# File 'lib/oci/dbmulticloud/db_multicloud_aws_provider_client.rb', line 1048

def update_oracle_db_aws_identity_connector(oracle_db_aws_identity_connector_id, update_oracle_db_aws_identity_connector_details, opts = {})
  logger.debug 'Calling operation DbMulticloudAwsProviderClient#update_oracle_db_aws_identity_connector.' if logger

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

  path = '/oracleDbAwsIdentityConnector/{oracleDbAwsIdentityConnectorId}'.sub('{oracleDbAwsIdentityConnectorId}', oracle_db_aws_identity_connector_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_oracle_db_aws_identity_connector_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DbMulticloudAwsProviderClient#update_oracle_db_aws_identity_connector') 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
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_oracle_db_aws_key(oracle_db_aws_key_id, update_oracle_db_aws_key_details, opts = {}) ⇒ Response

Note:

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

Modifies the existing Oracle AWS Key Details for a given OCID.

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) —

    The client request ID for tracing.

Returns:

  • (Response) —

    A Response object with data of type nil



1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
 
# File 'lib/oci/dbmulticloud/db_multicloud_aws_provider_client.rb', line 1111

def update_oracle_db_aws_key(oracle_db_aws_key_id, update_oracle_db_aws_key_details, opts = {})
  logger.debug 'Calling operation DbMulticloudAwsProviderClient#update_oracle_db_aws_key.' if logger

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

  path = '/oracleDbAwsKey/{oracleDbAwsKeyId}'.sub('{oracleDbAwsKeyId}', oracle_db_aws_key_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_oracle_db_aws_key_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DbMulticloudAwsProviderClient#update_oracle_db_aws_key') 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
    )
  end
  # rubocop:enable Metrics/BlockLength
end