Class: Aws::Odb::Client

Inherits:
Seahorse::Client::Base show all
Includes:
ClientStubs
Defined in:
gems/aws-sdk-odb/lib/aws-sdk-odb/client.rb

Overview

An API client for Odb. To construct a client, you need to configure a :region and :credentials.

client = Aws::Odb::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

For details on configuring region and credentials see the developer guide.

See #initialize for a full list of supported configuration options.

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

API Operations collapse

Instance Method Summary collapse

Methods included from ClientStubs

#api_requests, #stub_data, #stub_responses

Methods inherited from Seahorse::Client::Base

add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

  • :plugins (Array<Seahorse::Client::Plugin>) — default: []] —

    A list of plugins to apply to the client. Each plugin is either a class name or an instance of a plugin class.

  • :credentials (required, Aws::CredentialProvider) —

    Your AWS credentials used for authentication. This can be any class that includes and implements Aws::CredentialProvider, or instance of any one of the following classes:

    • Aws::Credentials - Used for configuring static, non-refreshing credentials.

    • Aws::SharedCredentials - Used for loading static credentials from a shared file, such as ~/.aws/config.

    • Aws::AssumeRoleCredentials - Used when you need to assume a role.

    • Aws::AssumeRoleWebIdentityCredentials - Used when you need to assume a role after providing credentials via the web.

    • Aws::SSOCredentials - Used for loading credentials from AWS SSO using an access token generated from aws login.

    • Aws::ProcessCredentials - Used for loading credentials from a process that outputs to stdout.

    • Aws::InstanceProfileCredentials - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • Aws::ECSCredentials - Used for loading credentials from instances running in ECS.

    • Aws::CognitoIdentityCredentials - Used for loading credentials from the Cognito Identity service.

    When :credentials are not configured directly, the following locations will be searched for credentials:

    • Aws.config[:credentials]

    • The :access_key_id, :secret_access_key, :session_token, and :account_id options.

    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY'], ENV['AWS_SESSION_TOKEN'], and ENV['AWS_ACCOUNT_ID'].

    • ~/.aws/credentials

    • ~/.aws/config

    • EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of Aws::InstanceProfileCredentials or Aws::ECSCredentials to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED'] to true.

  • :region (required, String) —

    The AWS region to connect to. The configured :region is used to determine the service :endpoint. When not passed, a default :region is searched for in the following locations:

    • Aws.config[:region]
    • ENV['AWS_REGION']
    • ENV['AMAZON_REGION']
    • ENV['AWS_DEFAULT_REGION']
    • ~/.aws/credentials
    • ~/.aws/config
  • :access_key_id (String)
  • :account_id (String)
  • :active_endpoint_cache (Boolean) — default: false —

    When set to true, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to false.

  • :adaptive_retry_wait_to_fill (Boolean) — default: true —

    Used only in adaptive retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a RetryCapacityNotAvailableError and will not retry instead of sleeping.

  • :auth_scheme_preference (Array<String>) —

    A list of preferred authentication schemes to use when making a request. Supported values are: sigv4, sigv4a, httpBearerAuth, and noAuth. When set using ENV['AWS_AUTH_SCHEME_PREFERENCE'] or in shared config as auth_scheme_preference, the value should be a comma-separated list.

  • :client_side_monitoring (Boolean) — default: false —

    When true, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: "" —

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_host (String) — default: "127.0.0.1" —

    Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_port (Integer) — default: 31000 —

    Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher —

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true —

    When true, an attempt is made to coerce request parameters into the required types.

  • :correct_clock_skew (Boolean) — default: true —

    Used only in standard and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks. Takes effect only when disable_clock_skew_correction is not set.

  • :defaults_mode (String) — default: "legacy" —

    See DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.

  • :disable_clock_skew_correction (Boolean) —

    Used only in standard and adaptive retry modes. When true, the SDK does not apply a clock skew correction, does not update its stored skew from responses, and does not retry clock skew errors. Clock skew correction is enabled by default.

  • :disable_host_prefix_injection (Boolean) — default: false —

    When true, the SDK will not prepend the modeled host prefix to the endpoint.

  • :disable_request_compression (Boolean) — default: false —

    When set to 'true' the request body will not be compressed for supported operations.

  • :endpoint (String, URI::HTTPS, URI::HTTP) —

    Normally you should not configure the :endpoint option directly. This is normally constructed from the :region option. Configuring :endpoint is normally reserved for connecting to test or custom endpoints. The endpoint should be a URI formatted like:

    'http://example.com'
'https://example.com'
'http://example.com:123'
  • :endpoint_cache_max_entries (Integer) — default: 1000 —

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10 —

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 60 —

    When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.

  • :endpoint_discovery (Boolean) — default: false —

    When set to true, endpoint discovery will be enabled for operations when available.

  • :ignore_configured_endpoint_urls (Boolean) —

    Setting to true disables use of endpoint URLs provided via environment variables and the shared configuration file.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default —

    The log formatter.

  • :log_level (Symbol) — default: :info —

    The log level to send messages to the :logger at.

  • :logger (Logger) —

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :max_attempts (Integer) — default: 3 —

    An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in standard and adaptive retry modes. Defaults to 3, except for DynamoDB and DynamoDB Streams, which default to 4.

  • :profile (String) — default: "default" —

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used.

  • :request_checksum_calculation (String) — default: "when_supported" —

    Determines when a checksum will be calculated for request payloads. Values are:

    • when_supported - (default) When set, a checksum will be calculated for all request payloads of operations modeled with the httpChecksum trait where requestChecksumRequired is true and/or a requestAlgorithmMember is modeled.
    • when_required - When set, a checksum will only be calculated for request payloads of operations modeled with the httpChecksum trait where requestChecksumRequired is true or where a requestAlgorithmMember is modeled and supplied.
  • :request_min_compression_size_bytes (Integer) — default: 10240 —

    The minimum size in bytes that triggers compression for request bodies. The value must be non-negative integer value between 0 and 10485780 bytes inclusive.

  • :response_checksum_validation (String) — default: "when_supported" —

    Determines when checksum validation will be performed on response payloads. Values are:

    • when_supported - (default) When set, checksum validation is performed on all response payloads of operations modeled with the httpChecksum trait where responseAlgorithms is modeled, except when no modeled checksum algorithms are supported.
    • when_required - When set, checksum validation is not performed on response payloads of operations unless the checksum algorithm is supported and the requestValidationModeMember member is set to ENABLED.
  • :retry_backoff (Proc) —

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the legacy retry mode.

  • :retry_base_delay (Float) — default: 0.3 —

    The base delay in seconds used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_jitter (Symbol) — default: :none —

    A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the legacy retry mode.

    @see https://www.awsarchitectureblog.com/2015/03/backoff.html

  • :retry_limit (Integer) — default: 3 —

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the legacy retry mode.

  • :retry_max_delay (Integer) — default: 0 —

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_mode (String) — default: "standard" —

    Specifies which retry algorithm to use. Values are:

    • legacy - The pre-existing retry behavior.

    • standard - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make. This is the default value if no retry mode is provided.

    • adaptive - A retry mode that includes all the functionality of standard mode along with automatic client side throttling.

  • :sdk_ua_app_id (String) —

    A unique and opaque application ID that is appended to the User-Agent header as app/sdk_ua_app_id. It should have a maximum length of 50. This variable is sourced from environment variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.

  • :secret_access_key (String)
  • :session_token (String)
  • :sigv4a_signing_region_set (Array) —

    A list of regions that should be signed with SigV4a signing. When not passed, a default :sigv4a_signing_region_set is searched for in the following locations:

    • Aws.config[:sigv4a_signing_region_set]
    • ENV['AWS_SIGV4A_SIGNING_REGION_SET']
    • ~/.aws/config
  • :simple_json (Boolean) — default: false —

    Disables request parameter conversion, validation, and formatting. Also disables response data type conversions. The request parameters hash must be formatted exactly as the API expects.This option is useful when you want to ensure the highest level of performance by avoiding overhead of walking request parameters and response data structures.

  • :stub_responses (Boolean) — default: false —

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

    Please note When response stubbing is enabled, no HTTP requests are made, and retries are disabled.

  • :telemetry_provider (Aws::Telemetry::TelemetryProviderBase) — default: Aws::Telemetry::NoOpTelemetryProvider —

    Allows you to provide a telemetry provider, which is used to emit telemetry data. By default, uses NoOpTelemetryProvider which will not record or emit any telemetry data. The SDK supports the following telemetry providers:

    • OpenTelemetry (OTel) - To use the OTel provider, install and require the opentelemetry-sdk gem and then, pass in an instance of a Aws::Telemetry::OTelProvider for telemetry provider.
  • :token_provider (Aws::TokenProvider) —

    Your Bearer token used for authentication. This can be any class that includes and implements Aws::TokenProvider, or instance of any one of the following classes:

    • Aws::StaticTokenProvider - Used for configuring static, non-refreshing tokens.

    • Aws::SSOTokenProvider - Used for loading tokens from AWS SSO using an access token generated from aws login.

    When :token_provider is not configured directly, the Aws::TokenProviderChain will be used to search for tokens configured for your profile in shared configuration files.

  • :use_dualstack_endpoint (Boolean) —

    When set to true, dualstack enabled endpoints (with .aws TLD) will be used if available.

  • :use_fips_endpoint (Boolean) —

    When set to true, fips compatible endpoints will be used if available. When a fips region is used, the region is normalized and this config is set to true.

  • :validate_params (Boolean) — default: true —

    When true, request parameters are validated before sending the request.

  • :endpoint_provider (Aws::Odb::EndpointProvider) —

    The endpoint provider used to resolve endpoints. Any object that responds to #resolve_endpoint(parameters) where parameters is a Struct similar to Aws::Odb::EndpointParameters.

  • :http_continue_timeout (Float) — default: 1 —

    The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has "Expect" header set to "100-continue". Defaults to nil which disables this behaviour. This value can safely be set per request on the session.

  • :http_idle_timeout (Float) — default: 5 —

    The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request.

  • :http_open_timeout (Float) — default: 15 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_proxy (URI::HTTP, String) —

    A proxy to send requests through. Formatted like 'http://proxy.com:123'.

  • :http_read_timeout (Float) — default: 60 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_wire_trace (Boolean) — default: false —

    When true, HTTP debug output will be sent to the :logger.

  • :on_chunk_received (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the response body is received. It provides three arguments: the chunk, the number of bytes received, and the total number of bytes in the response (or nil if the server did not send a content-length).

  • :on_chunk_sent (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the request body is sent. It provides three arguments: the chunk, the number of bytes read from the body, and the total number of bytes in the body.

  • :raise_response_errors (Boolean) — default: true —

    When true, response errors are raised.

  • :ssl_ca_bundle (String) —

    Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_directory (String) —

    Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_store (String) —

    Sets the X509::Store to verify peer certificate.

  • :ssl_cert (OpenSSL::X509::Certificate) —

    Sets a client certificate when creating http connections.

  • :ssl_key (OpenSSL::PKey) —

    Sets a client key when creating http connections.

  • :ssl_timeout (Float) —

    Sets the SSL timeout in seconds

  • :ssl_verify_peer (Boolean) — default: true —

    When true, SSL peer certificates are verified when establishing a connection.



486
487
488
 
# File 'gems/aws-sdk-odb/lib/aws-sdk-odb/client.rb', line 486

def initialize(*args)
  super
end

Instance Method Details

#accept_marketplace_registration(params = {}) ⇒ Struct

Registers the Amazon Web Services Marketplace token for your Amazon Web Services account to activate your Oracle Database@Amazon Web Services subscription.

Examples:

Request syntax with placeholder values


resp = client.accept_marketplace_registration({
  marketplace_registration_token: "String", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :marketplace_registration_token (required, String) —

    The registration token that's generated by Amazon Web Services Marketplace and sent to Oracle Database@Amazon Web Services.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



512
513
514
515
 
# File 'gems/aws-sdk-odb/lib/aws-sdk-odb/client.rb', line 512

def accept_marketplace_registration(params = {}, options = {})
  req = build_request(:accept_marketplace_registration, params)
  req.send_request(options)
end

#associate_iam_role_to_resource(params = {}) ⇒ Struct

Associates an Amazon Web Services Identity and Access Management (IAM) service role with a specified resource to enable Amazon Web Services service integration.

Examples:

Request syntax with placeholder values


resp = client.associate_iam_role_to_resource({
  iam_role_arn: "RoleArn", # required
  aws_integration: "KmsTde", # required, accepts KmsTde
  resource_arn: "AssociateIamRoleToResourceInputResourceArnString", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :iam_role_arn (required, String) —

    The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) service role to associate with the resource.

  • :aws_integration (required, String) —

    The Amazon Web Services integration configuration settings for the Amazon Web Services Identity and Access Management (IAM) service role association.

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the target resource to associate with the Amazon Web Services Identity and Access Management (IAM) service role.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



549
550
551
552
 
# File 'gems/aws-sdk-odb/lib/aws-sdk-odb/client.rb', line 549

def associate_iam_role_to_resource(params = {}, options = {})
  req = build_request(:associate_iam_role_to_resource, params)
  req.send_request(options)
end

#associate_virtual_machines_to_cloud_vm_cluster(params = {}) ⇒ Types::AssociateVirtualMachinesToCloudVmClusterOutput

Adds virtual machines to the specified VM cluster.

Examples:

Request syntax with placeholder values


resp = client.associate_virtual_machines_to_cloud_vm_cluster({
  cloud_vm_cluster_id: "ResourceId", # required
  db_servers: ["String"], # required
})

Response structure


resp.display_name #=> String
resp.status #=> String, one of "AVAILABLE", "FAILED", "PROVISIONING", "TERMINATED", "TERMINATING", "UPDATING", "MAINTENANCE_IN_PROGRESS"
resp.status_reason #=> String
resp.cloud_vm_cluster_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :cloud_vm_cluster_id (required, String) —

    The unique identifier of the VM cluster to add virtual machines to.

  • :db_servers (required, Array<String>) —

    The list of database server IDs for the virtual machines to add to the VM cluster.

Returns:

See Also:



588
589
590
591
 
# File 'gems/aws-sdk-odb/lib/aws-sdk-odb/client.rb', line 588

def associate_virtual_machines_to_cloud_vm_cluster(params = {}, options = {})
  req = build_request(:associate_virtual_machines_to_cloud_vm_cluster, params)
  req.send_request(options)
end

#associate_virtual_machines_to_exadb_vm_cluster(params = {}) ⇒ Types::AssociateVirtualMachinesToExadbVmClusterOutput

Adds virtual machines to the specified Exascale VM cluster.

Examples:

Request syntax with placeholder values


resp = client.associate_virtual_machines_to_exadb_vm_cluster({
  exadb_vm_cluster_id: "ResourceIdOrArn", # required
  desired_node_count: 1, # required
})

Response structure


resp.display_name #=> String
resp.status #=> String, one of "AVAILABLE", "FAILED", "PROVISIONING", "TERMINATED", "TERMINATING", "UPDATING", "MAINTENANCE_IN_PROGRESS"
resp.status_reason #=> String
resp.exadb_vm_cluster_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :exadb_vm_cluster_id (required, String) —

    The unique identifier of the Exascale VM cluster to add virtual machines to.

  • :desired_node_count (required, Integer) —

    The desired number of nodes in the Exascale VM cluster after the association.

Returns:

See Also:



628
629
630
631
 
# File 'gems/aws-sdk-odb/lib/aws-sdk-odb/client.rb', line 628

def associate_virtual_machines_to_exadb_vm_cluster(params = {}, options = {})
  req = build_request(:associate_virtual_machines_to_exadb_vm_cluster, params)
  req.send_request(options)
end

#create_autonomous_database(params = {}) ⇒ Types::CreateAutonomousDatabaseOutput

Creates a new Autonomous Database.

Examples:

Request syntax with placeholder values


resp = client.create_autonomous_database({
  odb_network_id: "ResourceIdOrArn",
  display_name: "ResourceDisplayName",
  db_name: "CreateAutonomousDatabaseInputDbNameString",
  admin_password: "CreateAutonomousDatabaseInputAdminPasswordString",
  compute_count: 1.0,
  data_storage_size_in_t_bs: 1,
  data_storage_size_in_g_bs: 1,
  db_workload: "OLTP", # accepts OLTP, AJD, APEX, LH
  is_auto_scaling_enabled: false,
  is_auto_scaling_for_storage_enabled: false,
  license_model: "BRING_YOUR_OWN_LICENSE", # accepts BRING_YOUR_OWN_LICENSE, LICENSE_INCLUDED
  character_set: "CreateAutonomousDatabaseInputCharacterSetString",
  ncharacter_set: "CreateAutonomousDatabaseInputNcharacterSetString",
  db_version: "CreateAutonomousDatabaseInputDbVersionString",
  database_edition: "STANDARD_EDITION", # accepts STANDARD_EDITION, ENTERPRISE_EDITION
  standby_allowlisted_ips_source: "PRIMARY", # accepts PRIMARY, SEPARATE, NOT_APPLICABLE
  autonomous_maintenance_schedule_type: "EARLY", # accepts EARLY, REGULAR
  backup_retention_period_in_days: 1,
  byol_compute_count_limit: 1.0,
  cpu_core_count: 1,
  customer_contacts_to_send_to_oci: [
    {
      email: "CustomerContactEmailString",
    },
  ],
  private_endpoint_ip: "String",
  private_endpoint_label: "String",
  resource_pool_leader_id: "ResourceIdOrArn",
  resource_pool_summary: {
    is_disabled: false,
    pool_size: 1,
    pool_storage_size_in_t_bs: 1,
    available_storage_capacity_in_t_bs: 1.0,
    total_compute_capacity: 1,
    available_compute_capacity: 1,
  },
  scheduled_operations: [
    {
      day_of_week: { # required
        name: "MONDAY", # accepts MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY
      },
      scheduled_start_time: "String",
      scheduled_stop_time: "String",
    },
  ],
  standby_allowlisted_ips: ["String"],
  allowlisted_ips: ["String"],
  transportable_tablespace: {
    tts_bundle_url: "String",
  },
  is_backup_retention_locked: false,
  is_local_data_guard_enabled: false,
  is_mtls_connection_required: false,
  db_tools_details: [
    {
      is_enabled: false,
      name: "String",
      compute_count: 1.0,
      max_idle_time_in_minutes: 1,
    },
  ],
  source: "NONE", # accepts NONE, DATABASE, BACKUP_FROM_ID, BACKUP_FROM_TIMESTAMP, CROSS_REGION_DATAGUARD, CROSS_REGION_DISASTER_RECOVERY, CLONE_TO_REFRESHABLE
  source_configuration: {
    database_clone: {
      source_autonomous_database_id: "ResourceIdOrArn", # required
      clone_type: "FULL", # required, accepts FULL, METADATA, PARTIAL
    },
    restore_from_backup: {
      autonomous_database_backup_id: "ResourceIdOrArn", # required
      clone_type: "FULL", # required, accepts FULL, METADATA, PARTIAL
      clone_table_space_list: [1],
    },
    point_in_time_restore: {
      source_autonomous_database_id: "ResourceIdOrArn", # required
      clone_type: "FULL", # required, accepts FULL, METADATA, PARTIAL
      timestamp: Time.now,
      use_latest_available_backup_timestamp: false,
      clone_table_space_list: [1],
    },
    cross_region_data_guard: {
      source_autonomous_database_arn: "Arn", # required
    },
    cross_region_disaster_recovery: {
      source_autonomous_database_arn: "Arn", # required
      remote_disaster_recovery_type: "ADG", # required, accepts ADG, BACKUP_BASED
      is_replicate_automatic_backups: false,
    },
    clone_to_refreshable: {
      source_autonomous_database_id: "ResourceIdOrArn", # required
      refreshable_mode: "AUTOMATIC", # accepts AUTOMATIC, MANUAL
      auto_refresh_frequency_in_seconds: 1,
      auto_refresh_point_lag_in_seconds: 1,
      time_of_auto_refresh_start: Time.now,
      open_mode: "READ_ONLY", # accepts READ_ONLY, READ_WRITE
      clone_type: "FULL", # accepts FULL, METADATA, PARTIAL
    },
  },
  encryption_key_provider: "ORACLE_MANAGED", # accepts ORACLE_MANAGED, AWS_KMS
  encryption_key_configuration: {
    aws_encryption_key: {
      iam_role_arn: "RoleArn",
      external_id_type: "database_ocid", # accepts database_ocid, compartment_ocid, tenant_ocid
      kms_key_id: "KmsKeyIdOrArn",
    },
  },
  admin_password_source: "CUSTOMER_MANAGED_AWS_SECRET", # accepts CUSTOMER_MANAGED_AWS_SECRET, API_REQUEST_PARAMETER
  admin_password_source_configuration: {
    customer_managed_aws_secret: {
      secret_id: "SecretIdOrArn",
      iam_role_arn: "RoleArn",
      external_id_type: "database_ocid", # accepts database_ocid, compartment_ocid, tenant_ocid
    },
  },
  client_token: "CreateAutonomousDatabaseInputClientTokenString",
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.autonomous_database_id #=> String
resp.display_name #=> String
resp.status #=> String, one of "AVAILABLE", "FAILED", "PROVISIONING", "TERMINATED", "TERMINATING", "UPDATING", "MAINTENANCE_IN_PROGRESS", "STOPPING", "STOPPED", "STARTING", "UNAVAILABLE", "RESTORE_IN_PROGRESS", "RESTORE_FAILED", "BACKUP_IN_PROGRESS", "SCALE_IN_PROGRESS", "AVAILABLE_NEEDS_ATTENTION", "RESTARTING", "RECREATING", "ROLE_CHANGE_IN_PROGRESS", "UPGRADING", "INACCESSIBLE", "STANDBY"
resp.status_reason #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :odb_network_id (String) —

    The unique identifier of the ODB network to be used for the Autonomous Database.

  • :display_name (String) —

    The user-friendly name for the Autonomous Database. The name does not have to be unique.

  • :db_name (String) —

    The name of the Autonomous Database. The name must begin with an alphabetic character and can contain a maximum of 30 alphanumeric characters. Special characters are not permitted. The name must be unique in the Amazon Web Services account.

  • :admin_password (String) —

    The password for the ADMIN user of the Autonomous Database.

  • :compute_count (Float) —

    The compute capacity, in number of Elastic CPUs (ECPUs) or Oracle CPUs (OCPUs), to assign to the Autonomous Database.

  • :data_storage_size_in_t_bs (Integer) —

    The size, in terabytes (TB), of the data volume to allocate for the Autonomous Database.

  • :data_storage_size_in_g_bs (Integer) —

    The size, in gigabytes (GB), of the data volume to allocate for the Autonomous Database.

  • :db_workload (String) —

    The intended use of the Autonomous Database, such as transaction processing, data warehouse, JSON database, or APEX.

  • :is_auto_scaling_enabled (Boolean) —

    Specifies whether to enable automatic scaling of the compute resources for the Autonomous Database.

  • :is_auto_scaling_for_storage_enabled (Boolean) —

    Specifies whether to enable automatic scaling of the storage for the Autonomous Database.

  • :license_model (String) —

    The Oracle license model to apply to the Autonomous Database.

  • :character_set (String) —

    The character set to use for the Autonomous Database.

  • :ncharacter_set (String) —

    The national character set to use for the Autonomous Database.

  • :db_version (String) —

    The Oracle Database software version to use for the Autonomous Database.

  • :database_edition (String) —

    The Oracle Database edition to apply to the Autonomous Database.

  • :standby_allowlisted_ips_source (String) —

    The source of the allowlisted IP addresses for the standby Autonomous Database.

  • :autonomous_maintenance_schedule_type (String) —

    The maintenance schedule type for the Autonomous Database.

  • :backup_retention_period_in_days (Integer) —

    The retention period, in days, for automatic backups of the Autonomous Database.

  • :byol_compute_count_limit (Float) —

    The maximum number of compute resources that you can allocate to the Autonomous Database under the bring-your-own-license (BYOL) model.

  • :cpu_core_count (Integer) —

    The number of CPU cores to allocate to the Autonomous Database.

  • :customer_contacts_to_send_to_oci (Array<Types::CustomerContact>) —

    The list of customer contacts to receive operational notifications from Oracle Cloud Infrastructure (OCI) for the Autonomous Database.

  • :private_endpoint_ip (String) —

    The private endpoint IP address for the Autonomous Database.

  • :private_endpoint_label (String) —

    The private endpoint label for the Autonomous Database.

  • :resource_pool_leader_id (String) —

    The unique identifier of the resource pool leader Autonomous Database.

  • :resource_pool_summary (Types::ResourcePoolSummary) —

    The configuration of the resource pool for the Autonomous Database.

  • :scheduled_operations (Array<Types::ScheduledOperationDetails>) —

    The list of scheduled start and stop times for the Autonomous Database.

  • :standby_allowlisted_ips (Array<String>) —

    The list of IP addresses that are allowed to access the standby Autonomous Database.

  • :allowlisted_ips (Array<String>) —

    The list of IP addresses that are allowed to access the Autonomous Database.

  • :transportable_tablespace (Types::TransportableTablespace) —

    The transportable tablespace configuration to use when creating the Autonomous Database.

  • :is_backup_retention_locked (Boolean) —

    Specifies whether to lock the backup retention period of the Autonomous Database to prevent it from being shortened.

  • :is_local_data_guard_enabled (Boolean) —

    Specifies whether to enable local Oracle Data Guard for the Autonomous Database.

  • :is_mtls_connection_required (Boolean) —

    Specifies whether mutual TLS (mTLS) authentication is required to connect to the Autonomous Database.

  • :db_tools_details (Array<Types::DatabaseTool>) —

    The list of database management tools to enable for the Autonomous Database.

  • :source (String) —

    The source from which to create the Autonomous Database, such as a clone, backup, or cross-Region copy.

  • :source_configuration (Types::SourceConfiguration) —

    The configuration details for the source used to create the Autonomous Database.

  • :encryption_key_provider (String) —

    The provider of the encryption key to use for the Autonomous Database.

  • :encryption_key_configuration (Types::EncryptionKeyConfigurationInput) —

    The configuration of the encryption key to use for the Autonomous Database.

  • :admin_password_source (String) —

    The source of the admin password for the Autonomous Database. When set to CUSTOMER_MANAGED_AWS_SECRET, the admin password is retrieved from an Amazon Web Services Secrets Manager secret.

  • :admin_password_source_configuration (Types::AdminPasswordSourceConfigurationInput) —

    The configuration of the admin password source for the Autonomous Database.

  • :client_token (String) —

    A client-provided token to ensure the idempotency of the request.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :tags (Hash<String,String>) —

    The list of resource tags to apply to the Autonomous Database. Each tag is a key-value pair with no predefined name, type, or namespace.

Returns:

See Also:



932
933
934
935
 
# File 'gems/aws-sdk-odb/lib/aws-sdk-odb/client.rb', line 932

def create_autonomous_database(params = {}, options = {})
  req = build_request(:create_autonomous_database, params)
  req.send_request(options)
end

#create_autonomous_database_backup(params = {}) ⇒ Types::CreateAutonomousDatabaseBackupOutput

Creates a new backup of the specified Autonomous Database.

Examples:

Request syntax with placeholder values


resp = client.create_autonomous_database_backup({
  autonomous_database_id: "ResourceIdOrArn", # required
  display_name: "ResourceDisplayName",
  retention_period_in_days: 1,
  client_token: "CreateAutonomousDatabaseBackupInputClientTokenString",
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.display_name #=> String
resp.status #=> String, one of "AVAILABLE", "FAILED", "PROVISIONING", "TERMINATED", "TERMINATING", "UPDATING", "MAINTENANCE_IN_PROGRESS"
resp.status_reason #=> String
resp.autonomous_database_backup_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :autonomous_database_id (required, String) —

    The unique identifier of the Autonomous Database to back up.

  • :display_name (String) —

    The user-friendly name for the Autonomous Database backup.

  • :retention_period_in_days (Integer) —

    The retention period, in days, for the Autonomous Database backup.

  • :client_token (String) —

    A client-provided token to ensure the idempotency of the request.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :tags (Hash<String,String>) —

    The list of resource tags to apply to the Autonomous Database backup. Each tag is a key-value pair with no predefined name, type, or namespace.

Returns:

See Also:



989
990
991
992
 
# File 'gems/aws-sdk-odb/lib/aws-sdk-odb/client.rb', line 989

def create_autonomous_database_backup(params = {}, options = {})
  req = build_request(:create_autonomous_database_backup, params)
  req.send_request(options)
end

#create_autonomous_database_wallet(params = {}) ⇒ Types::CreateAutonomousDatabaseWalletOutput

Creates a new wallet for the specified Autonomous Database.

Examples:

Request syntax with placeholder values


resp = client.create_autonomous_database_wallet({
  autonomous_database_id: "ResourceIdOrArn", # required
  wallet_type: "REGIONAL", # accepts REGIONAL, INSTANCE
  password: "CreateAutonomousDatabaseWalletInputPasswordString",
  password_source: "CUSTOMER_MANAGED_AWS_SECRET", # accepts CUSTOMER_MANAGED_AWS_SECRET, API_REQUEST_PARAMETER
  password_source_configuration: {
    customer_managed_aws_secret: {
      secret_id: "SecretIdOrArn",
      iam_role_arn: "RoleArn",
      external_id_type: "database_ocid", # accepts database_ocid, compartment_ocid, tenant_ocid
    },
  },
  client_token: "CreateAutonomousDatabaseWalletInputClientTokenString",
})

Response structure


resp.autonomous_database_wallet_file #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :autonomous_database_id (required, String) —

    The unique identifier of the Autonomous Database to create a wallet for.

  • :wallet_type (String) —

    The type of wallet to create, either a regional wallet or an instance wallet.

  • :password (String) —

    The password to encrypt the keys inside the wallet.

  • :password_source (String) —

    The source of the password for encrypting the wallet. When set to CUSTOMER_MANAGED_AWS_SECRET, the password is retrieved from an Amazon Web Services Secrets Manager secret.

  • :password_source_configuration (Types::WalletPasswordSourceConfigurationInput) —

    The configuration of the password source for the Autonomous Database wallet.

  • :client_token (String) —

    A client-provided token to ensure the idempotency of the request.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

See Also:



1051
1052
1053
1054
 
# File 'gems/aws-sdk-odb/lib/aws-sdk-odb/client.rb', line 1051

def create_autonomous_database_wallet(params = {}, options = {})
  req = build_request(:create_autonomous_database_wallet, params)
  req.send_request(options)
end

#create_cloud_autonomous_vm_cluster(params = {}) ⇒ Types::CreateCloudAutonomousVmClusterOutput

Creates a new Autonomous VM cluster in the specified Exadata infrastructure.

Examples:

Request syntax with placeholder values


resp = client.create_cloud_autonomous_vm_cluster({
  cloud_exadata_infrastructure_id: "ResourceIdOrArn", # required
  odb_network_id: "ResourceIdOrArn", # required
  display_name: "ResourceDisplayName", # required
  client_token: "CreateCloudAutonomousVmClusterInputClientTokenString",
  autonomous_data_storage_size_in_t_bs: 1.0, # required
  cpu_core_count_per_node: 1, # required
  db_servers: ["String"],
  description: "CreateCloudAutonomousVmClusterInputDescriptionString",
  is_mtls_enabled_vm_cluster: false,
  license_model: "BRING_YOUR_OWN_LICENSE", # accepts BRING_YOUR_OWN_LICENSE, LICENSE_INCLUDED
  maintenance_window: {
    custom_action_timeout_in_mins: 1,
    days_of_week: [
      {
        name: "MONDAY", # accepts MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY
      },
    ],
    hours_of_day: [1],
    is_custom_action_timeout_enabled: false,
    lead_time_in_weeks: 1,
    months: [
      {
        name: "JANUARY", # accepts JANUARY, FEBRUARY, MARCH, APRIL, MAY, JUNE, JULY, AUGUST, SEPTEMBER, OCTOBER, NOVEMBER, DECEMBER
      },
    ],
    patching_mode: "ROLLING", # accepts ROLLING, NONROLLING
    preference: "NO_PREFERENCE", # accepts NO_PREFERENCE, CUSTOM_PREFERENCE
    skip_ru: false,
    weeks_of_month: [1],
  },
  memory_per_oracle_compute_unit_in_g_bs: 1, # required
  scan_listener_port_non_tls: 1,
  scan_listener_port_tls: 1,
  tags: {
    "TagKey" => "TagValue",
  },
  time_zone: "CreateCloudAutonomousVmClusterInputTimeZoneString",
  total_container_databases: 1, # required
})

Response structure


resp.display_name #=> String
resp.status #=> String, one of "AVAILABLE", "FAILED", "PROVISIONING", "TERMINATED", "TERMINATING", "UPDATING", "MAINTENANCE_IN_PROGRESS"
resp.status_reason #=> String
resp.cloud_autonomous_vm_cluster_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :cloud_exadata_infrastructure_id (required, String) —

    The unique identifier of the Exadata infrastructure where the VM cluster will be created.

  • :odb_network_id (required, String) —

    The unique identifier of the ODB network to be used for the VM cluster.

  • :display_name (required, String) —

    The display name for the Autonomous VM cluster. The name does not need to be unique.

  • :client_token (String) —

    A client-provided token to ensure idempotency of the request.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :autonomous_data_storage_size_in_t_bs (required, Float) —

    The data disk group size to be allocated for Autonomous Databases, in terabytes (TB).

  • :cpu_core_count_per_node (required, Integer) —

    The number of CPU cores to be enabled per VM cluster node.

  • :db_servers (Array<String>) —

    The list of database servers to be used for the Autonomous VM cluster.

  • :description (String) —

    A user-provided description of the Autonomous VM cluster.

  • :is_mtls_enabled_vm_cluster (Boolean) —

    Specifies whether to enable mutual TLS (mTLS) authentication for the Autonomous VM cluster.

  • :license_model (String) —

    The Oracle license model to apply to the Autonomous VM cluster.

  • :maintenance_window (Types::MaintenanceWindow) —

    The scheduling details for the maintenance window. Patching and system updates take place during the maintenance window.

  • :memory_per_oracle_compute_unit_in_g_bs (required, Integer) —

    The amount of memory to be allocated per OCPU, in GB.

  • :scan_listener_port_non_tls (Integer) —

    The SCAN listener port for non-TLS (TCP) protocol.

  • :scan_listener_port_tls (Integer) —

    The SCAN listener port for TLS (TCP) protocol.

  • :tags (Hash<String,String>) —

    Free-form tags for this resource. Each tag is a key-value pair with no predefined name, type, or namespace.

  • :time_zone (String) —

    The time zone to use for the Autonomous VM cluster.

  • :total_container_databases (required, Integer) —

    The total number of Autonomous CDBs that you can create in the Autonomous VM cluster.

Returns:

See Also:



1182
1183
1184
1185
 
# File 'gems/aws-sdk-odb/lib/aws-sdk-odb/client.rb', line 1182

def create_cloud_autonomous_vm_cluster(params = {}, options = {})
  req = build_request(:create_cloud_autonomous_vm_cluster, params)
  req.send_request(options)
end

#create_cloud_exadata_infrastructure(params = {}) ⇒ Types::CreateCloudExadataInfrastructureOutput

Creates an Exadata infrastructure.

Examples:

Request syntax with placeholder values


resp = client.create_cloud_exadata_infrastructure({
  display_name: "ResourceDisplayName", # required
  shape: "CreateCloudExadataInfrastructureInputShapeString", # required
  availability_zone: "CreateCloudExadataInfrastructureInputAvailabilityZoneString",
  availability_zone_id: "CreateCloudExadataInfrastructureInputAvailabilityZoneIdString",
  tags: {
    "TagKey" => "TagValue",
  },
  compute_count: 1, # required
  customer_contacts_to_send_to_oci: [
    {
      email: "CustomerContactEmailString",
    },
  ],
  maintenance_window: {
    custom_action_timeout_in_mins: 1,
    days_of_week: [
      {
        name: "MONDAY", # accepts MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY
      },
    ],
    hours_of_day: [1],
    is_custom_action_timeout_enabled: false,
    lead_time_in_weeks: 1,
    months: [
      {
        name: "JANUARY", # accepts JANUARY, FEBRUARY, MARCH, APRIL, MAY, JUNE, JULY, AUGUST, SEPTEMBER, OCTOBER, NOVEMBER, DECEMBER
      },
    ],
    patching_mode: "ROLLING", # accepts ROLLING, NONROLLING
    preference: "NO_PREFERENCE", # accepts NO_PREFERENCE, CUSTOM_PREFERENCE
    skip_ru: false,
    weeks_of_month: [1],
  },
  storage_count: 1, # required
  client_token: "CreateCloudExadataInfrastructureInputClientTokenString",
  database_server_type: "CreateCloudExadataInfrastructureInputDatabaseServerTypeString",
  storage_server_type: "CreateCloudExadataInfrastructureInputStorageServerTypeString",
})

Response structure


resp.display_name #=> String
resp.status #=> String, one of "AVAILABLE", "FAILED", "PROVISIONING", "TERMINATED", "TERMINATING", "UPDATING", "MAINTENANCE_IN_PROGRESS"
resp.status_reason #=> String
resp.cloud_exadata_infrastructure_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :display_name (required, String) —

    A user-friendly name for the Exadata infrastructure.

  • :shape (required, String) —

    The model name of the Exadata infrastructure. For the list of valid model names, use the ListDbSystemShapes operation.

  • :availability_zone (String) —

    The name of the Availability Zone (AZ) where the Exadata infrastructure is located.

    This operation requires that you specify a value for either availabilityZone or availabilityZoneId.

    Example: us-east-1a

  • :availability_zone_id (String) —

    The AZ ID of the AZ where the Exadata infrastructure is located.

    This operation requires that you specify a value for either availabilityZone or availabilityZoneId.

    Example: use1-az1

  • :tags (Hash<String,String>) —

    The list of resource tags to apply to the Exadata infrastructure.

  • :compute_count (required, Integer) —

    The number of database servers for the Exadata infrastructure. Valid values for this parameter depend on the shape. To get information about the minimum and maximum values, use the ListDbSystemShapes operation.

  • :customer_contacts_to_send_to_oci (Array<Types::CustomerContact>) —

    The email addresses of contacts to receive notification from Oracle about maintenance updates for the Exadata infrastructure.

  • :maintenance_window (Types::MaintenanceWindow) —

    The maintenance window configuration for the Exadata Cloud infrastructure.

    This allows you to define when maintenance operations such as patching and updates can be performed on the infrastructure.

  • :storage_count (required, Integer) —

    The number of storage servers to activate for this Exadata infrastructure. Valid values for this parameter depend on the shape. To get information about the minimum and maximum values, use the ListDbSystemShapes operation.

  • :client_token (String) —

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it for the request to ensure idempotency. The client token is valid for up to 24 hours after it's first used.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :database_server_type (String) —

    The database server model type of the Exadata infrastructure. For the list of valid model names, use the ListDbSystemShapes operation.

  • :storage_server_type (String) —

    The storage server model type of the Exadata infrastructure. For the list of valid model names, use the ListDbSystemShapes operation.

Returns:

See Also:



1317
1318
1319
1320
 
# File 'gems/aws-sdk-odb/lib/aws-sdk-odb/client.rb', line 1317

def create_cloud_exadata_infrastructure(params = {}, options = {})
  req = build_request(:create_cloud_exadata_infrastructure, params)
  req.send_request(options)
end

#create_cloud_vm_cluster(params = {}) ⇒ Types::CreateCloudVmClusterOutput

Creates a VM cluster on the specified Exadata infrastructure.

Examples:

Request syntax with placeholder values


resp = client.create_cloud_vm_cluster({
  cloud_exadata_infrastructure_id: "ResourceIdOrArn", # required
  exascale_db_storage_vault_id: "ResourceIdOrArn",
  vm_file_system_storage_type: "LOCAL", # accepts LOCAL, EXASCALE
  vm_backup_storage_type: "LOCAL", # accepts LOCAL, EXASCALE
  file_system_configuration_details: [
    {
      mount_point: "String",
      file_system_size_in_g_bs: 1,
    },
  ],
  cpu_core_count: 1, # required
  display_name: "ResourceDisplayName", # required
  gi_version: "CreateCloudVmClusterInputGiVersionString", # required
  hostname: "Hostname", # required
  ssh_public_keys: ["String"], # required
  odb_network_id: "ResourceIdOrArn", # required
  cluster_name: "ClusterName",
  data_collection_options: {
    is_diagnostics_events_enabled: false,
    is_health_monitoring_enabled: false,
    is_incident_logs_enabled: false,
  },
  data_storage_size_in_t_bs: 1.0,
  db_node_storage_size_in_g_bs: 1,
  db_servers: ["String"],
  tags: {
    "TagKey" => "TagValue",
  },
  is_local_backup_enabled: false,
  is_sparse_diskgroup_enabled: false,
  license_model: "BRING_YOUR_OWN_LICENSE", # accepts BRING_YOUR_OWN_LICENSE, LICENSE_INCLUDED
  memory_size_in_g_bs: 1,
  system_version: "CreateCloudVmClusterInputSystemVersionString",
  time_zone: "CreateCloudVmClusterInputTimeZoneString",
  client_token: "CreateCloudVmClusterInputClientTokenString",
  scan_listener_port_tcp: 1,
})

Response structure


resp.display_name #=> String
resp.status #=> String, one of "AVAILABLE", "FAILED", "PROVISIONING", "TERMINATED", "TERMINATING", "UPDATING", "MAINTENANCE_IN_PROGRESS"
resp.status_reason #=> String
resp.cloud_vm_cluster_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :cloud_exadata_infrastructure_id (required, String) —

    The unique identifier of the Exadata infrastructure for this VM cluster.

  • :exascale_db_storage_vault_id (String) —

    The unique identifier or Amazon Resource Name (ARN) of the Exascale storage vault to use for the VM cluster. Specify this value to create a VM cluster that uses Exascale storage on dedicated Exadata infrastructure.

  • :vm_file_system_storage_type (String) —

    The type of storage to use for the VM file systems. Specify EXASCALE to store the VM file systems in Exascale storage on the storage servers, or LOCAL to store them on the database servers.

  • :vm_backup_storage_type (String) —

    The type of storage to use for VM backups. Specify EXASCALE to store VM backups in Exascale storage on the storage servers, or LOCAL to store them on the database servers.

  • :file_system_configuration_details (Array<Types::FileSystemConfigurationDetails>) —

    The list of file system configurations for the VM cluster. Each entry specifies the mount point of a file system and its size, in gigabytes (GB).

  • :cpu_core_count (required, Integer) —

    The number of CPU cores to enable on the VM cluster.

  • :display_name (required, String) —

    A user-friendly name for the VM cluster.

  • :gi_version (required, String) —

    A valid software version of Oracle Grid Infrastructure (GI). To get the list of valid values, use the ListGiVersions operation and specify the shape of the Exadata infrastructure.

    Example: 19.0.0.0

  • :hostname (required, String) —

    The host name for the VM cluster.

    Constraints:

    • Can't be "localhost" or "hostname".

    • Can't contain "-version".

    • The maximum length of the combined hostname and domain is 63 characters.

    • The hostname must be unique within the subnet.

  • :ssh_public_keys (required, Array<String>) —

    The public key portion of one or more key pairs used for SSH access to the VM cluster.

  • :odb_network_id (required, String) —

    The unique identifier of the ODB network for the VM cluster.

  • :cluster_name (String) —

    A name for the Grid Infrastructure cluster. The name isn't case sensitive.

  • :data_collection_options (Types::DataCollectionOptions) —

    The set of preferences for the various diagnostic collection options for the VM cluster.

  • :data_storage_size_in_t_bs (Float) —

    The size of the data disk group, in terabytes (TBs), to allocate for the VM cluster.

  • :db_node_storage_size_in_g_bs (Integer) —

    The amount of local node storage, in gigabytes (GB), to allocate for the VM cluster.

  • :db_servers (Array<String>) —

    The list of database servers for the VM cluster.

  • :tags (Hash<String,String>) —

    The list of resource tags to apply to the VM cluster.

  • :is_local_backup_enabled (Boolean) —

    Specifies whether to enable database backups to local Exadata storage for the VM cluster.

  • :is_sparse_diskgroup_enabled (Boolean) —

    Specifies whether to create a sparse disk group for the VM cluster.

  • :license_model (String) —

    The Oracle license model to apply to the VM cluster.

    Default: LICENSE_INCLUDED

  • :memory_size_in_g_bs (Integer) —

    The amount of memory, in gigabytes (GB), to allocate for the VM cluster.

  • :system_version (String) —

    The version of the operating system of the image for the VM cluster.

  • :time_zone (String) —

    The time zone for the VM cluster. For a list of valid values for time zone, you can check the options in the console.

    Default: UTC

  • :client_token (String) —

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it for the request to ensure idempotency. The client token is valid for up to 24 hours after it's first used.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :scan_listener_port_tcp (Integer) —

    The port number for TCP connections to the single client access name (SCAN) listener.

    Valid values: 1024–8999 with the following exceptions: 2484, 6100, 6200, 7060, 7070, 7085, and 7879

    Default: 1521

Returns:

See Also:



1508
1509
1510
1511
 
# File 'gems/aws-sdk-odb/lib/aws-sdk-odb/client.rb', line 1508

def create_cloud_vm_cluster(params = {}, options = {})
  req = build_request(:create_cloud_vm_cluster, params)
  req.send_request(options)
end

#create_exadb_vm_cluster(params = {}) ⇒ Types::CreateExadbVmClusterOutput

Creates an Exascale VM cluster.

Examples:

Request syntax with placeholder values


resp = client.create_exadb_vm_cluster({
  display_name: "ResourceDisplayName", # required
  enabled_ecpu_count: 1, # required
  exascale_db_storage_vault_id: "ResourceIdOrArn", # required
  grid_image_id: "CreateExadbVmClusterInputGridImageIdString", # required
  hostname: "Hostname", # required
  node_count: 1, # required
  odb_network_id: "ResourceIdOrArn", # required
  shape: "CreateExadbVmClusterInputShapeString", # required
  ssh_public_keys: ["String"], # required
  total_ecpu_count: 1, # required
  vm_file_system_storage_total_size_in_g_bs: 1, # required
  cluster_name: "ClusterName",
  data_collection_options: {
    is_diagnostics_events_enabled: false,
    is_health_monitoring_enabled: false,
    is_incident_logs_enabled: false,
  },
  license_model: "BRING_YOUR_OWN_LICENSE", # accepts BRING_YOUR_OWN_LICENSE, LICENSE_INCLUDED
  scan_listener_port_tcp: 1,
  scan_listener_port_tcp_ssl: 1,
  shape_attribute: "SMART_STORAGE", # accepts SMART_STORAGE, BLOCK_STORAGE
  system_version: "CreateExadbVmClusterInputSystemVersionString",
  tags: {
    "TagKey" => "TagValue",
  },
  time_zone: "CreateExadbVmClusterInputTimeZoneString",
  client_token: "CreateExadbVmClusterInputClientTokenString",
})

Response structure


resp.display_name #=> String
resp.status #=> String, one of "AVAILABLE", "FAILED", "PROVISIONING", "TERMINATED", "TERMINATING", "UPDATING", "MAINTENANCE_IN_PROGRESS"
resp.status_reason #=> String
resp.exadb_vm_cluster_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :display_name (required, String) —

    A user-friendly name for the Exascale VM cluster.

  • :enabled_ecpu_count (required, Integer) —

    The number of ECPUs to enable for the Exascale VM cluster.

  • :exascale_db_storage_vault_id (required, String) —

    The unique identifier of the Exascale storage vault for this Exascale VM cluster.

  • :grid_image_id (required, String) —

    The Grid Infrastructure software image ID for the Exascale VM cluster.

  • :hostname (required, String) —

    The host name for the Exascale VM cluster.

  • :node_count (required, Integer) —

    The number of nodes in the Exascale VM cluster.

  • :odb_network_id (required, String) —

    The unique identifier of the ODB network for the Exascale VM cluster.

  • :shape (required, String) —

    The shape of the Exascale VM cluster.

  • :ssh_public_keys (required, Array<String>) —

    The public key portion of one or more key pairs used for SSH access to the Exascale VM cluster.

  • :total_ecpu_count (required, Integer) —

    The total number of ECPUs for the Exascale VM cluster.

  • :vm_file_system_storage_total_size_in_g_bs (required, Integer) —

    The total amount of file system storage, in gigabytes (GB), for the Exascale VM cluster.

  • :cluster_name (String) —

    A name for the Grid Infrastructure cluster. The name isn't case sensitive.

  • :data_collection_options (Types::DataCollectionOptions) —

    The set of preferences for the various diagnostic collection options for the Exascale VM cluster.

  • :license_model (String) —

    The Oracle license model to apply to the Exascale VM cluster.

  • :scan_listener_port_tcp (Integer) —

    The port number for TCP connections to the Single Client Access Name (SCAN) listener.

  • :scan_listener_port_tcp_ssl (Integer) —

    Reserved for future use.

  • :shape_attribute (String) —

    The shape attribute for the Exascale VM cluster.

  • :system_version (String) —

    The version of the operating system of the image for the Exascale VM cluster.

  • :tags (Hash<String,String>) —

    The list of resource tags to apply to the Exascale VM cluster.

  • :time_zone (String) —

    The time zone for the Exascale VM cluster.

  • :client_token (String) —

    A unique, case-sensitive identifier that you provide to ensure that the operation completes no more than one time. If you submit the same request twice with the same client token, the service ignores the second request and returns the result of the first. If you don't specify a client token, the AWS SDK automatically generates one. The client token is valid for up to 24 hours after it's first used.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

See Also:



1643
1644
1645
1646
 
# File 'gems/aws-sdk-odb/lib/aws-sdk-odb/client.rb', line 1643

def create_exadb_vm_cluster(params = {}, options = {})
  req = build_request(:create_exadb_vm_cluster, params)
  req.send_request(options)
end

#create_exascale_db_storage_vault(params = {}) ⇒ Types::CreateExascaleDbStorageVaultOutput

Creates an Exascale storage vault.

To create the Exascale storage vault on dedicated Exadata infrastructure, specify cloudExadataInfrastructureId.

Examples:

Request syntax with placeholder values


resp = client.create_exascale_db_storage_vault({
  display_name: "ResourceDisplayName", # required
  high_capacity_database_storage_total_size_in_g_bs: 1, # required
  additional_flash_cache_in_percent: 1,
  autoscale_limit_in_g_bs: 1,
  cloud_exadata_infrastructure_id: "ResourceIdOrArn",
  availability_zone_id: "CreateExascaleDbStorageVaultInputAvailabilityZoneIdString",
  availability_zone: "CreateExascaleDbStorageVaultInputAvailabilityZoneString",
  description: "CreateExascaleDbStorageVaultInputDescriptionString",
  is_autoscale_enabled: false,
  tags: {
    "TagKey" => "TagValue",
  },
  time_zone: "CreateExascaleDbStorageVaultInputTimeZoneString",
  client_token: "CreateExascaleDbStorageVaultInputClientTokenString",
})

Response structure


resp.display_name #=> String
resp.status #=> String, one of "AVAILABLE", "FAILED", "PROVISIONING", "TERMINATED", "TERMINATING", "UPDATING", "MAINTENANCE_IN_PROGRESS"
resp.status_reason #=> String
resp.exascale_db_storage_vault_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :display_name (required, String) —

    A user-friendly name for the Exascale storage vault.

  • :high_capacity_database_storage_total_size_in_g_bs (required, Integer) —

    The total size of the high-capacity database storage, in gigabytes (GB), for the Exascale storage vault.

  • :additional_flash_cache_in_percent (Integer) —

    The additional flash cache percentage for the Exascale storage vault.

  • :autoscale_limit_in_g_bs (Integer) —

    The autoscale limit in gigabytes (GB) for the Exascale storage vault.

  • :cloud_exadata_infrastructure_id (String) —

    The unique identifier or Amazon Resource Name (ARN) of the Exadata infrastructure on which to create the Exascale storage vault. Specify this value to create the Exascale storage vault on dedicated Exadata infrastructure that has Exascale storage configured. If you specify availabilityZone or availabilityZoneId, the value must match the Availability Zone of the Exadata infrastructure. If you specify neither, the service uses the Availability Zone of the Exadata infrastructure.

  • :availability_zone_id (String) —

    The Availability Zone ID for the Exascale storage vault.

  • :availability_zone (String) —

    The Availability Zone for the Exascale storage vault.

  • :description (String) —

    A description of the Exascale storage vault.

  • :is_autoscale_enabled (Boolean) —

    Specifies whether autoscaling is enabled for the Exascale storage vault.

  • :tags (Hash<String,String>) —

    The list of resource tags to apply to the Exascale storage vault.

  • :time_zone (String) —

    The time zone for the Exascale storage vault.

  • :client_token (String) —

    A unique, case-sensitive identifier that you provide to ensure that the operation completes no more than one time. If you submit the same request twice with the same client token, the service ignores the second request and returns the result of the first. If you don't specify a client token, the AWS SDK automatically generates one. The client token is valid for up to 24 hours after it's first used.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

See Also:



1743
1744
1745
1746
 
# File 'gems/aws-sdk-odb/lib/aws-sdk-odb/client.rb', line 1743

def create_exascale_db_storage_vault(params = {}, options = {})
  req = build_request(:create_exascale_db_storage_vault, params)
  req.send_request(options)
end

#create_odb_network(params = {}) ⇒ Types::CreateOdbNetworkOutput

Creates an ODB network.

Examples:

Request syntax with placeholder values


resp = client.create_odb_network({
  display_name: "ResourceDisplayName", # required
  availability_zone: "CreateOdbNetworkInputAvailabilityZoneString",
  availability_zone_id: "CreateOdbNetworkInputAvailabilityZoneIdString",
  client_subnet_cidr: "CreateOdbNetworkInputClientSubnetCidrString", # required
  backup_subnet_cidr: "CreateOdbNetworkInputBackupSubnetCidrString",
  custom_domain_name: "CreateOdbNetworkInputCustomDomainNameString",
  default_dns_prefix: "CreateOdbNetworkInputDefaultDnsPrefixString",
  client_token: "CreateOdbNetworkInputClientTokenString",
  s3_access: "ENABLED", # accepts ENABLED, DISABLED
  zero_etl_access: "ENABLED", # accepts ENABLED, DISABLED
  sts_access: "ENABLED", # accepts ENABLED, DISABLED
  kms_access: "ENABLED", # accepts ENABLED, DISABLED
  s3_policy_document: "PolicyDocument",
  sts_policy_document: "PolicyDocument",
  kms_policy_document: "PolicyDocument",
  cross_region_s3_restore_sources_to_enable: ["String"],
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.display_name #=> String
resp.status #=> String, one of "AVAILABLE", "FAILED", "PROVISIONING", "TERMINATED", "TERMINATING", "UPDATING", "MAINTENANCE_IN_PROGRESS"
resp.status_reason #=> String
resp.odb_network_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :display_name (required, String) —

    A user-friendly name for the ODB network.

  • :availability_zone (String) —

    The Amazon Web Services Availability Zone (AZ) where the ODB network is located.

    This operation requires that you specify a value for either availabilityZone or availabilityZoneId.

  • :availability_zone_id (String) —

    The AZ ID of the AZ where the ODB network is located.

    This operation requires that you specify a value for either availabilityZone or availabilityZoneId.

  • :client_subnet_cidr (required, String) —

    The CIDR range of the client subnet for the ODB network.

    Constraints:

    • Must not overlap with the CIDR range of the backup subnet.

    • Must not overlap with the CIDR ranges of the VPCs that are connected to the ODB network.

    • Must not use the following CIDR ranges that are reserved by OCI:

      • 100.106.0.0/16 and 100.107.0.0/16

      • 169.254.0.0/16

      • 224.0.0.0 - 239.255.255.255

      • 240.0.0.0 - 255.255.255.255

  • :backup_subnet_cidr (String) —

    The CIDR range of the backup subnet for the ODB network.

    Constraints:

    • Must not overlap with the CIDR range of the client subnet.

    • Must not overlap with the CIDR ranges of the VPCs that are connected to the ODB network.

    • Must not use the following CIDR ranges that are reserved by OCI:

      • 100.106.0.0/16 and 100.107.0.0/16

      • 169.254.0.0/16

      • 224.0.0.0 - 239.255.255.255

      • 240.0.0.0 - 255.255.255.255

  • :custom_domain_name (String) —

    The domain name to use for the resources in the ODB network.

  • :default_dns_prefix (String) —

    The DNS prefix to the default DNS domain name. The default DNS domain name is oraclevcn.com.

  • :client_token (String) —

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it for the request to ensure idempotency. The client token is valid for up to 24 hours after it's first used.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :s3_access (String) —

    Specifies the configuration for Amazon S3 access from the ODB network.

  • :zero_etl_access (String) —

    Specifies the configuration for Zero-ETL access from the ODB network.

  • :sts_access (String) —

    The Amazon Web Services Security Token Service (STS) access configuration for the ODB network.

  • :kms_access (String) —

    The Amazon Web Services Key Management Service (KMS) access configuration for the ODB network.

  • :s3_policy_document (String) —

    Specifies the endpoint policy for Amazon S3 access from the ODB network.

  • :sts_policy_document (String) —

    The Amazon Web Services Security Token Service (STS) policy document that defines permissions for token service usage within the ODB network.

  • :kms_policy_document (String) —

    The Amazon Web Services Key Management Service (KMS) policy document that defines permissions for key usage within the ODB network.

  • :cross_region_s3_restore_sources_to_enable (Array<String>) —

    The cross-Region Amazon S3 restore sources to enable for the ODB network.

  • :tags (Hash<String,String>) —

    The list of resource tags to apply to the ODB network.

Returns:

See Also:



1899
1900
1901
1902
 
# File 'gems/aws-sdk-odb/lib/aws-sdk-odb/client.rb', line 1899

def create_odb_network(params = {}, options = {})
  req = build_request(:create_odb_network, params)
  req.send_request(options)
end

#create_odb_peering_connection(params = {}) ⇒ Types::CreateOdbPeeringConnectionOutput

Creates a peering connection between an ODB network and a VPC.

A peering connection enables private connectivity between the networks for application-tier communication.

Examples:

Request syntax with placeholder values


resp = client.create_odb_peering_connection({
  odb_network_id: "ResourceIdOrArn", # required
  peer_network_id: "ResourceIdOrArn", # required
  display_name: "ResourceDisplayName",
  peer_network_cidrs_to_be_added: ["PeeredCidr"],
  peer_network_route_table_ids: ["PeerNetworkRouteTableId"],
  client_token: "CreateOdbPeeringConnectionInputClientTokenString",
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.display_name #=> String
resp.status #=> String, one of "AVAILABLE", "FAILED", "PROVISIONING", "TERMINATED", "TERMINATING", "UPDATING", "MAINTENANCE_IN_PROGRESS"
resp.status_reason #=> String
resp.odb_peering_connection_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :odb_network_id (required, String) —

    The unique identifier of the ODB network that initiates the peering connection.

  • :peer_network_id (required, String) —

    The unique identifier of the peer network. This can be either a VPC ID or another ODB network ID.

  • :display_name (String) —

    The display name for the ODB peering connection.

  • :peer_network_cidrs_to_be_added (Array<String>) —

    A list of CIDR blocks to add to the peering connection. These CIDR blocks define the IP address ranges that can communicate through the peering connection.

  • :peer_network_route_table_ids (Array<String>) —

    The unique identifier of the VPC route table for which a route to the ODB network is automatically created during peering connection establishment.

  • :client_token (String) —

    The client token for the ODB peering connection request.

    Constraints:

    • Must be unique for each request.

    ^

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :tags (Hash<String,String>) —

    The tags to assign to the ODB peering connection.

Returns:

See Also:



1977
1978
1979
1980
 
# File 'gems/aws-sdk-odb/lib/aws-sdk-odb/client.rb', line 1977

def create_odb_peering_connection(params = {}, options = {})
  req = build_request(:create_odb_peering_connection, params)
  req.send_request(options)
end

#delete_autonomous_database(params = {}) ⇒ Struct

Deletes the specified Autonomous Database.

Examples:

Request syntax with placeholder values


resp = client.delete_autonomous_database({
  autonomous_database_id: "ResourceIdOrArn", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :autonomous_database_id (required, String) —

    The unique identifier of the Autonomous Database to delete.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1999
2000
2001
2002
 
# File 'gems/aws-sdk-odb/lib/aws-sdk-odb/client.rb', line 1999

def delete_autonomous_database(params = {}, options = {})
  req = build_request(:delete_autonomous_database, params)
  req.send_request(options)
end

#delete_autonomous_database_backup(params = {}) ⇒ Struct

Deletes the specified Autonomous Database backup.

Examples:

Request syntax with placeholder values


resp = client.delete_autonomous_database_backup({
  autonomous_database_backup_id: "ResourceId", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :autonomous_database_backup_id (required, String) —

    The unique identifier of the Autonomous Database backup to delete.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2021
2022
2023
2024
 
# File 'gems/aws-sdk-odb/lib/aws-sdk-odb/client.rb', line 2021

def delete_autonomous_database_backup(params = {}, options = {})
  req = build_request(:delete_autonomous_database_backup, params)
  req.send_request(options)
end

#delete_cloud_autonomous_vm_cluster(params = {}) ⇒ Struct

Deletes an Autonomous VM cluster.

Examples:

Request syntax with placeholder values


resp = client.delete_cloud_autonomous_vm_cluster({
  cloud_autonomous_vm_cluster_id: "ResourceId", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :cloud_autonomous_vm_cluster_id (required, String) —

    The unique identifier of the Autonomous VM cluster to delete.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2043
2044
2045
2046
 
# File 'gems/aws-sdk-odb/lib/aws-sdk-odb/client.rb', line 2043

def delete_cloud_autonomous_vm_cluster(params = {}, options = {})
  req = build_request(:delete_cloud_autonomous_vm_cluster, params)
  req.send_request(options)
end

#delete_cloud_exadata_infrastructure(params = {}) ⇒ Struct

Deletes the specified Exadata infrastructure. Before you use this operation, make sure to delete all of the VM clusters that are hosted on this Exadata infrastructure.

Examples:

Request syntax with placeholder values


resp = client.delete_cloud_exadata_infrastructure({
  cloud_exadata_infrastructure_id: "ResourceIdOrArn", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :cloud_exadata_infrastructure_id (required, String) —

    The unique identifier of the Exadata infrastructure to delete.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2067
2068
2069
2070
 
# File 'gems/aws-sdk-odb/lib/aws-sdk-odb/client.rb', line 2067

def delete_cloud_exadata_infrastructure(params = {}, options = {})
  req = build_request(:delete_cloud_exadata_infrastructure, params)
  req.send_request(options)
end

#delete_cloud_vm_cluster(params = {}) ⇒ Struct

Deletes the specified VM cluster.

Examples:

Request syntax with placeholder values


resp = client.delete_cloud_vm_cluster({
  cloud_vm_cluster_id: "ResourceId", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :cloud_vm_cluster_id (required, String) —

    The unique identifier of the VM cluster to delete.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2089
2090
2091
2092
 
# File 'gems/aws-sdk-odb/lib/aws-sdk-odb/client.rb', line 2089

def delete_cloud_vm_cluster(params = {}, options = {})
  req = build_request(:delete_cloud_vm_cluster, params)
  req.send_request(options)
end

#delete_exadb_vm_cluster(params = {}) ⇒ Struct

Deletes the specified Exascale VM cluster.

Examples:

Request syntax with placeholder values


resp = client.delete_exadb_vm_cluster({
  exadb_vm_cluster_id: "ResourceIdOrArn", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :exadb_vm_cluster_id (required, String) —

    The unique identifier of the Exascale VM cluster to delete.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2111
2112
2113
2114
 
# File 'gems/aws-sdk-odb/lib/aws-sdk-odb/client.rb', line 2111

def delete_exadb_vm_cluster(params = {}, options = {})
  req = build_request(:delete_exadb_vm_cluster, params)
  req.send_request(options)
end

#delete_exascale_db_storage_vault(params = {}) ⇒ Struct

Deletes the specified Exascale storage vault.

Examples:

Request syntax with placeholder values


resp = client.delete_exascale_db_storage_vault({
  exascale_db_storage_vault_id: "ResourceIdOrArn", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :exascale_db_storage_vault_id (required, String) —

    The unique identifier of the Exascale storage vault to delete.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2133
2134
2135
2136
 
# File 'gems/aws-sdk-odb/lib/aws-sdk-odb/client.rb', line 2133

def delete_exascale_db_storage_vault(params = {}, options = {})
  req = build_request(:delete_exascale_db_storage_vault, params)
  req.send_request(options)
end

#delete_odb_network(params = {}) ⇒ Struct

Deletes the specified ODB network.

Examples:

Request syntax with placeholder values


resp = client.delete_odb_network({
  odb_network_id: "ResourceIdOrArn", # required
  delete_associated_resources: false, # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :odb_network_id (required, String) —

    The unique identifier of the ODB network to delete.

  • :delete_associated_resources (required, Boolean) —

    Specifies whether to delete associated OCI networking resources along with the ODB network.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2160
2161
2162
2163
 
# File 'gems/aws-sdk-odb/lib/aws-sdk-odb/client.rb', line 2160

def delete_odb_network(params = {}, options = {})
  req = build_request(:delete_odb_network, params)
  req.send_request(options)
end

#delete_odb_peering_connection(params = {}) ⇒ Struct

Deletes an ODB peering connection.

When you delete an ODB peering connection, the underlying VPC peering connection is also deleted.

Examples:

Request syntax with placeholder values


resp = client.delete_odb_peering_connection({
  odb_peering_connection_id: "ResourceIdOrArn", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :odb_peering_connection_id (required, String) —

    The unique identifier of the ODB peering connection to delete.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2185
2186
2187
2188
 
# File 'gems/aws-sdk-odb/lib/aws-sdk-odb/client.rb', line 2185

def delete_odb_peering_connection(params = {}, options = {})
  req = build_request(:delete_odb_peering_connection, params)
  req.send_request(options)
end

#disassociate_iam_role_from_resource(params = {}) ⇒ Struct

Disassociates an Amazon Web Services Identity and Access Management (IAM) service role from a specified resource to disable Amazon Web Services service integration.

Examples:

Request syntax with placeholder values


resp = client.disassociate_iam_role_from_resource({
  iam_role_arn: "RoleArn", # required
  aws_integration: "KmsTde", # required, accepts KmsTde
  resource_arn: "DisassociateIamRoleFromResourceInputResourceArnString", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :iam_role_arn (required, String) —

    The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) service role to disassociate from the resource.

  • :aws_integration (required, String) —

    The Amazon Web Services integration configuration settings for the Amazon Web Services Identity and Access Management (IAM) service role disassociation.

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the target resource to disassociate from the Amazon Web Services Identity and Access Management (IAM) service role.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2223
2224
2225
2226
 
# File 'gems/aws-sdk-odb/lib/aws-sdk-odb/client.rb', line 2223

def disassociate_iam_role_from_resource(params = {}, options = {})
  req = build_request(:disassociate_iam_role_from_resource, params)
  req.send_request(options)
end

#disassociate_virtual_machines_from_cloud_vm_cluster(params = {}) ⇒ Types::DisassociateVirtualMachinesFromCloudVmClusterOutput

Removes virtual machines from the specified VM cluster.

Examples:

Request syntax with placeholder values


resp = client.disassociate_virtual_machines_from_cloud_vm_cluster({
  cloud_vm_cluster_id: "ResourceId", # required
  db_servers: ["String"], # required
})

Response structure


resp.display_name #=> String
resp.status #=> String, one of "AVAILABLE", "FAILED", "PROVISIONING", "TERMINATED", "TERMINATING", "UPDATING", "MAINTENANCE_IN_PROGRESS"
resp.status_reason #=> String
resp.cloud_vm_cluster_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :cloud_vm_cluster_id (required, String) —

    The unique identifier of the VM cluster to remove virtual machines from.

  • :db_servers (required, Array<String>) —

    The list of database server IDs for the virtual machines to remove from the VM cluster.

Returns:

See Also:



2263
2264
2265
2266
 
# File 'gems/aws-sdk-odb/lib/aws-sdk-odb/client.rb', line 2263

def disassociate_virtual_machines_from_cloud_vm_cluster(params = {}, options = {})
  req = build_request(:disassociate_virtual_machines_from_cloud_vm_cluster, params)
  req.send_request(options)
end

#disassociate_virtual_machines_from_exadb_vm_cluster(params = {}) ⇒ Types::DisassociateVirtualMachinesFromExadbVmClusterOutput

Removes virtual machines from the specified Exascale VM cluster.

Examples:

Request syntax with placeholder values


resp = client.disassociate_virtual_machines_from_exadb_vm_cluster({
  exadb_vm_cluster_id: "ResourceIdOrArn", # required
  db_node_ids: ["ResourceId"], # required
})

Response structure


resp.display_name #=> String
resp.status #=> String, one of "AVAILABLE", "FAILED", "PROVISIONING", "TERMINATED", "TERMINATING", "UPDATING", "MAINTENANCE_IN_PROGRESS"
resp.status_reason #=> String
resp.exadb_vm_cluster_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :exadb_vm_cluster_id (required, String) —

    The unique identifier of the Exascale VM cluster to remove virtual machines from.

  • :db_node_ids (required, Array<String>) —

    The list of DB node IDs to remove from the Exascale VM cluster.

Returns:

See Also:



2302
2303
2304
2305
 
# File 'gems/aws-sdk-odb/lib/aws-sdk-odb/client.rb', line 2302

def disassociate_virtual_machines_from_exadb_vm_cluster(params = {}, options = {})
  req = build_request(:disassociate_virtual_machines_from_exadb_vm_cluster, params)
  req.send_request(options)
end

#failover_autonomous_database(params = {}) ⇒ Types::FailoverAutonomousDatabaseOutput

Initiates a failover of the specified Autonomous Database to a standby peer database.

Examples:

Request syntax with placeholder values


resp = client.failover_autonomous_database({
  autonomous_database_id: "ResourceIdOrArn", # required
  peer_db_arn: "ResourceArn",
})

Response structure


resp.autonomous_database_id #=> String
resp.display_name #=> String
resp.status #=> String, one of "AVAILABLE", "FAILED", "PROVISIONING", "TERMINATED", "TERMINATING", "UPDATING", "MAINTENANCE_IN_PROGRESS", "STOPPING", "STOPPED", "STARTING", "UNAVAILABLE", "RESTORE_IN_PROGRESS", "RESTORE_FAILED", "BACKUP_IN_PROGRESS", "SCALE_IN_PROGRESS", "AVAILABLE_NEEDS_ATTENTION", "RESTARTING", "RECREATING", "ROLE_CHANGE_IN_PROGRESS", "UPGRADING", "INACCESSIBLE", "STANDBY"
resp.status_reason #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :autonomous_database_id (required, String) —

    The unique identifier of the Autonomous Database to fail over.

  • :peer_db_arn (String) —

    The Amazon Resource Name (ARN) of the peer Autonomous Database to fail over to.

Returns:

See Also:



2342
2343
2344
2345
 
# File 'gems/aws-sdk-odb/lib/aws-sdk-odb/client.rb', line 2342

def failover_autonomous_database(params = {}, options = {})
  req = build_request(:failover_autonomous_database, params)
  req.send_request(options)
end

#get_autonomous_database(params = {}) ⇒ Types::GetAutonomousDatabaseOutput

Gets information about a specific Autonomous Database.

Examples:

Request syntax with placeholder values


resp = client.get_autonomous_database({
  autonomous_database_id: "ResourceIdOrArn", # required
})

Response structure


resp.autonomous_database.autonomous_database_id #=> String
resp.autonomous_database.autonomous_database_arn #=> String
resp.autonomous_database.oci_resource_anchor_name #=> String
resp.autonomous_database.percent_progress #=> Float
resp.autonomous_database.ocid #=> String
resp.autonomous_database.oci_url #=> String
resp.autonomous_database.display_name #=> String
resp.autonomous_database.db_name #=> String
resp.autonomous_database.source_id #=> String
resp.autonomous_database.status #=> String, one of "AVAILABLE", "FAILED", "PROVISIONING", "TERMINATED", "TERMINATING", "UPDATING", "MAINTENANCE_IN_PROGRESS", "STOPPING", "STOPPED", "STARTING", "UNAVAILABLE", "RESTORE_IN_PROGRESS", "RESTORE_FAILED", "BACKUP_IN_PROGRESS", "SCALE_IN_PROGRESS", "AVAILABLE_NEEDS_ATTENTION", "RESTARTING", "RECREATING", "ROLE_CHANGE_IN_PROGRESS", "UPGRADING", "INACCESSIBLE", "STANDBY"
resp.autonomous_database.status_reason #=> String
resp.autonomous_database.database_type #=> String, one of "REGULAR", "CLONE"
resp.autonomous_database.db_version #=> String
resp.autonomous_database.db_workload #=> String, one of "OLTP", "AJD", "APEX", "LH"
resp.autonomous_database.character_set #=> String
resp.autonomous_database.ncharacter_set #=> String
resp.autonomous_database.database_edition #=> String, one of "STANDARD_EDITION", "ENTERPRISE_EDITION"
resp.autonomous_database.license_model #=> String, one of "BRING_YOUR_OWN_LICENSE", "LICENSE_INCLUDED"
resp.autonomous_database.open_mode #=> String, one of "READ_ONLY", "READ_WRITE"
resp.autonomous_database.permission_level #=> String, one of "RESTRICTED", "UNRESTRICTED"
resp.autonomous_database.is_mtls_connection_required #=> Boolean
resp.autonomous_database.autonomous_maintenance_schedule_type #=> String, one of "EARLY", "REGULAR"
resp.autonomous_database.net_services_architecture #=> String, one of "DEDICATED", "SHARED"
resp.autonomous_database.available_upgrade_versions #=> Array
resp.autonomous_database.available_upgrade_versions[0] #=> String
resp.autonomous_database.byol_compute_count_limit #=> Integer
resp.autonomous_database.connection_string_details.all_connection_strings #=> Hash
resp.autonomous_database.connection_string_details.all_connection_strings["String"] #=> String
resp.autonomous_database.connection_string_details.dedicated #=> String
resp.autonomous_database.connection_string_details.high #=> String
resp.autonomous_database.connection_string_details.medium #=> String
resp.autonomous_database.connection_string_details.low #=> String
resp.autonomous_database.connection_string_details.profiles #=> Array
resp.autonomous_database.connection_string_details.profiles[0].consumer_group #=> String
resp.autonomous_database.connection_string_details.profiles[0].display_name #=> String
resp.autonomous_database.connection_string_details.profiles[0].host_format #=> String
resp.autonomous_database.connection_string_details.profiles[0].is_regional #=> Boolean
resp.autonomous_database.connection_string_details.profiles[0].protocol #=> String
resp.autonomous_database.connection_string_details.profiles[0].session_mode #=> String
resp.autonomous_database.connection_string_details.profiles[0].syntax_format #=> String
resp.autonomous_database.connection_string_details.profiles[0].tls_authentication #=> String
resp.autonomous_database.connection_string_details.profiles[0].value #=> String
resp.autonomous_database.service_console_url #=> String
resp.autonomous_database.sql_web_developer_url #=> String
resp.autonomous_database.customer_contacts #=> Array
resp.autonomous_database.customer_contacts[0].email #=> String
resp.autonomous_database.apex_details.apex_version #=> String
resp.autonomous_database.apex_details.ords_version #=> String
resp.autonomous_database.standby_db.availability_domain #=> String
resp.autonomous_database.standby_db.lag_time_in_seconds #=> Integer
resp.autonomous_database.standby_db.status #=> String, one of "AVAILABLE", "FAILED", "PROVISIONING", "TERMINATED", "TERMINATING", "UPDATING", "MAINTENANCE_IN_PROGRESS", "STOPPING", "STOPPED", "STARTING", "UNAVAILABLE", "RESTORE_IN_PROGRESS", "RESTORE_FAILED", "BACKUP_IN_PROGRESS", "SCALE_IN_PROGRESS", "AVAILABLE_NEEDS_ATTENTION", "RESTARTING", "RECREATING", "ROLE_CHANGE_IN_PROGRESS", "UPGRADING", "INACCESSIBLE", "STANDBY"
resp.autonomous_database.standby_db.status_reason #=> String
resp.autonomous_database.standby_db.maintenance_target_component #=> String
resp.autonomous_database.standby_db.time_data_guard_role_changed #=> Time
resp.autonomous_database.standby_db.time_disaster_recovery_role_changed #=> Time
resp.autonomous_database.standby_db.time_maintenance_begin #=> Time
resp.autonomous_database.standby_db.time_maintenance_end #=> Time
resp.autonomous_database.local_standby_db.availability_domain #=> String
resp.autonomous_database.local_standby_db.lag_time_in_seconds #=> Integer
resp.autonomous_database.local_standby_db.status #=> String, one of "AVAILABLE", "FAILED", "PROVISIONING", "TERMINATED", "TERMINATING", "UPDATING", "MAINTENANCE_IN_PROGRESS", "STOPPING", "STOPPED", "STARTING", "UNAVAILABLE", "RESTORE_IN_PROGRESS", "RESTORE_FAILED", "BACKUP_IN_PROGRESS", "SCALE_IN_PROGRESS", "AVAILABLE_NEEDS_ATTENTION", "RESTARTING", "RECREATING", "ROLE_CHANGE_IN_PROGRESS", "UPGRADING", "INACCESSIBLE", "STANDBY"
resp.autonomous_database.local_standby_db.status_reason #=> String
resp.autonomous_database.local_standby_db.maintenance_target_component #=> String
resp.autonomous_database.local_standby_db.time_data_guard_role_changed #=> Time
resp.autonomous_database.local_standby_db.time_disaster_recovery_role_changed #=> Time
resp.autonomous_database.local_standby_db.time_maintenance_begin #=> Time
resp.autonomous_database.local_standby_db.time_maintenance_end #=> Time
resp.autonomous_database.data_safe_status #=> String, one of "REGISTERING", "REGISTERED", "DEREGISTERING", "NOT_REGISTERED", "FAILED"
resp.autonomous_database.database_management_status #=> String, one of "ENABLING", "ENABLED", "DISABLING", "NOT_ENABLED", "FAILED_ENABLING", "FAILED_DISABLING"
resp.autonomous_database.operations_insights_status #=> String, one of "ENABLING", "ENABLED", "DISABLING", "NOT_ENABLED", "FAILED_ENABLING", "FAILED_DISABLING"
resp.autonomous_database.availability_zone #=> String
resp.autonomous_database.availability_zone_id #=> String
resp.autonomous_database.maintenance_target_component #=> String
resp.autonomous_database.connection_urls.apex_url #=> String
resp.autonomous_database.connection_urls.database_transforms_url #=> String
resp.autonomous_database.connection_urls.graph_studio_url #=> String
resp.autonomous_database.connection_urls.machine_learning_notebook_url #=> String
resp.autonomous_database.connection_urls.machine_learning_user_management_url #=> String
resp.autonomous_database.connection_urls.mongo_db_url #=> String
resp.autonomous_database.connection_urls.ords_url #=> String
resp.autonomous_database.connection_urls.spatial_studio_url #=> String
resp.autonomous_database.connection_urls.sql_dev_web_url #=> String
resp.autonomous_database.db_tools_details #=> Array
resp.autonomous_database.db_tools_details[0].is_enabled #=> Boolean
resp.autonomous_database.db_tools_details[0].name #=> String
resp.autonomous_database.db_tools_details[0].compute_count #=> Float
resp.autonomous_database.db_tools_details[0].max_idle_time_in_minutes #=> Integer
resp.autonomous_database.scheduled_operations #=> Array
resp.autonomous_database.scheduled_operations[0].day_of_week.name #=> String, one of "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY"
resp.autonomous_database.scheduled_operations[0].scheduled_start_time #=> String
resp.autonomous_database.scheduled_operations[0].scheduled_stop_time #=> String
resp.autonomous_database.resource_pool_leader_id #=> String
resp.autonomous_database.compute_count #=> Float
resp.autonomous_database.compute_model #=> String, one of "ECPU", "OCPU"
resp.autonomous_database.cpu_core_count #=> Integer
resp.autonomous_database.memory_per_oracle_compute_unit_in_g_bs #=> Integer
resp.autonomous_database.provisionable_cpus #=> Array
resp.autonomous_database.provisionable_cpus[0] #=> Integer
resp.autonomous_database.is_auto_scaling_enabled #=> Boolean
resp.autonomous_database.data_storage_size_in_t_bs #=> Float
resp.autonomous_database.data_storage_size_in_g_bs #=> Integer
resp.autonomous_database.used_data_storage_size_in_t_bs #=> Float
resp.autonomous_database.used_data_storage_size_in_g_bs #=> Integer
resp.autonomous_database.actual_used_data_storage_size_in_t_bs #=> Float
resp.autonomous_database.allocated_storage_size_in_t_bs #=> Float
resp.autonomous_database.in_memory_area_in_g_bs #=> Integer
resp.autonomous_database.is_auto_scaling_for_storage_enabled #=> Boolean
resp.autonomous_database.odb_network_id #=> String
resp.autonomous_database.odb_network_arn #=> String
resp.autonomous_database.private_endpoint #=> String
resp.autonomous_database.private_endpoint_ip #=> String
resp.autonomous_database.private_endpoint_label #=> String
resp.autonomous_database.allowlisted_ips #=> Array
resp.autonomous_database.allowlisted_ips[0] #=> String
resp.autonomous_database.standby_allowlisted_ips #=> Array
resp.autonomous_database.standby_allowlisted_ips[0] #=> String
resp.autonomous_database.standby_allowlisted_ips_source #=> String, one of "PRIMARY", "SEPARATE", "NOT_APPLICABLE"
resp.autonomous_database.is_local_data_guard_enabled #=> Boolean
resp.autonomous_database.is_remote_data_guard_enabled #=> Boolean
resp.autonomous_database.local_disaster_recovery_type #=> String, one of "ADG", "BACKUP_BASED"
resp.autonomous_database.role #=> String, one of "PRIMARY", "STANDBY", "DISABLED_STANDBY", "BACKUP_COPY", "SNAPSHOT_STANDBY"
resp.autonomous_database.peer_db_ids #=> Array
resp.autonomous_database.peer_db_ids[0] #=> String
resp.autonomous_database.failed_data_recovery_in_seconds #=> Integer
resp.autonomous_database.local_adg_auto_failover_max_data_loss_limit #=> Integer
resp.autonomous_database.remote_disaster_recovery_configuration.disaster_recovery_type #=> String, one of "ADG", "BACKUP_BASED"
resp.autonomous_database.remote_disaster_recovery_configuration.is_replicate_automatic_backups #=> Boolean
resp.autonomous_database.remote_disaster_recovery_configuration.is_snapshot_standby #=> Boolean
resp.autonomous_database.remote_disaster_recovery_configuration.time_snapshot_standby_enabled_till #=> Time
resp.autonomous_database.is_refreshable_clone #=> Boolean
resp.autonomous_database.refreshable_mode #=> String, one of "AUTOMATIC", "MANUAL"
resp.autonomous_database.refreshable_status #=> String, one of "REFRESHING", "NOT_REFRESHING"
resp.autonomous_database.auto_refresh_frequency_in_seconds #=> Integer
resp.autonomous_database.auto_refresh_point_lag_in_seconds #=> Integer
resp.autonomous_database.is_reconnect_clone_enabled #=> Boolean
resp.autonomous_database.clone_table_space_list #=> Array
resp.autonomous_database.clone_table_space_list[0] #=> Integer
resp.autonomous_database.backup_retention_period_in_days #=> Integer
resp.autonomous_database.long_term_backup_schedule.is_disabled #=> Boolean
resp.autonomous_database.long_term_backup_schedule.repeat_cadence #=> String, one of "ONE_TIME", "WEEKLY", "MONTHLY", "YEARLY"
resp.autonomous_database.long_term_backup_schedule.retention_period_in_days #=> Integer
resp.autonomous_database.long_term_backup_schedule.time_of_backup #=> Time
resp.autonomous_database.is_backup_retention_locked #=> Boolean
resp.autonomous_database.total_backup_storage_size_in_g_bs #=> Float
resp.autonomous_database.resource_pool_summary.is_disabled #=> Boolean
resp.autonomous_database.resource_pool_summary.pool_size #=> Integer
resp.autonomous_database.resource_pool_summary.pool_storage_size_in_t_bs #=> Integer
resp.autonomous_database.resource_pool_summary.available_storage_capacity_in_t_bs #=> Float
resp.autonomous_database.resource_pool_summary.total_compute_capacity #=> Integer
resp.autonomous_database.resource_pool_summary.available_compute_capacity #=> Integer
resp.autonomous_database.encryption_summary.encryption_key_provider #=> String, one of "ORACLE_MANAGED", "AWS_KMS", "OKV", "OCI"
resp.autonomous_database.encryption_summary.encryption_key_configuration.aws_encryption_key.iam_role_arn #=> String
resp.autonomous_database.encryption_summary.encryption_key_configuration.aws_encryption_key.external_id_type #=> String, one of "database_ocid", "compartment_ocid", "tenant_ocid"
resp.autonomous_database.encryption_summary.encryption_key_configuration.aws_encryption_key.kms_key_id #=> String
resp.autonomous_database.encryption_summary.encryption_key_configuration.oci_encryption_key.kms_key_id #=> String
resp.autonomous_database.encryption_summary.encryption_key_configuration.oci_encryption_key.vault_id #=> String
resp.autonomous_database.encryption_summary.encryption_key_configuration.okv_encryption_key.certificate_directory_name #=> String
resp.autonomous_database.encryption_summary.encryption_key_configuration.okv_encryption_key.certificate_id #=> String
resp.autonomous_database.encryption_summary.encryption_key_configuration.okv_encryption_key.directory_name #=> String
resp.autonomous_database.encryption_summary.encryption_key_configuration.okv_encryption_key.okv_kms_key #=> String
resp.autonomous_database.encryption_summary.encryption_key_configuration.okv_encryption_key.okv_uri #=> String
resp.autonomous_database.created_at #=> Time
resp.autonomous_database.time_of_last_backup #=> Time
resp.autonomous_database.time_maintenance_begin #=> Time
resp.autonomous_database.time_maintenance_end #=> Time
resp.autonomous_database.time_local_data_guard_enabled #=> Time
resp.autonomous_database.time_data_guard_role_changed #=> Time
resp.autonomous_database.time_of_last_switchover #=> Time
resp.autonomous_database.time_of_last_failover #=> Time
resp.autonomous_database.time_of_last_refresh #=> Time
resp.autonomous_database.time_of_last_refresh_point #=> Time
resp.autonomous_database.time_of_next_refresh #=> Time
resp.autonomous_database.time_of_auto_refresh_start #=> Time
resp.autonomous_database.time_deletion_of_free_autonomous_database #=> Time
resp.autonomous_database.time_reclamation_of_free_autonomous_database #=> Time
resp.autonomous_database.time_disaster_recovery_role_changed #=> Time
resp.autonomous_database.time_until_reconnect_clone_enabled #=> Time
resp.autonomous_database.next_long_term_backup_time_stamp #=> Time
resp.autonomous_database.time_undeleted #=> Time
resp.autonomous_database.admin_password_source_summary.admin_password_source #=> String, one of "CUSTOMER_MANAGED_AWS_SECRET", "API_REQUEST_PARAMETER"
resp.autonomous_database.admin_password_source_summary.admin_password_source_configuration.customer_managed_aws_secret.iam_role_arn #=> String
resp.autonomous_database.admin_password_source_summary.admin_password_source_configuration.customer_managed_aws_secret.secret_id #=> String
resp.autonomous_database.admin_password_source_summary.admin_password_source_configuration.customer_managed_aws_secret.external_id_type #=> String, one of "database_ocid", "compartment_ocid", "tenant_ocid"

Parameters:

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

    ({})

Options Hash (params):

  • :autonomous_database_id (required, String) —

    The unique identifier of the Autonomous Database to retrieve information about.

Returns:

See Also:



2552
2553
2554
2555
 
# File 'gems/aws-sdk-odb/lib/aws-sdk-odb/client.rb', line 2552

def get_autonomous_database(params = {}, options = {})
  req = build_request(:get_autonomous_database, params)
  req.send_request(options)
end

#get_autonomous_database_backup(params = {}) ⇒ Types::GetAutonomousDatabaseBackupOutput

Gets information about a specific Autonomous Database backup.

Examples:

Request syntax with placeholder values


resp = client.get_autonomous_database_backup({
  autonomous_database_backup_id: "ResourceId", # required
})

Response structure


resp.autonomous_database_backup.autonomous_database_backup_id #=> String
resp.autonomous_database_backup.autonomous_database_backup_arn #=> String
resp.autonomous_database_backup.autonomous_database_id #=> String
resp.autonomous_database_backup.ocid #=> String
resp.autonomous_database_backup.display_name #=> String
resp.autonomous_database_backup.db_version #=> String
resp.autonomous_database_backup.status #=> String, one of "ACTIVE", "CREATING", "UPDATING", "DELETING", "FAILED"
resp.autonomous_database_backup.status_reason #=> String
resp.autonomous_database_backup.is_automatic #=> Boolean
resp.autonomous_database_backup.retention_period_in_days #=> Integer
resp.autonomous_database_backup.size_in_t_bs #=> Float
resp.autonomous_database_backup.time_available_till #=> Time
resp.autonomous_database_backup.time_started #=> Time
resp.autonomous_database_backup.time_ended #=> Time
resp.autonomous_database_backup.type #=> String, one of "INCREMENTAL", "FULL", "LONGTERM", "VIRTUAL_FULL", "CUMULATIVE_INCREMENTAL", "ROLL_FORWARD_IMAGE_COPY"

Parameters:

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

    ({})

Options Hash (params):

  • :autonomous_database_backup_id (required, String) —

    The unique identifier of the Autonomous Database backup to retrieve information about.

Returns:

See Also:



2595
2596
2597
2598
 
# File 'gems/aws-sdk-odb/lib/aws-sdk-odb/client.rb', line 2595

def get_autonomous_database_backup(params = {}, options = {})
  req = build_request(:get_autonomous_database_backup, params)
  req.send_request(options)
end

#get_autonomous_database_wallet_details(params = {}) ⇒ Types::GetAutonomousDatabaseWalletDetailsOutput

Gets the wallet details for the specified Autonomous Database.

Examples:

Request syntax with placeholder values


resp = client.get_autonomous_database_wallet_details({
  autonomous_database_id: "ResourceIdOrArn", # required
})

Response structure


resp.autonomous_database_wallet_details.status #=> String, one of "ACTIVE", "UPDATING"
resp.autonomous_database_wallet_details.time_rotated #=> Time
resp.autonomous_database_wallet_details.password_source_summary.password_source #=> String, one of "CUSTOMER_MANAGED_AWS_SECRET", "API_REQUEST_PARAMETER"
resp.autonomous_database_wallet_details.password_source_summary.password_source_configuration.customer_managed_aws_secret.iam_role_arn #=> String
resp.autonomous_database_wallet_details.password_source_summary.password_source_configuration.customer_managed_aws_secret.secret_id #=> String
resp.autonomous_database_wallet_details.password_source_summary.password_source_configuration.customer_managed_aws_secret.external_id_type #=> String, one of "database_ocid", "compartment_ocid", "tenant_ocid"

Parameters:

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

    ({})

Options Hash (params):

  • :autonomous_database_id (required, String) —

    The unique identifier of the Autonomous Database to retrieve wallet details for.

Returns:

See Also:



2629
2630
2631
2632
 
# File 'gems/aws-sdk-odb/lib/aws-sdk-odb/client.rb', line 2629

def get_autonomous_database_wallet_details(params = {}, options = {})
  req = build_request(:get_autonomous_database_wallet_details, params)
  req.send_request(options)
end

#get_cloud_autonomous_vm_cluster(params = {}) ⇒ Types::GetCloudAutonomousVmClusterOutput

Gets information about a specific Autonomous VM cluster.

Examples:

Request syntax with placeholder values


resp = client.get_cloud_autonomous_vm_cluster({
  cloud_autonomous_vm_cluster_id: "ResourceId", # required
})

Response structure


resp.cloud_autonomous_vm_cluster.cloud_autonomous_vm_cluster_id #=> String
resp.cloud_autonomous_vm_cluster.cloud_autonomous_vm_cluster_arn #=> String
resp.cloud_autonomous_vm_cluster.odb_network_id #=> String
resp.cloud_autonomous_vm_cluster.odb_network_arn #=> String
resp.cloud_autonomous_vm_cluster.oci_resource_anchor_name #=> String
resp.cloud_autonomous_vm_cluster.percent_progress #=> Float
resp.cloud_autonomous_vm_cluster.display_name #=> String
resp.cloud_autonomous_vm_cluster.status #=> String, one of "AVAILABLE", "FAILED", "PROVISIONING", "TERMINATED", "TERMINATING", "UPDATING", "MAINTENANCE_IN_PROGRESS"
resp.cloud_autonomous_vm_cluster.status_reason #=> String
resp.cloud_autonomous_vm_cluster.cloud_exadata_infrastructure_id #=> String
resp.cloud_autonomous_vm_cluster.cloud_exadata_infrastructure_arn #=> String
resp.cloud_autonomous_vm_cluster.autonomous_data_storage_percentage #=> Float
resp.cloud_autonomous_vm_cluster.autonomous_data_storage_size_in_t_bs #=> Float
resp.cloud_autonomous_vm_cluster.available_autonomous_data_storage_size_in_t_bs #=> Float
resp.cloud_autonomous_vm_cluster.available_container_databases #=> Integer
resp.cloud_autonomous_vm_cluster.available_cpus #=> Float
resp.cloud_autonomous_vm_cluster.compute_model #=> String, one of "ECPU", "OCPU"
resp.cloud_autonomous_vm_cluster.cpu_core_count #=> Integer
resp.cloud_autonomous_vm_cluster.cpu_core_count_per_node #=> Integer
resp.cloud_autonomous_vm_cluster.cpu_percentage #=> Float
resp.cloud_autonomous_vm_cluster.data_storage_size_in_g_bs #=> Float
resp.cloud_autonomous_vm_cluster.data_storage_size_in_t_bs #=> Float
resp.cloud_autonomous_vm_cluster.db_node_storage_size_in_g_bs #=> Integer
resp.cloud_autonomous_vm_cluster.db_servers #=> Array
resp.cloud_autonomous_vm_cluster.db_servers[0] #=> String
resp.cloud_autonomous_vm_cluster.description #=> String
resp.cloud_autonomous_vm_cluster.domain #=> String
resp.cloud_autonomous_vm_cluster.exadata_storage_in_t_bs_lowest_scaled_value #=> Float
resp.cloud_autonomous_vm_cluster.hostname #=> String
resp.cloud_autonomous_vm_cluster.ocid #=> String
resp.cloud_autonomous_vm_cluster.oci_url #=> String
resp.cloud_autonomous_vm_cluster.is_mtls_enabled_vm_cluster #=> Boolean
resp.cloud_autonomous_vm_cluster.license_model #=> String, one of "BRING_YOUR_OWN_LICENSE", "LICENSE_INCLUDED"
resp.cloud_autonomous_vm_cluster.maintenance_window.custom_action_timeout_in_mins #=> Integer
resp.cloud_autonomous_vm_cluster.maintenance_window.days_of_week #=> Array
resp.cloud_autonomous_vm_cluster.maintenance_window.days_of_week[0].name #=> String, one of "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY"
resp.cloud_autonomous_vm_cluster.maintenance_window.hours_of_day #=> Array
resp.cloud_autonomous_vm_cluster.maintenance_window.hours_of_day[0] #=> Integer
resp.cloud_autonomous_vm_cluster.maintenance_window.is_custom_action_timeout_enabled #=> Boolean
resp.cloud_autonomous_vm_cluster.maintenance_window.lead_time_in_weeks #=> Integer
resp.cloud_autonomous_vm_cluster.maintenance_window.months #=> Array
resp.cloud_autonomous_vm_cluster.maintenance_window.months[0].name #=> String, one of "JANUARY", "FEBRUARY", "MARCH", "APRIL", "MAY", "JUNE", "JULY", "AUGUST", "SEPTEMBER", "OCTOBER", "NOVEMBER", "DECEMBER"
resp.cloud_autonomous_vm_cluster.maintenance_window.patching_mode #=> String, one of "ROLLING", "NONROLLING"
resp.cloud_autonomous_vm_cluster.maintenance_window.preference #=> String, one of "NO_PREFERENCE", "CUSTOM_PREFERENCE"
resp.cloud_autonomous_vm_cluster.maintenance_window.skip_ru #=> Boolean
resp.cloud_autonomous_vm_cluster.maintenance_window.weeks_of_month #=> Array
resp.cloud_autonomous_vm_cluster.maintenance_window.weeks_of_month[0] #=> Integer
resp.cloud_autonomous_vm_cluster.max_acds_lowest_scaled_value #=> Integer
resp.cloud_autonomous_vm_cluster.memory_per_oracle_compute_unit_in_g_bs #=> Integer
resp.cloud_autonomous_vm_cluster.memory_size_in_g_bs #=> Integer
resp.cloud_autonomous_vm_cluster.node_count #=> Integer
resp.cloud_autonomous_vm_cluster.non_provisionable_autonomous_container_databases #=> Integer
resp.cloud_autonomous_vm_cluster.ocpus_lowest_scaled_value #=> Integer
resp.cloud_autonomous_vm_cluster.provisionable_autonomous_container_databases #=> Integer
resp.cloud_autonomous_vm_cluster.provisioned_autonomous_container_databases #=> Integer
resp.cloud_autonomous_vm_cluster.provisioned_cpus #=> Float
resp.cloud_autonomous_vm_cluster.reclaimable_cpus #=> Float
resp.cloud_autonomous_vm_cluster.reserved_cpus #=> Float
resp.cloud_autonomous_vm_cluster.scan_listener_port_non_tls #=> Integer
resp.cloud_autonomous_vm_cluster.scan_listener_port_tls #=> Integer
resp.cloud_autonomous_vm_cluster.shape #=> String
resp.cloud_autonomous_vm_cluster.created_at #=> Time
resp.cloud_autonomous_vm_cluster.time_database_ssl_certificate_expires #=> Time
resp.cloud_autonomous_vm_cluster.time_ords_certificate_expires #=> Time
resp.cloud_autonomous_vm_cluster.time_zone #=> String
resp.cloud_autonomous_vm_cluster.total_container_databases #=> Integer
resp.cloud_autonomous_vm_cluster.iam_roles #=> Array
resp.cloud_autonomous_vm_cluster.iam_roles[0].iam_role_arn #=> String
resp.cloud_autonomous_vm_cluster.iam_roles[0].status #=> String, one of "ASSOCIATING", "DISASSOCIATING", "FAILED", "CONNECTED", "DISCONNECTED", "PARTIALLY_CONNECTED", "UNKNOWN"
resp.cloud_autonomous_vm_cluster.iam_roles[0].status_reason #=> String
resp.cloud_autonomous_vm_cluster.iam_roles[0].aws_integration #=> String, one of "KmsTde"

Parameters:

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

    ({})

Options Hash (params):

  • :cloud_autonomous_vm_cluster_id (required, String) —

    The unique identifier of the Autonomous VM cluster to retrieve information about.

Returns:

See Also:



2728
2729
2730
2731
 
# File 'gems/aws-sdk-odb/lib/aws-sdk-odb/client.rb', line 2728

def get_cloud_autonomous_vm_cluster(params = {}, options = {})
  req = build_request(:get_cloud_autonomous_vm_cluster, params)
  req.send_request(options)
end

#get_cloud_exadata_infrastructure(params = {}) ⇒ Types::GetCloudExadataInfrastructureOutput

Returns information about the specified Exadata infrastructure.

Examples:

Request syntax with placeholder values


resp = client.get_cloud_exadata_infrastructure({
  cloud_exadata_infrastructure_id: "ResourceIdOrArn", # required
})

Response structure


resp.cloud_exadata_infrastructure.cloud_exadata_infrastructure_id #=> String
resp.cloud_exadata_infrastructure.display_name #=> String
resp.cloud_exadata_infrastructure.status #=> String, one of "AVAILABLE", "FAILED", "PROVISIONING", "TERMINATED", "TERMINATING", "UPDATING", "MAINTENANCE_IN_PROGRESS"
resp.cloud_exadata_infrastructure.status_reason #=> String
resp.cloud_exadata_infrastructure.cloud_exadata_infrastructure_arn #=> String
resp.cloud_exadata_infrastructure.activated_storage_count #=> Integer
resp.cloud_exadata_infrastructure.additional_storage_count #=> Integer
resp.cloud_exadata_infrastructure.available_storage_size_in_g_bs #=> Integer
resp.cloud_exadata_infrastructure.availability_zone #=> String
resp.cloud_exadata_infrastructure.availability_zone_id #=> String
resp.cloud_exadata_infrastructure.compute_count #=> Integer
resp.cloud_exadata_infrastructure.cpu_count #=> Integer
resp.cloud_exadata_infrastructure.customer_contacts_to_send_to_oci #=> Array
resp.cloud_exadata_infrastructure.customer_contacts_to_send_to_oci[0].email #=> String
resp.cloud_exadata_infrastructure.data_storage_size_in_t_bs #=> Float
resp.cloud_exadata_infrastructure.db_node_storage_size_in_g_bs #=> Integer
resp.cloud_exadata_infrastructure.db_server_version #=> String
resp.cloud_exadata_infrastructure.last_maintenance_run_id #=> String
resp.cloud_exadata_infrastructure.maintenance_window.custom_action_timeout_in_mins #=> Integer
resp.cloud_exadata_infrastructure.maintenance_window.days_of_week #=> Array
resp.cloud_exadata_infrastructure.maintenance_window.days_of_week[0].name #=> String, one of "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY"
resp.cloud_exadata_infrastructure.maintenance_window.hours_of_day #=> Array
resp.cloud_exadata_infrastructure.maintenance_window.hours_of_day[0] #=> Integer
resp.cloud_exadata_infrastructure.maintenance_window.is_custom_action_timeout_enabled #=> Boolean
resp.cloud_exadata_infrastructure.maintenance_window.lead_time_in_weeks #=> Integer
resp.cloud_exadata_infrastructure.maintenance_window.months #=> Array
resp.cloud_exadata_infrastructure.maintenance_window.months[0].name #=> String, one of "JANUARY", "FEBRUARY", "MARCH", "APRIL", "MAY", "JUNE", "JULY", "AUGUST", "SEPTEMBER", "OCTOBER", "NOVEMBER", "DECEMBER"
resp.cloud_exadata_infrastructure.maintenance_window.patching_mode #=> String, one of "ROLLING", "NONROLLING"
resp.cloud_exadata_infrastructure.maintenance_window.preference #=> String, one of "NO_PREFERENCE", "CUSTOM_PREFERENCE"
resp.cloud_exadata_infrastructure.maintenance_window.skip_ru #=> Boolean
resp.cloud_exadata_infrastructure.maintenance_window.weeks_of_month #=> Array
resp.cloud_exadata_infrastructure.maintenance_window.weeks_of_month[0] #=> Integer
resp.cloud_exadata_infrastructure.max_cpu_count #=> Integer
resp.cloud_exadata_infrastructure.max_data_storage_in_t_bs #=> Float
resp.cloud_exadata_infrastructure.max_db_node_storage_size_in_g_bs #=> Integer
resp.cloud_exadata_infrastructure.max_memory_in_g_bs #=> Integer
resp.cloud_exadata_infrastructure.memory_size_in_g_bs #=> Integer
resp.cloud_exadata_infrastructure.monthly_db_server_version #=> String
resp.cloud_exadata_infrastructure.monthly_storage_server_version #=> String
resp.cloud_exadata_infrastructure.next_maintenance_run_id #=> String
resp.cloud_exadata_infrastructure.oci_resource_anchor_name #=> String
resp.cloud_exadata_infrastructure.oci_url #=> String
resp.cloud_exadata_infrastructure.ocid #=> String
resp.cloud_exadata_infrastructure.shape #=> String
resp.cloud_exadata_infrastructure.storage_count #=> Integer
resp.cloud_exadata_infrastructure.storage_server_version #=> String
resp.cloud_exadata_infrastructure.created_at #=> Time
resp.cloud_exadata_infrastructure.total_storage_size_in_g_bs #=> Integer
resp.cloud_exadata_infrastructure.percent_progress #=> Float
resp.cloud_exadata_infrastructure.database_server_type #=> String
resp.cloud_exadata_infrastructure.storage_server_type #=> String
resp.cloud_exadata_infrastructure.compute_model #=> String, one of "ECPU", "OCPU"
resp.cloud_exadata_infrastructure.exascale_configuration.total_storage_size_in_g_bs #=> Integer
resp.cloud_exadata_infrastructure.exascale_configuration.available_storage_size_in_g_bs #=> Integer
resp.cloud_exadata_infrastructure.exascale_configuration.total_vm_storage_size_in_g_bs #=> Integer
resp.cloud_exadata_infrastructure.exascale_configuration.available_vm_storage_size_in_g_bs #=> Integer

Parameters:

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

    ({})

Options Hash (params):

  • :cloud_exadata_infrastructure_id (required, String) —

    The unique identifier of the Exadata infrastructure.

Returns:

See Also:



2811
2812
2813
2814
 
# File 'gems/aws-sdk-odb/lib/aws-sdk-odb/client.rb', line 2811

def get_cloud_exadata_infrastructure(params = {}, options = {})
  req = build_request(:get_cloud_exadata_infrastructure, params)
  req.send_request(options)
end

#get_cloud_exadata_infrastructure_unallocated_resources(params = {}) ⇒ Types::GetCloudExadataInfrastructureUnallocatedResourcesOutput

Retrieves information about unallocated resources in a specified Cloud Exadata Infrastructure.

Examples:

Request syntax with placeholder values


resp = client.get_cloud_exadata_infrastructure_unallocated_resources({
  cloud_exadata_infrastructure_id: "ResourceIdOrArn", # required
  db_servers: ["String"],
})

Response structure


resp.cloud_exadata_infrastructure_unallocated_resources.cloud_autonomous_vm_clusters #=> Array
resp.cloud_exadata_infrastructure_unallocated_resources.cloud_autonomous_vm_clusters[0].cloud_autonomous_vm_cluster_id #=> String
resp.cloud_exadata_infrastructure_unallocated_resources.cloud_autonomous_vm_clusters[0].unallocated_adb_storage_in_t_bs #=> Float
resp.cloud_exadata_infrastructure_unallocated_resources.cloud_exadata_infrastructure_display_name #=> String
resp.cloud_exadata_infrastructure_unallocated_resources.exadata_storage_in_t_bs #=> Float
resp.cloud_exadata_infrastructure_unallocated_resources.cloud_exadata_infrastructure_id #=> String
resp.cloud_exadata_infrastructure_unallocated_resources.local_storage_in_g_bs #=> Integer
resp.cloud_exadata_infrastructure_unallocated_resources.memory_in_g_bs #=> Integer
resp.cloud_exadata_infrastructure_unallocated_resources.ocpus #=> Integer

Parameters:

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

    ({})

Options Hash (params):

  • :cloud_exadata_infrastructure_id (required, String) —

    The unique identifier of the Cloud Exadata infrastructure for which to retrieve unallocated resources.

  • :db_servers (Array<String>) —

    The database servers to include in the unallocated resources query.

Returns:

See Also:



2853
2854
2855
2856
 
# File 'gems/aws-sdk-odb/lib/aws-sdk-odb/client.rb', line 2853

def get_cloud_exadata_infrastructure_unallocated_resources(params = {}, options = {})
  req = build_request(:get_cloud_exadata_infrastructure_unallocated_resources, params)
  req.send_request(options)
end

#get_cloud_vm_cluster(params = {}) ⇒ Types::GetCloudVmClusterOutput

Returns information about the specified VM cluster.

Examples:

Request syntax with placeholder values


resp = client.get_cloud_vm_cluster({
  cloud_vm_cluster_id: "ResourceId", # required
})

Response structure


resp.cloud_vm_cluster.cloud_vm_cluster_id #=> String
resp.cloud_vm_cluster.display_name #=> String
resp.cloud_vm_cluster.status #=> String, one of "AVAILABLE", "FAILED", "PROVISIONING", "TERMINATED", "TERMINATING", "UPDATING", "MAINTENANCE_IN_PROGRESS"
resp.cloud_vm_cluster.status_reason #=> String
resp.cloud_vm_cluster.cloud_vm_cluster_arn #=> String
resp.cloud_vm_cluster.cloud_exadata_infrastructure_id #=> String
resp.cloud_vm_cluster.cloud_exadata_infrastructure_arn #=> String
resp.cloud_vm_cluster.exascale_db_storage_vault_id #=> String
resp.cloud_vm_cluster.exascale_db_storage_vault_arn #=> String
resp.cloud_vm_cluster.storage_management_type #=> String, one of "ASM", "EXASCALE"
resp.cloud_vm_cluster.vm_file_system_storage_type #=> String, one of "LOCAL", "EXASCALE"
resp.cloud_vm_cluster.vm_backup_storage_type #=> String, one of "LOCAL", "EXASCALE"
resp.cloud_vm_cluster.file_system_configuration_details #=> Array
resp.cloud_vm_cluster.file_system_configuration_details[0].mount_point #=> String
resp.cloud_vm_cluster.file_system_configuration_details[0].file_system_size_in_g_bs #=> Integer
resp.cloud_vm_cluster.cluster_name #=> String
resp.cloud_vm_cluster.cpu_core_count #=> Integer
resp.cloud_vm_cluster.data_collection_options.is_diagnostics_events_enabled #=> Boolean
resp.cloud_vm_cluster.data_collection_options.is_health_monitoring_enabled #=> Boolean
resp.cloud_vm_cluster.data_collection_options.is_incident_logs_enabled #=> Boolean
resp.cloud_vm_cluster.data_storage_size_in_t_bs #=> Float
resp.cloud_vm_cluster.db_node_storage_size_in_g_bs #=> Integer
resp.cloud_vm_cluster.db_servers #=> Array
resp.cloud_vm_cluster.db_servers[0] #=> String
resp.cloud_vm_cluster.disk_redundancy #=> String, one of "HIGH", "NORMAL"
resp.cloud_vm_cluster.gi_version #=> String
resp.cloud_vm_cluster.hostname #=> String
resp.cloud_vm_cluster.iorm_config_cache.db_plans #=> Array
resp.cloud_vm_cluster.iorm_config_cache.db_plans[0].db_name #=> String
resp.cloud_vm_cluster.iorm_config_cache.db_plans[0].flash_cache_limit #=> String
resp.cloud_vm_cluster.iorm_config_cache.db_plans[0].share #=> Integer
resp.cloud_vm_cluster.iorm_config_cache.lifecycle_details #=> String
resp.cloud_vm_cluster.iorm_config_cache.lifecycle_state #=> String, one of "BOOTSTRAPPING", "DISABLED", "ENABLED", "FAILED", "UPDATING"
resp.cloud_vm_cluster.iorm_config_cache.objective #=> String, one of "AUTO", "BALANCED", "BASIC", "HIGH_THROUGHPUT", "LOW_LATENCY"
resp.cloud_vm_cluster.is_local_backup_enabled #=> Boolean
resp.cloud_vm_cluster.is_sparse_diskgroup_enabled #=> Boolean
resp.cloud_vm_cluster.last_update_history_entry_id #=> String
resp.cloud_vm_cluster.license_model #=> String, one of "BRING_YOUR_OWN_LICENSE", "LICENSE_INCLUDED"
resp.cloud_vm_cluster.listener_port #=> Integer
resp.cloud_vm_cluster.memory_size_in_g_bs #=> Integer
resp.cloud_vm_cluster.node_count #=> Integer
resp.cloud_vm_cluster.ocid #=> String
resp.cloud_vm_cluster.oci_resource_anchor_name #=> String
resp.cloud_vm_cluster.oci_url #=> String
resp.cloud_vm_cluster.domain #=> String
resp.cloud_vm_cluster.scan_dns_name #=> String
resp.cloud_vm_cluster.scan_dns_record_id #=> String
resp.cloud_vm_cluster.scan_ip_ids #=> Array
resp.cloud_vm_cluster.scan_ip_ids[0] #=> String
resp.cloud_vm_cluster.shape #=> String
resp.cloud_vm_cluster.ssh_public_keys #=> Array
resp.cloud_vm_cluster.ssh_public_keys[0] #=> String
resp.cloud_vm_cluster.storage_size_in_g_bs #=> Integer
resp.cloud_vm_cluster.system_version #=> String
resp.cloud_vm_cluster.created_at #=> Time
resp.cloud_vm_cluster.time_zone #=> String
resp.cloud_vm_cluster.vip_ids #=> Array
resp.cloud_vm_cluster.vip_ids[0] #=> String
resp.cloud_vm_cluster.odb_network_id #=> String
resp.cloud_vm_cluster.odb_network_arn #=> String
resp.cloud_vm_cluster.percent_progress #=> Float
resp.cloud_vm_cluster.compute_model #=> String, one of "ECPU", "OCPU"
resp.cloud_vm_cluster.iam_roles #=> Array
resp.cloud_vm_cluster.iam_roles[0].iam_role_arn #=> String
resp.cloud_vm_cluster.iam_roles[0].status #=> String, one of "ASSOCIATING", "DISASSOCIATING", "FAILED", "CONNECTED", "DISCONNECTED", "PARTIALLY_CONNECTED", "UNKNOWN"
resp.cloud_vm_cluster.iam_roles[0].status_reason #=> String
resp.cloud_vm_cluster.iam_roles[0].aws_integration #=> String, one of "KmsTde"

Parameters:

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

    ({})

Options Hash (params):

  • :cloud_vm_cluster_id (required, String) —

    The unique identifier of the VM cluster.

Returns:

See Also:



2947
2948
2949
2950
 
# File 'gems/aws-sdk-odb/lib/aws-sdk-odb/client.rb', line 2947

def get_cloud_vm_cluster(params = {}, options = {})
  req = build_request(:get_cloud_vm_cluster, params)
  req.send_request(options)
end

#get_db_node(params = {}) ⇒ Types::GetDbNodeOutput

Returns information about the specified DB node.

Examples:

Request syntax with placeholder values


resp = client.get_db_node({
  cloud_vm_cluster_id: "ResourceId",
  exadb_vm_cluster_id: "ResourceId",
  db_node_id: "ResourceId", # required
})

Response structure


resp.db_node.db_node_id #=> String
resp.db_node.db_node_arn #=> String
resp.db_node.status #=> String, one of "AVAILABLE", "FAILED", "PROVISIONING", "TERMINATED", "TERMINATING", "UPDATING", "STOPPING", "STOPPED", "STARTING"
resp.db_node.status_reason #=> String
resp.db_node.additional_details #=> String
resp.db_node.backup_ip_id #=> String
resp.db_node.backup_vnic_2_id #=> String
resp.db_node.backup_vnic_id #=> String
resp.db_node.cpu_core_count #=> Integer
resp.db_node.db_node_storage_size_in_g_bs #=> Integer
resp.db_node.db_server_id #=> String
resp.db_node.db_system_id #=> String
resp.db_node.fault_domain #=> String
resp.db_node.host_ip_id #=> String
resp.db_node.hostname #=> String
resp.db_node.ocid #=> String
resp.db_node.oci_resource_anchor_name #=> String
resp.db_node.maintenance_type #=> String, one of "VMDB_REBOOT_MIGRATION"
resp.db_node.memory_size_in_g_bs #=> Integer
resp.db_node.software_storage_size_in_gb #=> Integer
resp.db_node.created_at #=> Time
resp.db_node.time_maintenance_window_end #=> String
resp.db_node.time_maintenance_window_start #=> String
resp.db_node.total_cpu_core_count #=> Integer
resp.db_node.vnic2_id #=> String
resp.db_node.vnic_id #=> String
resp.db_node.private_ip_address #=> String
resp.db_node.floating_ip_address #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :cloud_vm_cluster_id (String) —

    The unique identifier of the VM cluster that contains the DB node. You must specify either this parameter or exadbVmClusterId.

  • :exadb_vm_cluster_id (String) —

    The unique identifier of the Exascale VM cluster that contains the DB node. You must specify either this parameter or cloudVmClusterId.

  • :db_node_id (required, String) —

    The unique identifier of the DB node to retrieve information about.

Returns:

See Also:



3012
3013
3014
3015
 
# File 'gems/aws-sdk-odb/lib/aws-sdk-odb/client.rb', line 3012

def get_db_node(params = {}, options = {})
  req = build_request(:get_db_node, params)
  req.send_request(options)
end

#get_db_server(params = {}) ⇒ Types::GetDbServerOutput

Returns information about the specified database server.

Examples:

Request syntax with placeholder values


resp = client.get_db_server({
  cloud_exadata_infrastructure_id: "ResourceIdOrArn", # required
  db_server_id: "ResourceId", # required
})

Response structure


resp.db_server.db_server_id #=> String
resp.db_server.status #=> String, one of "AVAILABLE", "FAILED", "PROVISIONING", "TERMINATED", "TERMINATING", "UPDATING", "MAINTENANCE_IN_PROGRESS"
resp.db_server.status_reason #=> String
resp.db_server.cpu_core_count #=> Integer
resp.db_server.db_node_storage_size_in_g_bs #=> Integer
resp.db_server.db_server_patching_details.estimated_patch_duration #=> Integer
resp.db_server.db_server_patching_details.patching_status #=> String, one of "COMPLETE", "FAILED", "MAINTENANCE_IN_PROGRESS", "SCHEDULED"
resp.db_server.db_server_patching_details.time_patching_ended #=> String
resp.db_server.db_server_patching_details.time_patching_started #=> String
resp.db_server.display_name #=> String
resp.db_server.exadata_infrastructure_id #=> String
resp.db_server.ocid #=> String
resp.db_server.oci_resource_anchor_name #=> String
resp.db_server.max_cpu_count #=> Integer
resp.db_server.max_db_node_storage_in_g_bs #=> Integer
resp.db_server.max_memory_in_g_bs #=> Integer
resp.db_server.memory_size_in_g_bs #=> Integer
resp.db_server.shape #=> String
resp.db_server.created_at #=> Time
resp.db_server.vm_cluster_ids #=> Array
resp.db_server.vm_cluster_ids[0] #=> String
resp.db_server.compute_model #=> String, one of "ECPU", "OCPU"
resp.db_server.autonomous_vm_cluster_ids #=> Array
resp.db_server.autonomous_vm_cluster_ids[0] #=> String
resp.db_server.autonomous_virtual_machine_ids #=> Array
resp.db_server.autonomous_virtual_machine_ids[0] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :cloud_exadata_infrastructure_id (required, String) —

    The unique identifier of the Oracle Exadata infrastructure that contains the database server.

  • :db_server_id (required, String) —

    The unique identifier of the database server to retrieve information about.

Returns:

See Also:



3071
3072
3073
3074
 
# File 'gems/aws-sdk-odb/lib/aws-sdk-odb/client.rb', line 3071

def get_db_server(params = {}, options = {})
  req = build_request(:get_db_server, params)
  req.send_request(options)
end

#get_exadb_vm_cluster(params = {}) ⇒ Types::GetExadbVmClusterOutput

Returns information about the specified Exascale VM cluster.

Examples:

Request syntax with placeholder values


resp = client.get_exadb_vm_cluster({
  exadb_vm_cluster_id: "ResourceIdOrArn", # required
})

Response structure


resp.exadb_vm_cluster.exadb_vm_cluster_id #=> String
resp.exadb_vm_cluster.cluster_name #=> String
resp.exadb_vm_cluster.created_at #=> Time
resp.exadb_vm_cluster.data_collection_options.is_diagnostics_events_enabled #=> Boolean
resp.exadb_vm_cluster.data_collection_options.is_health_monitoring_enabled #=> Boolean
resp.exadb_vm_cluster.data_collection_options.is_incident_logs_enabled #=> Boolean
resp.exadb_vm_cluster.display_name #=> String
resp.exadb_vm_cluster.domain #=> String
resp.exadb_vm_cluster.enabled_ecpu_count #=> Integer
resp.exadb_vm_cluster.exadb_vm_cluster_arn #=> String
resp.exadb_vm_cluster.exascale_db_storage_vault_arn #=> String
resp.exadb_vm_cluster.exascale_db_storage_vault_id #=> String
resp.exadb_vm_cluster.gi_version #=> String
resp.exadb_vm_cluster.grid_image_id #=> String
resp.exadb_vm_cluster.grid_image_type #=> String, one of "RELEASE_UPDATE", "CUSTOM_IMAGE"
resp.exadb_vm_cluster.hostname #=> String
resp.exadb_vm_cluster.iam_roles #=> Array
resp.exadb_vm_cluster.iam_roles[0].iam_role_arn #=> String
resp.exadb_vm_cluster.iam_roles[0].status #=> String, one of "ASSOCIATING", "DISASSOCIATING", "FAILED", "CONNECTED", "DISCONNECTED", "PARTIALLY_CONNECTED", "UNKNOWN"
resp.exadb_vm_cluster.iam_roles[0].status_reason #=> String
resp.exadb_vm_cluster.iam_roles[0].aws_integration #=> String, one of "KmsTde"
resp.exadb_vm_cluster.iorm_config_cache.db_plans #=> Array
resp.exadb_vm_cluster.iorm_config_cache.db_plans[0].db_name #=> String
resp.exadb_vm_cluster.iorm_config_cache.db_plans[0].flash_cache_limit #=> String
resp.exadb_vm_cluster.iorm_config_cache.db_plans[0].share #=> Integer
resp.exadb_vm_cluster.iorm_config_cache.lifecycle_details #=> String
resp.exadb_vm_cluster.iorm_config_cache.lifecycle_state #=> String, one of "BOOTSTRAPPING", "DISABLED", "ENABLED", "FAILED", "UPDATING"
resp.exadb_vm_cluster.iorm_config_cache.objective #=> String, one of "AUTO", "BALANCED", "BASIC", "HIGH_THROUGHPUT", "LOW_LATENCY"
resp.exadb_vm_cluster.last_update_history_entry_id #=> String
resp.exadb_vm_cluster.license_model #=> String, one of "BRING_YOUR_OWN_LICENSE", "LICENSE_INCLUDED"
resp.exadb_vm_cluster.listener_port #=> Integer
resp.exadb_vm_cluster.memory_size_in_g_bs #=> Integer
resp.exadb_vm_cluster.node_count #=> Integer
resp.exadb_vm_cluster.ocid #=> String
resp.exadb_vm_cluster.oci_resource_anchor_name #=> String
resp.exadb_vm_cluster.oci_url #=> String
resp.exadb_vm_cluster.odb_network_arn #=> String
resp.exadb_vm_cluster.odb_network_id #=> String
resp.exadb_vm_cluster.percent_progress #=> Float
resp.exadb_vm_cluster.scan_dns_name #=> String
resp.exadb_vm_cluster.scan_dns_record_id #=> String
resp.exadb_vm_cluster.scan_ip_ids #=> Array
resp.exadb_vm_cluster.scan_ip_ids[0] #=> String
resp.exadb_vm_cluster.scan_listener_port_tcp #=> Integer
resp.exadb_vm_cluster.scan_listener_port_tcp_ssl #=> Integer
resp.exadb_vm_cluster.shape #=> String
resp.exadb_vm_cluster.shape_attribute #=> String, one of "SMART_STORAGE", "BLOCK_STORAGE"
resp.exadb_vm_cluster.snapshot_file_system_storage.total_size_in_g_bs #=> Integer
resp.exadb_vm_cluster.ssh_public_keys #=> Array
resp.exadb_vm_cluster.ssh_public_keys[0] #=> String
resp.exadb_vm_cluster.status #=> String, one of "AVAILABLE", "FAILED", "PROVISIONING", "TERMINATED", "TERMINATING", "UPDATING", "MAINTENANCE_IN_PROGRESS"
resp.exadb_vm_cluster.status_reason #=> String
resp.exadb_vm_cluster.system_version #=> String
resp.exadb_vm_cluster.time_zone #=> String
resp.exadb_vm_cluster.total_ecpu_count #=> Integer
resp.exadb_vm_cluster.total_file_system_storage.total_size_in_g_bs #=> Integer
resp.exadb_vm_cluster.vip_ids #=> Array
resp.exadb_vm_cluster.vip_ids[0] #=> String
resp.exadb_vm_cluster.vm_file_system_storage.total_size_in_g_bs #=> Integer

Parameters:

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

    ({})

Options Hash (params):

  • :exadb_vm_cluster_id (required, String) —

    The unique identifier of the Exascale VM cluster.

Returns:

See Also:



3157
3158
3159
3160
 
# File 'gems/aws-sdk-odb/lib/aws-sdk-odb/client.rb', line 3157

def get_exadb_vm_cluster(params = {}, options = {})
  req = build_request(:get_exadb_vm_cluster, params)
  req.send_request(options)
end

#get_exascale_db_storage_vault(params = {}) ⇒ Types::GetExascaleDbStorageVaultOutput

Returns information about the specified Exascale storage vault.

Examples:

Request syntax with placeholder values


resp = client.get_exascale_db_storage_vault({
  exascale_db_storage_vault_id: "ResourceIdOrArn", # required
})

Response structure


resp.exascale_db_storage_vault.exascale_db_storage_vault_id #=> String
resp.exascale_db_storage_vault.additional_flash_cache_in_percent #=> Integer
resp.exascale_db_storage_vault.attached_shape_attributes #=> Array
resp.exascale_db_storage_vault.attached_shape_attributes[0] #=> String, one of "SMART_STORAGE", "BLOCK_STORAGE"
resp.exascale_db_storage_vault.autoscale_limit_in_g_bs #=> Integer
resp.exascale_db_storage_vault.availability_zone #=> String
resp.exascale_db_storage_vault.availability_zone_id #=> String
resp.exascale_db_storage_vault.cloud_exadata_infrastructure_arn #=> String
resp.exascale_db_storage_vault.cloud_exadata_infrastructure_id #=> String
resp.exascale_db_storage_vault.created_at #=> Time
resp.exascale_db_storage_vault.description #=> String
resp.exascale_db_storage_vault.display_name #=> String
resp.exascale_db_storage_vault.vm_cluster_arns #=> Array
resp.exascale_db_storage_vault.vm_cluster_arns[0] #=> String
resp.exascale_db_storage_vault.vm_cluster_count #=> Integer
resp.exascale_db_storage_vault.vm_cluster_ids #=> Array
resp.exascale_db_storage_vault.vm_cluster_ids[0] #=> String
resp.exascale_db_storage_vault.exascale_db_storage_vault_arn #=> String
resp.exascale_db_storage_vault.high_capacity_database_storage.available_size_in_g_bs #=> Integer
resp.exascale_db_storage_vault.high_capacity_database_storage.total_size_in_g_bs #=> Integer
resp.exascale_db_storage_vault.is_autoscale_enabled #=> Boolean
resp.exascale_db_storage_vault.ocid #=> String
resp.exascale_db_storage_vault.oci_resource_anchor_name #=> String
resp.exascale_db_storage_vault.oci_url #=> String
resp.exascale_db_storage_vault.percent_progress #=> Float
resp.exascale_db_storage_vault.status #=> String, one of "AVAILABLE", "FAILED", "PROVISIONING", "TERMINATED", "TERMINATING", "UPDATING", "MAINTENANCE_IN_PROGRESS"
resp.exascale_db_storage_vault.status_reason #=> String
resp.exascale_db_storage_vault.time_zone #=> String
resp.exascale_db_storage_vault.vault_type #=> String, one of "EXASCALE_INFRASTRUCTURE", "DEDICATED_INFRASTRUCTURE"

Parameters:

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

    ({})

Options Hash (params):

  • :exascale_db_storage_vault_id (required, String) —

    The unique identifier of the Exascale storage vault.

Returns:

See Also:



3213
3214
3215
3216
 
# File 'gems/aws-sdk-odb/lib/aws-sdk-odb/client.rb', line 3213

def get_exascale_db_storage_vault(params = {}, options = {})
  req = build_request(:get_exascale_db_storage_vault, params)
  req.send_request(options)
end

#get_oci_onboarding_status(params = {}) ⇒ Types::GetOciOnboardingStatusOutput

Returns the tenancy activation link and onboarding status for your Amazon Web Services account.

Examples:

Response structure


resp.status #=> String, one of "NOT_STARTED", "PENDING_LINK_GENERATION", "PENDING_CUSTOMER_ACTION", "PENDING_INITIALIZATION", "ACTIVATING", "ACTIVE_IN_HOME_REGION", "ACTIVE", "ACTIVE_LIMITED", "FAILED", "PUBLIC_OFFER_UNSUPPORTED", "SUSPENDED", "CANCELED"
resp.existing_tenancy_activation_link #=> String
resp.new_tenancy_activation_link #=> String
resp.oci_identity_domain.oci_identity_domain_id #=> String
resp.oci_identity_domain.oci_identity_domain_resource_url #=> String
resp.oci_identity_domain.oci_identity_domain_url #=> String
resp.oci_identity_domain.status #=> String, one of "AVAILABLE", "FAILED", "PROVISIONING", "TERMINATED", "TERMINATING", "UPDATING", "MAINTENANCE_IN_PROGRESS"
resp.oci_identity_domain.status_reason #=> String
resp.oci_identity_domain. #=> String
resp.autonomous_database_oci_integration_iam_roles #=> Array
resp.autonomous_database_oci_integration_iam_roles[0].iam_role_arn #=> String
resp.autonomous_database_oci_integration_iam_roles[0].aws_integration #=> String, one of "KmsTde", "SecretsManager"
resp.autonomous_database_oci_integration_iam_roles[0].status #=> String, one of "PROVISIONING", "AVAILABLE", "PROVISION_FAILED", "TERMINATING", "TERMINATE_FAILED"
resp.autonomous_database_oci_integration_iam_roles[0].status_reason #=> String
resp.linked_oci_tenancy_id #=> String
resp.linked_oci_compartment_id #=> String
resp.subscription_errors #=> Array
resp.subscription_errors[0].error_message #=> String

Parameters:

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

    ({})

Returns:

See Also:



3257
3258
3259
3260
 
# File 'gems/aws-sdk-odb/lib/aws-sdk-odb/client.rb', line 3257

def get_oci_onboarding_status(params = {}, options = {})
  req = build_request(:get_oci_onboarding_status, params)
  req.send_request(options)
end

#get_odb_network(params = {}) ⇒ Types::GetOdbNetworkOutput

Returns information about the specified ODB network.

Examples:

Request syntax with placeholder values


resp = client.get_odb_network({
  odb_network_id: "ResourceIdOrArn", # required
})

Response structure


resp.odb_network.odb_network_id #=> String
resp.odb_network.display_name #=> String
resp.odb_network.status #=> String, one of "AVAILABLE", "FAILED", "PROVISIONING", "TERMINATED", "TERMINATING", "UPDATING", "MAINTENANCE_IN_PROGRESS"
resp.odb_network.status_reason #=> String
resp.odb_network.odb_network_arn #=> String
resp.odb_network.availability_zone #=> String
resp.odb_network.availability_zone_id #=> String
resp.odb_network.client_subnet_cidr #=> String
resp.odb_network.backup_subnet_cidr #=> String
resp.odb_network.custom_domain_name #=> String
resp.odb_network.default_dns_prefix #=> String
resp.odb_network.peered_cidrs #=> Array
resp.odb_network.peered_cidrs[0] #=> String
resp.odb_network.oci_network_anchor_id #=> String
resp.odb_network.oci_network_anchor_url #=> String
resp.odb_network.oci_resource_anchor_name #=> String
resp.odb_network.oci_vcn_id #=> String
resp.odb_network.oci_vcn_url #=> String
resp.odb_network.oci_dns_forwarding_configs #=> Array
resp.odb_network.oci_dns_forwarding_configs[0].domain_name #=> String
resp.odb_network.oci_dns_forwarding_configs[0].oci_dns_listener_ip #=> String
resp.odb_network.created_at #=> Time
resp.odb_network.percent_progress #=> Float
resp.odb_network.managed_services.service_network_arn #=> String
resp.odb_network.managed_services.resource_gateway_arn #=> String
resp.odb_network.managed_services.managed_services_ipv_4_cidrs #=> Array
resp.odb_network.managed_services.managed_services_ipv_4_cidrs[0] #=> String
resp.odb_network.managed_services.service_network_endpoint.vpc_endpoint_id #=> String
resp.odb_network.managed_services.service_network_endpoint.vpc_endpoint_type #=> String, one of "SERVICENETWORK"
resp.odb_network.managed_services.managed_s3_backup_access.status #=> String, one of "ENABLED", "ENABLING", "DISABLED", "DISABLING"
resp.odb_network.managed_services.managed_s3_backup_access.ipv4_addresses #=> Array
resp.odb_network.managed_services.managed_s3_backup_access.ipv4_addresses[0] #=> String
resp.odb_network.managed_services.zero_etl_access.status #=> String, one of "ENABLED", "ENABLING", "DISABLED", "DISABLING"
resp.odb_network.managed_services.zero_etl_access.cidr #=> String
resp.odb_network.managed_services.s3_access.status #=> String, one of "ENABLED", "ENABLING", "DISABLED", "DISABLING"
resp.odb_network.managed_services.s3_access.ipv4_addresses #=> Array
resp.odb_network.managed_services.s3_access.ipv4_addresses[0] #=> String
resp.odb_network.managed_services.s3_access.domain_name #=> String
resp.odb_network.managed_services.s3_access.s3_policy_document #=> String
resp.odb_network.managed_services.sts_access.status #=> String, one of "ENABLED", "ENABLING", "DISABLED", "DISABLING"
resp.odb_network.managed_services.sts_access.ipv4_addresses #=> Array
resp.odb_network.managed_services.sts_access.ipv4_addresses[0] #=> String
resp.odb_network.managed_services.sts_access.domain_name #=> String
resp.odb_network.managed_services.sts_access.sts_policy_document #=> String
resp.odb_network.managed_services.kms_access.status #=> String, one of "ENABLED", "ENABLING", "DISABLED", "DISABLING"
resp.odb_network.managed_services.kms_access.ipv4_addresses #=> Array
resp.odb_network.managed_services.kms_access.ipv4_addresses[0] #=> String
resp.odb_network.managed_services.kms_access.domain_name #=> String
resp.odb_network.managed_services.kms_access.kms_policy_document #=> String
resp.odb_network.managed_services.cross_region_s3_restore_sources_access #=> Array
resp.odb_network.managed_services.cross_region_s3_restore_sources_access[0].region #=> String
resp.odb_network.managed_services.cross_region_s3_restore_sources_access[0].ipv4_addresses #=> Array
resp.odb_network.managed_services.cross_region_s3_restore_sources_access[0].ipv4_addresses[0] #=> String
resp.odb_network.managed_services.cross_region_s3_restore_sources_access[0].status #=> String, one of "ENABLED", "ENABLING", "DISABLED", "DISABLING"
resp.odb_network.ec2_placement_group_ids #=> Array
resp.odb_network.ec2_placement_group_ids[0] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :odb_network_id (required, String) —

    The unique identifier of the ODB network.

Returns:

See Also:



3340
3341
3342
3343
 
# File 'gems/aws-sdk-odb/lib/aws-sdk-odb/client.rb', line 3340

def get_odb_network(params = {}, options = {})
  req = build_request(:get_odb_network, params)
  req.send_request(options)
end

#get_odb_peering_connection(params = {}) ⇒ Types::GetOdbPeeringConnectionOutput

Retrieves information about an ODB peering connection.

Examples:

Request syntax with placeholder values


resp = client.get_odb_peering_connection({
  odb_peering_connection_id: "ResourceIdOrArn", # required
})

Response structure


resp.odb_peering_connection.odb_peering_connection_id #=> String
resp.odb_peering_connection.display_name #=> String
resp.odb_peering_connection.status #=> String, one of "AVAILABLE", "FAILED", "PROVISIONING", "TERMINATED", "TERMINATING", "UPDATING", "MAINTENANCE_IN_PROGRESS"
resp.odb_peering_connection.status_reason #=> String
resp.odb_peering_connection.odb_peering_connection_arn #=> String
resp.odb_peering_connection.odb_network_arn #=> String
resp.odb_peering_connection.peer_network_arn #=> String
resp.odb_peering_connection.odb_peering_connection_type #=> String
resp.odb_peering_connection.peer_network_cidrs #=> Array
resp.odb_peering_connection.peer_network_cidrs[0] #=> String
resp.odb_peering_connection.created_at #=> Time
resp.odb_peering_connection.percent_progress #=> Float

Parameters:

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

    ({})

Options Hash (params):

  • :odb_peering_connection_id (required, String) —

    The unique identifier of the ODB peering connection to retrieve information about.

Returns:

See Also:



3380
3381
3382
3383
 
# File 'gems/aws-sdk-odb/lib/aws-sdk-odb/client.rb', line 3380

def get_odb_peering_connection(params = {}, options = {})
  req = build_request(:get_odb_peering_connection, params)
  req.send_request(options)
end

#initialize_service(params = {}) ⇒ Struct

Initializes the ODB service for the first time in an account.

Examples:

Request syntax with placeholder values


resp = client.initialize_service({
  oci_identity_domain: false,
  autonomous_database_oci_aws_secrets_manager_integration: "ENABLED", # accepts ENABLED, DISABLED
})

Parameters:

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

    ({})

Options Hash (params):

  • :oci_identity_domain (Boolean) —

    The Oracle Cloud Infrastructure (OCI) identity domain configuration for service initialization.

  • :autonomous_database_oci_aws_secrets_manager_integration (String) —

    Specifies whether to enable or disable the OCI service-account role for Amazon Web Services Secrets Manager integration with Autonomous Database.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3409
3410
3411
3412
 
# File 'gems/aws-sdk-odb/lib/aws-sdk-odb/client.rb', line 3409

def initialize_service(params = {}, options = {})
  req = build_request(:initialize_service, params)
  req.send_request(options)
end

#list_autonomous_database_backups(params = {}) ⇒ Types::ListAutonomousDatabaseBackupsOutput

Lists the backups of the specified Autonomous Database.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_autonomous_database_backups({
  max_results: 1,
  next_token: "ListAutonomousDatabaseBackupsInputNextTokenString",
  autonomous_database_id: "ResourceId", # required
  status: "ACTIVE", # accepts ACTIVE, CREATING, UPDATING, DELETING, FAILED
  type: "INCREMENTAL", # accepts INCREMENTAL, FULL, LONGTERM, VIRTUAL_FULL, CUMULATIVE_INCREMENTAL, ROLL_FORWARD_IMAGE_COPY
})

Response structure


resp.next_token #=> String
resp.autonomous_database_backups #=> Array
resp.autonomous_database_backups[0].autonomous_database_backup_id #=> String
resp.autonomous_database_backups[0].autonomous_database_backup_arn #=> String
resp.autonomous_database_backups[0].autonomous_database_id #=> String
resp.autonomous_database_backups[0].ocid #=> String
resp.autonomous_database_backups[0].display_name #=> String
resp.autonomous_database_backups[0].db_version #=> String
resp.autonomous_database_backups[0].status #=> String, one of "ACTIVE", "CREATING", "UPDATING", "DELETING", "FAILED"
resp.autonomous_database_backups[0].status_reason #=> String
resp.autonomous_database_backups[0].is_automatic #=> Boolean
resp.autonomous_database_backups[0].retention_period_in_days #=> Integer
resp.autonomous_database_backups[0].size_in_t_bs #=> Float
resp.autonomous_database_backups[0].time_available_till #=> Time
resp.autonomous_database_backups[0].time_started #=> Time
resp.autonomous_database_backups[0].time_ended #=> Time
resp.autonomous_database_backups[0].type #=> String, one of "INCREMENTAL", "FULL", "LONGTERM", "VIRTUAL_FULL", "CUMULATIVE_INCREMENTAL", "ROLL_FORWARD_IMAGE_COPY"

Parameters:

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

    ({})

Options Hash (params):

  • :max_results (Integer) —

    The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output.

  • :next_token (String) —

    The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

  • :autonomous_database_id (required, String) —

    The unique identifier of the Autonomous Database whose backups you want to list.

  • :status (String) —

    The status of the Autonomous Database backups to return results for.

  • :type (String) —

    The type of the Autonomous Database backups to return results for.

Returns:

See Also:



3476
3477
3478
3479
 
# File 'gems/aws-sdk-odb/lib/aws-sdk-odb/client.rb', line 3476

def list_autonomous_database_backups(params = {}, options = {})
  req = build_request(:list_autonomous_database_backups, params)
  req.send_request(options)
end

#list_autonomous_database_character_sets(params = {}) ⇒ Types::ListAutonomousDatabaseCharacterSetsOutput

Lists the available character sets for Autonomous Databases.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_autonomous_database_character_sets({
  max_results: 1,
  next_token: "ListAutonomousDatabaseCharacterSetsInputNextTokenString",
  character_set_type: "DATABASE", # accepts DATABASE, NATIONAL
})

Response structure


resp.next_token #=> String
resp.autonomous_database_character_sets #=> Array
resp.autonomous_database_character_sets[0].character_set #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :max_results (Integer) —

    The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output.

  • :next_token (String) —

    The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

  • :character_set_type (String) —

    The type of character set to return results for, either the database character set or the national character set.

Returns:

See Also:



3521
3522
3523
3524
 
# File 'gems/aws-sdk-odb/lib/aws-sdk-odb/client.rb', line 3521

def list_autonomous_database_character_sets(params = {}, options = {})
  req = build_request(:list_autonomous_database_character_sets, params)
  req.send_request(options)
end

#list_autonomous_database_clones(params = {}) ⇒ Types::ListAutonomousDatabaseClonesOutput

Lists the clones of the specified Autonomous Database.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_autonomous_database_clones({
  max_results: 1,
  next_token: "ListAutonomousDatabaseClonesInputNextTokenString",
  autonomous_database_id: "ResourceIdOrArn", # required
})

Response structure


resp.next_token #=> String
resp.autonomous_database_clones #=> Array
resp.autonomous_database_clones[0].autonomous_database_id #=> String
resp.autonomous_database_clones[0].autonomous_database_arn #=> String
resp.autonomous_database_clones[0].oci_resource_anchor_name #=> String
resp.autonomous_database_clones[0].percent_progress #=> Float
resp.autonomous_database_clones[0].ocid #=> String
resp.autonomous_database_clones[0].oci_url #=> String
resp.autonomous_database_clones[0].display_name #=> String
resp.autonomous_database_clones[0].db_name #=> String
resp.autonomous_database_clones[0].source_id #=> String
resp.autonomous_database_clones[0].status #=> String, one of "AVAILABLE", "FAILED", "PROVISIONING", "TERMINATED", "TERMINATING", "UPDATING", "MAINTENANCE_IN_PROGRESS", "STOPPING", "STOPPED", "STARTING", "UNAVAILABLE", "RESTORE_IN_PROGRESS", "RESTORE_FAILED", "BACKUP_IN_PROGRESS", "SCALE_IN_PROGRESS", "AVAILABLE_NEEDS_ATTENTION", "RESTARTING", "RECREATING", "ROLE_CHANGE_IN_PROGRESS", "UPGRADING", "INACCESSIBLE", "STANDBY"
resp.autonomous_database_clones[0].status_reason #=> String
resp.autonomous_database_clones[0].database_type #=> String, one of "REGULAR", "CLONE"
resp.autonomous_database_clones[0].db_version #=> String
resp.autonomous_database_clones[0].db_workload #=> String, one of "OLTP", "AJD", "APEX", "LH"
resp.autonomous_database_clones[0].character_set #=> String
resp.autonomous_database_clones[0].ncharacter_set #=> String
resp.autonomous_database_clones[0].database_edition #=> String, one of "STANDARD_EDITION", "ENTERPRISE_EDITION"
resp.autonomous_database_clones[0].license_model #=> String, one of "BRING_YOUR_OWN_LICENSE", "LICENSE_INCLUDED"
resp.autonomous_database_clones[0].open_mode #=> String, one of "READ_ONLY", "READ_WRITE"
resp.autonomous_database_clones[0].permission_level #=> String, one of "RESTRICTED", "UNRESTRICTED"
resp.autonomous_database_clones[0].is_mtls_connection_required #=> Boolean
resp.autonomous_database_clones[0].autonomous_maintenance_schedule_type #=> String, one of "EARLY", "REGULAR"
resp.autonomous_database_clones[0].net_services_architecture #=> String, one of "DEDICATED", "SHARED"
resp.autonomous_database_clones[0].available_upgrade_versions #=> Array
resp.autonomous_database_clones[0].available_upgrade_versions[0] #=> String
resp.autonomous_database_clones[0].byol_compute_count_limit #=> Integer
resp.autonomous_database_clones[0].connection_string_details.all_connection_strings #=> Hash
resp.autonomous_database_clones[0].connection_string_details.all_connection_strings["String"] #=> String
resp.autonomous_database_clones[0].connection_string_details.dedicated #=> String
resp.autonomous_database_clones[0].connection_string_details.high #=> String
resp.autonomous_database_clones[0].connection_string_details.medium #=> String
resp.autonomous_database_clones[0].connection_string_details.low #=> String
resp.autonomous_database_clones[0].connection_string_details.profiles #=> Array
resp.autonomous_database_clones[0].connection_string_details.profiles[0].consumer_group #=> String
resp.autonomous_database_clones[0].connection_string_details.profiles[0].display_name #=> String
resp.autonomous_database_clones[0].connection_string_details.profiles[0].host_format #=> String
resp.autonomous_database_clones[0].connection_string_details.profiles[0].is_regional #=> Boolean
resp.autonomous_database_clones[0].connection_string_details.profiles[0].protocol #=> String
resp.autonomous_database_clones[0].connection_string_details.profiles[0].session_mode #=> String
resp.autonomous_database_clones[0].connection_string_details.profiles[0].syntax_format #=> String
resp.autonomous_database_clones[0].connection_string_details.profiles[0].tls_authentication #=> String
resp.autonomous_database_clones[0].connection_string_details.profiles[0].value #=> String
resp.autonomous_database_clones[0].service_console_url #=> String
resp.autonomous_database_clones[0].sql_web_developer_url #=> String
resp.autonomous_database_clones[0].customer_contacts #=> Array
resp.autonomous_database_clones[0].customer_contacts[0].email #=> String
resp.autonomous_database_clones[0].apex_details.apex_version #=> String
resp.autonomous_database_clones[0].apex_details.ords_version #=> String
resp.autonomous_database_clones[0].standby_db.availability_domain #=> String
resp.autonomous_database_clones[0].standby_db.lag_time_in_seconds #=> Integer
resp.autonomous_database_clones[0].standby_db.status #=> String, one of "AVAILABLE", "FAILED", "PROVISIONING", "TERMINATED", "TERMINATING", "UPDATING", "MAINTENANCE_IN_PROGRESS", "STOPPING", "STOPPED", "STARTING", "UNAVAILABLE", "RESTORE_IN_PROGRESS", "RESTORE_FAILED", "BACKUP_IN_PROGRESS", "SCALE_IN_PROGRESS", "AVAILABLE_NEEDS_ATTENTION", "RESTARTING", "RECREATING", "ROLE_CHANGE_IN_PROGRESS", "UPGRADING", "INACCESSIBLE", "STANDBY"
resp.autonomous_database_clones[0].standby_db.status_reason #=> String
resp.autonomous_database_clones[0].standby_db.maintenance_target_component #=> String
resp.autonomous_database_clones[0].standby_db.time_data_guard_role_changed #=> Time
resp.autonomous_database_clones[0].standby_db.time_disaster_recovery_role_changed #=> Time
resp.autonomous_database_clones[0].standby_db.time_maintenance_begin #=> Time
resp.autonomous_database_clones[0].standby_db.time_maintenance_end #=> Time
resp.autonomous_database_clones[0].local_standby_db.availability_domain #=> String
resp.autonomous_database_clones[0].local_standby_db.lag_time_in_seconds #=> Integer
resp.autonomous_database_clones[0].local_standby_db.status #=> String, one of "AVAILABLE", "FAILED", "PROVISIONING", "TERMINATED", "TERMINATING", "UPDATING", "MAINTENANCE_IN_PROGRESS", "STOPPING", "STOPPED", "STARTING", "UNAVAILABLE", "RESTORE_IN_PROGRESS", "RESTORE_FAILED", "BACKUP_IN_PROGRESS", "SCALE_IN_PROGRESS", "AVAILABLE_NEEDS_ATTENTION", "RESTARTING", "RECREATING", "ROLE_CHANGE_IN_PROGRESS", "UPGRADING", "INACCESSIBLE", "STANDBY"
resp.autonomous_database_clones[0].local_standby_db.status_reason #=> String
resp.autonomous_database_clones[0].local_standby_db.maintenance_target_component #=> String
resp.autonomous_database_clones[0].local_standby_db.time_data_guard_role_changed #=> Time
resp.autonomous_database_clones[0].local_standby_db.time_disaster_recovery_role_changed #=> Time
resp.autonomous_database_clones[0].local_standby_db.time_maintenance_begin #=> Time
resp.autonomous_database_clones[0].local_standby_db.time_maintenance_end #=> Time
resp.autonomous_database_clones[0].data_safe_status #=> String, one of "REGISTERING", "REGISTERED", "DEREGISTERING", "NOT_REGISTERED", "FAILED"
resp.autonomous_database_clones[0].database_management_status #=> String, one of "ENABLING", "ENABLED", "DISABLING", "NOT_ENABLED", "FAILED_ENABLING", "FAILED_DISABLING"
resp.autonomous_database_clones[0].operations_insights_status #=> String, one of "ENABLING", "ENABLED", "DISABLING", "NOT_ENABLED", "FAILED_ENABLING", "FAILED_DISABLING"
resp.autonomous_database_clones[0].availability_zone #=> String
resp.autonomous_database_clones[0].availability_zone_id #=> String
resp.autonomous_database_clones[0].maintenance_target_component #=> String
resp.autonomous_database_clones[0].connection_urls.apex_url #=> String
resp.autonomous_database_clones[0].connection_urls.database_transforms_url #=> String
resp.autonomous_database_clones[0].connection_urls.graph_studio_url #=> String
resp.autonomous_database_clones[0].connection_urls.machine_learning_notebook_url #=> String
resp.autonomous_database_clones[0].connection_urls.machine_learning_user_management_url #=> String
resp.autonomous_database_clones[0].connection_urls.mongo_db_url #=> String
resp.autonomous_database_clones[0].connection_urls.ords_url #=> String
resp.autonomous_database_clones[0].connection_urls.spatial_studio_url #=> String
resp.autonomous_database_clones[0].connection_urls.sql_dev_web_url #=> String
resp.autonomous_database_clones[0].db_tools_details #=> Array
resp.autonomous_database_clones[0].db_tools_details[0].is_enabled #=> Boolean
resp.autonomous_database_clones[0].db_tools_details[0].name #=> String
resp.autonomous_database_clones[0].db_tools_details[0].compute_count #=> Float
resp.autonomous_database_clones[0].db_tools_details[0].max_idle_time_in_minutes #=> Integer
resp.autonomous_database_clones[0].scheduled_operations #=> Array
resp.autonomous_database_clones[0].scheduled_operations[0].day_of_week.name #=> String, one of "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY"
resp.autonomous_database_clones[0].scheduled_operations[0].scheduled_start_time #=> String
resp.autonomous_database_clones[0].scheduled_operations[0].scheduled_stop_time #=> String
resp.autonomous_database_clones[0].resource_pool_leader_id #=> String
resp.autonomous_database_clones[0].compute_count #=> Float
resp.autonomous_database_clones[0].compute_model #=> String, one of "ECPU", "OCPU"
resp.autonomous_database_clones[0].cpu_core_count #=> Integer
resp.autonomous_database_clones[0].memory_per_oracle_compute_unit_in_g_bs #=> Integer
resp.autonomous_database_clones[0].provisionable_cpus #=> Array
resp.autonomous_database_clones[0].provisionable_cpus[0] #=> Integer
resp.autonomous_database_clones[0].is_auto_scaling_enabled #=> Boolean
resp.autonomous_database_clones[0].data_storage_size_in_t_bs #=> Float
resp.autonomous_database_clones[0].data_storage_size_in_g_bs #=> Integer
resp.autonomous_database_clones[0].used_data_storage_size_in_t_bs #=> Float
resp.autonomous_database_clones[0].used_data_storage_size_in_g_bs #=> Integer
resp.autonomous_database_clones[0].actual_used_data_storage_size_in_t_bs #=> Float
resp.autonomous_database_clones[0].allocated_storage_size_in_t_bs #=> Float
resp.autonomous_database_clones[0].in_memory_area_in_g_bs #=> Integer
resp.autonomous_database_clones[0].is_auto_scaling_for_storage_enabled #=> Boolean
resp.autonomous_database_clones[0].odb_network_id #=> String
resp.autonomous_database_clones[0].odb_network_arn #=> String
resp.autonomous_database_clones[0].private_endpoint #=> String
resp.autonomous_database_clones[0].private_endpoint_ip #=> String
resp.autonomous_database_clones[0].private_endpoint_label #=> String
resp.autonomous_database_clones[0].allowlisted_ips #=> Array
resp.autonomous_database_clones[0].allowlisted_ips[0] #=> String
resp.autonomous_database_clones[0].standby_allowlisted_ips #=> Array
resp.autonomous_database_clones[0].standby_allowlisted_ips[0] #=> String
resp.autonomous_database_clones[0].standby_allowlisted_ips_source #=> String, one of "PRIMARY", "SEPARATE", "NOT_APPLICABLE"
resp.autonomous_database_clones[0].is_local_data_guard_enabled #=> Boolean
resp.autonomous_database_clones[0].is_remote_data_guard_enabled #=> Boolean
resp.autonomous_database_clones[0].local_disaster_recovery_type #=> String, one of "ADG", "BACKUP_BASED"
resp.autonomous_database_clones[0].role #=> String, one of "PRIMARY", "STANDBY", "DISABLED_STANDBY", "BACKUP_COPY", "SNAPSHOT_STANDBY"
resp.autonomous_database_clones[0].peer_db_ids #=> Array
resp.autonomous_database_clones[0].peer_db_ids[0] #=> String
resp.autonomous_database_clones[0].failed_data_recovery_in_seconds #=> Integer
resp.autonomous_database_clones[0].local_adg_auto_failover_max_data_loss_limit #=> Integer
resp.autonomous_database_clones[0].remote_disaster_recovery_configuration.disaster_recovery_type #=> String, one of "ADG", "BACKUP_BASED"
resp.autonomous_database_clones[0].remote_disaster_recovery_configuration.is_replicate_automatic_backups #=> Boolean
resp.autonomous_database_clones[0].remote_disaster_recovery_configuration.is_snapshot_standby #=> Boolean
resp.autonomous_database_clones[0].remote_disaster_recovery_configuration.time_snapshot_standby_enabled_till #=> Time
resp.autonomous_database_clones[0].is_refreshable_clone #=> Boolean
resp.autonomous_database_clones[0].refreshable_mode #=> String, one of "AUTOMATIC", "MANUAL"
resp.autonomous_database_clones[0].refreshable_status #=> String, one of "REFRESHING", "NOT_REFRESHING"
resp.autonomous_database_clones[0].auto_refresh_frequency_in_seconds #=> Integer
resp.autonomous_database_clones[0].auto_refresh_point_lag_in_seconds #=> Integer
resp.autonomous_database_clones[0].is_reconnect_clone_enabled #=> Boolean
resp.autonomous_database_clones[0].clone_table_space_list #=> Array
resp.autonomous_database_clones[0].clone_table_space_list[0] #=> Integer
resp.autonomous_database_clones[0].backup_retention_period_in_days #=> Integer
resp.autonomous_database_clones[0].long_term_backup_schedule.is_disabled #=> Boolean
resp.autonomous_database_clones[0].long_term_backup_schedule.repeat_cadence #=> String, one of "ONE_TIME", "WEEKLY", "MONTHLY", "YEARLY"
resp.autonomous_database_clones[0].long_term_backup_schedule.retention_period_in_days #=> Integer
resp.autonomous_database_clones[0].long_term_backup_schedule.time_of_backup #=> Time
resp.autonomous_database_clones[0].is_backup_retention_locked #=> Boolean
resp.autonomous_database_clones[0].total_backup_storage_size_in_g_bs #=> Float
resp.autonomous_database_clones[0].resource_pool_summary.is_disabled #=> Boolean
resp.autonomous_database_clones[0].resource_pool_summary.pool_size #=> Integer
resp.autonomous_database_clones[0].resource_pool_summary.pool_storage_size_in_t_bs #=> Integer
resp.autonomous_database_clones[0].resource_pool_summary.available_storage_capacity_in_t_bs #=> Float
resp.autonomous_database_clones[0].resource_pool_summary.total_compute_capacity #=> Integer
resp.autonomous_database_clones[0].resource_pool_summary.available_compute_capacity #=> Integer
resp.autonomous_database_clones[0].encryption_summary.encryption_key_provider #=> String, one of "ORACLE_MANAGED", "AWS_KMS", "OKV", "OCI"
resp.autonomous_database_clones[0].encryption_summary.encryption_key_configuration.aws_encryption_key.iam_role_arn #=> String
resp.autonomous_database_clones[0].encryption_summary.encryption_key_configuration.aws_encryption_key.external_id_type #=> String, one of "database_ocid", "compartment_ocid", "tenant_ocid"
resp.autonomous_database_clones[0].encryption_summary.encryption_key_configuration.aws_encryption_key.kms_key_id #=> String
resp.autonomous_database_clones[0].encryption_summary.encryption_key_configuration.oci_encryption_key.kms_key_id #=> String
resp.autonomous_database_clones[0].encryption_summary.encryption_key_configuration.oci_encryption_key.vault_id #=> String
resp.autonomous_database_clones[0].encryption_summary.encryption_key_configuration.okv_encryption_key.certificate_directory_name #=> String
resp.autonomous_database_clones[0].encryption_summary.encryption_key_configuration.okv_encryption_key.certificate_id #=> String
resp.autonomous_database_clones[0].encryption_summary.encryption_key_configuration.okv_encryption_key.directory_name #=> String
resp.autonomous_database_clones[0].encryption_summary.encryption_key_configuration.okv_encryption_key.okv_kms_key #=> String
resp.autonomous_database_clones[0].encryption_summary.encryption_key_configuration.okv_encryption_key.okv_uri #=> String
resp.autonomous_database_clones[0].created_at #=> Time
resp.autonomous_database_clones[0].time_of_last_backup #=> Time
resp.autonomous_database_clones[0].time_maintenance_begin #=> Time
resp.autonomous_database_clones[0].time_maintenance_end #=> Time
resp.autonomous_database_clones[0].time_local_data_guard_enabled #=> Time
resp.autonomous_database_clones[0].time_data_guard_role_changed #=> Time
resp.autonomous_database_clones[0].time_of_last_switchover #=> Time
resp.autonomous_database_clones[0].time_of_last_failover #=> Time
resp.autonomous_database_clones[0].time_of_last_refresh #=> Time
resp.autonomous_database_clones[0].time_of_last_refresh_point #=> Time
resp.autonomous_database_clones[0].time_of_next_refresh #=> Time
resp.autonomous_database_clones[0].time_of_auto_refresh_start #=> Time
resp.autonomous_database_clones[0].time_deletion_of_free_autonomous_database #=> Time
resp.autonomous_database_clones[0].time_reclamation_of_free_autonomous_database #=> Time
resp.autonomous_database_clones[0].time_disaster_recovery_role_changed #=> Time
resp.autonomous_database_clones[0].time_until_reconnect_clone_enabled #=> Time
resp.autonomous_database_clones[0].next_long_term_backup_time_stamp #=> Time
resp.autonomous_database_clones[0].time_undeleted #=> Time
resp.autonomous_database_clones[0].admin_password_source_summary.admin_password_source #=> String, one of "CUSTOMER_MANAGED_AWS_SECRET", "API_REQUEST_PARAMETER"
resp.autonomous_database_clones[0].admin_password_source_summary.admin_password_source_configuration.customer_managed_aws_secret.iam_role_arn #=> String
resp.autonomous_database_clones[0].admin_password_source_summary.admin_password_source_configuration.customer_managed_aws_secret.secret_id #=> String
resp.autonomous_database_clones[0].admin_password_source_summary.admin_password_source_configuration.customer_managed_aws_secret.external_id_type #=> String, one of "database_ocid", "compartment_ocid", "tenant_ocid"

Parameters:

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

    ({})

Options Hash (params):

  • :max_results (Integer) —

    The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output.

  • :next_token (String) —

    The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

  • :autonomous_database_id (required, String) —

    The unique identifier of the source Autonomous Database whose clones you want to list.

Returns:

See Also:



3747
3748
3749
3750
 
# File 'gems/aws-sdk-odb/lib/aws-sdk-odb/client.rb', line 3747

def list_autonomous_database_clones(params = {}, options = {})
  req = build_request(:list_autonomous_database_clones, params)
  req.send_request(options)
end

#list_autonomous_database_peers(params = {}) ⇒ Types::ListAutonomousDatabasePeersOutput

Lists the peer databases of the specified Autonomous Database.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_autonomous_database_peers({
  max_results: 1,
  next_token: "ListAutonomousDatabasePeersInputNextTokenString",
  autonomous_database_id: "ResourceIdOrArn", # required
})

Response structure


resp.next_token #=> String
resp.autonomous_database_peers #=> Array
resp.autonomous_database_peers[0].autonomous_database_id #=> String
resp.autonomous_database_peers[0].autonomous_database_arn #=> String
resp.autonomous_database_peers[0].ocid #=> String
resp.autonomous_database_peers[0].region #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :max_results (Integer) —

    The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output.

  • :next_token (String) —

    The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

  • :autonomous_database_id (required, String) —

    The unique identifier of the Autonomous Database whose peer databases you want to list.

Returns:

See Also:



3795
3796
3797
3798
 
# File 'gems/aws-sdk-odb/lib/aws-sdk-odb/client.rb', line 3795

def list_autonomous_database_peers(params = {}, options = {})
  req = build_request(:list_autonomous_database_peers, params)
  req.send_request(options)
end

#list_autonomous_database_versions(params = {}) ⇒ Types::ListAutonomousDatabaseVersionsOutput

Lists the available Oracle Database software versions for Autonomous Databases.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_autonomous_database_versions({
  max_results: 1,
  next_token: "ListAutonomousDatabaseVersionsInputNextTokenString",
  db_workload: "OLTP", # accepts OLTP, AJD, APEX, LH
})

Response structure


resp.next_token #=> String
resp.autonomous_database_versions #=> Array
resp.autonomous_database_versions[0].db_workload #=> String, one of "OLTP", "AJD", "APEX", "LH"
resp.autonomous_database_versions[0].details #=> String
resp.autonomous_database_versions[0].version #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :max_results (Integer) —

    The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output.

  • :next_token (String) —

    The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

  • :db_workload (String) —

    The intended use of the Autonomous Database to return versions for, such as transaction processing, data warehouse, JSON database, or APEX.

Returns:

See Also:



3844
3845
3846
3847
 
# File 'gems/aws-sdk-odb/lib/aws-sdk-odb/client.rb', line 3844

def list_autonomous_database_versions(params = {}, options = {})
  req = build_request(:list_autonomous_database_versions, params)
  req.send_request(options)
end

#list_autonomous_databases(params = {}) ⇒ Types::ListAutonomousDatabasesOutput

Returns information about the Autonomous Databases owned by your Amazon Web Services account in the current Amazon Web Services Region.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_autonomous_databases({
  max_results: 1,
  next_token: "ListAutonomousDatabasesInputNextTokenString",
})

Response structure


resp.next_token #=> String
resp.autonomous_databases #=> Array
resp.autonomous_databases[0].autonomous_database_id #=> String
resp.autonomous_databases[0].autonomous_database_arn #=> String
resp.autonomous_databases[0].oci_resource_anchor_name #=> String
resp.autonomous_databases[0].percent_progress #=> Float
resp.autonomous_databases[0].ocid #=> String
resp.autonomous_databases[0].oci_url #=> String
resp.autonomous_databases[0].display_name #=> String
resp.autonomous_databases[0].db_name #=> String
resp.autonomous_databases[0].source_id #=> String
resp.autonomous_databases[0].status #=> String, one of "AVAILABLE", "FAILED", "PROVISIONING", "TERMINATED", "TERMINATING", "UPDATING", "MAINTENANCE_IN_PROGRESS", "STOPPING", "STOPPED", "STARTING", "UNAVAILABLE", "RESTORE_IN_PROGRESS", "RESTORE_FAILED", "BACKUP_IN_PROGRESS", "SCALE_IN_PROGRESS", "AVAILABLE_NEEDS_ATTENTION", "RESTARTING", "RECREATING", "ROLE_CHANGE_IN_PROGRESS", "UPGRADING", "INACCESSIBLE", "STANDBY"
resp.autonomous_databases[0].status_reason #=> String
resp.autonomous_databases[0].database_type #=> String, one of "REGULAR", "CLONE"
resp.autonomous_databases[0].db_version #=> String
resp.autonomous_databases[0].db_workload #=> String, one of "OLTP", "AJD", "APEX", "LH"
resp.autonomous_databases[0].character_set #=> String
resp.autonomous_databases[0].ncharacter_set #=> String
resp.autonomous_databases[0].database_edition #=> String, one of "STANDARD_EDITION", "ENTERPRISE_EDITION"
resp.autonomous_databases[0].license_model #=> String, one of "BRING_YOUR_OWN_LICENSE", "LICENSE_INCLUDED"
resp.autonomous_databases[0].open_mode #=> String, one of "READ_ONLY", "READ_WRITE"
resp.autonomous_databases[0].permission_level #=> String, one of "RESTRICTED", "UNRESTRICTED"
resp.autonomous_databases[0].is_mtls_connection_required #=> Boolean
resp.autonomous_databases[0].autonomous_maintenance_schedule_type #=> String, one of "EARLY", "REGULAR"
resp.autonomous_databases[0].net_services_architecture #=> String, one of "DEDICATED", "SHARED"
resp.autonomous_databases[0].available_upgrade_versions #=> Array
resp.autonomous_databases[0].available_upgrade_versions[0] #=> String
resp.autonomous_databases[0].byol_compute_count_limit #=> Integer
resp.autonomous_databases[0].connection_string_details.all_connection_strings #=> Hash
resp.autonomous_databases[0].connection_string_details.all_connection_strings["String"] #=> String
resp.autonomous_databases[0].connection_string_details.dedicated #=> String
resp.autonomous_databases[0].connection_string_details.high #=> String
resp.autonomous_databases[0].connection_string_details.medium #=> String
resp.autonomous_databases[0].connection_string_details.low #=> String
resp.autonomous_databases[0].connection_string_details.profiles #=> Array
resp.autonomous_databases[0].connection_string_details.profiles[0].consumer_group #=> String
resp.autonomous_databases[0].connection_string_details.profiles[0].display_name #=> String
resp.autonomous_databases[0].connection_string_details.profiles[0].host_format #=> String
resp.autonomous_databases[0].connection_string_details.profiles[0].is_regional #=> Boolean
resp.autonomous_databases[0].connection_string_details.profiles[0].protocol #=> String
resp.autonomous_databases[0].connection_string_details.profiles[0].session_mode #=> String
resp.autonomous_databases[0].connection_string_details.profiles[0].syntax_format #=> String
resp.autonomous_databases[0].connection_string_details.profiles[0].tls_authentication #=> String
resp.autonomous_databases[0].connection_string_details.profiles[0].value #=> String
resp.autonomous_databases[0].service_console_url #=> String
resp.autonomous_databases[0].sql_web_developer_url #=> String
resp.autonomous_databases[0].customer_contacts #=> Array
resp.autonomous_databases[0].customer_contacts[0].email #=> String
resp.autonomous_databases[0].apex_details.apex_version #=> String
resp.autonomous_databases[0].apex_details.ords_version #=> String
resp.autonomous_databases[0].standby_db.availability_domain #=> String
resp.autonomous_databases[0].standby_db.lag_time_in_seconds #=> Integer
resp.autonomous_databases[0].standby_db.status #=> String, one of "AVAILABLE", "FAILED", "PROVISIONING", "TERMINATED", "TERMINATING", "UPDATING", "MAINTENANCE_IN_PROGRESS", "STOPPING", "STOPPED", "STARTING", "UNAVAILABLE", "RESTORE_IN_PROGRESS", "RESTORE_FAILED", "BACKUP_IN_PROGRESS", "SCALE_IN_PROGRESS", "AVAILABLE_NEEDS_ATTENTION", "RESTARTING", "RECREATING", "ROLE_CHANGE_IN_PROGRESS", "UPGRADING", "INACCESSIBLE", "STANDBY"
resp.autonomous_databases[0].standby_db.status_reason #=> String
resp.autonomous_databases[0].standby_db.maintenance_target_component #=> String
resp.autonomous_databases[0].standby_db.time_data_guard_role_changed #=> Time
resp.autonomous_databases[0].standby_db.time_disaster_recovery_role_changed #=> Time
resp.autonomous_databases[0].standby_db.time_maintenance_begin #=> Time
resp.autonomous_databases[0].standby_db.time_maintenance_end #=> Time
resp.autonomous_databases[0].local_standby_db.availability_domain #=> String
resp.autonomous_databases[0].local_standby_db.lag_time_in_seconds #=> Integer
resp.autonomous_databases[0].local_standby_db.status #=> String, one of "AVAILABLE", "FAILED", "PROVISIONING", "TERMINATED", "TERMINATING", "UPDATING", "MAINTENANCE_IN_PROGRESS", "STOPPING", "STOPPED", "STARTING", "UNAVAILABLE", "RESTORE_IN_PROGRESS", "RESTORE_FAILED", "BACKUP_IN_PROGRESS", "SCALE_IN_PROGRESS", "AVAILABLE_NEEDS_ATTENTION", "RESTARTING", "RECREATING", "ROLE_CHANGE_IN_PROGRESS", "UPGRADING", "INACCESSIBLE", "STANDBY"
resp.autonomous_databases[0].local_standby_db.status_reason #=> String
resp.autonomous_databases[0].local_standby_db.maintenance_target_component #=> String
resp.autonomous_databases[0].local_standby_db.time_data_guard_role_changed #=> Time
resp.autonomous_databases[0].local_standby_db.time_disaster_recovery_role_changed #=> Time
resp.autonomous_databases[0].local_standby_db.time_maintenance_begin #=> Time
resp.autonomous_databases[0].local_standby_db.time_maintenance_end #=> Time
resp.autonomous_databases[0].data_safe_status #=> String, one of "REGISTERING", "REGISTERED", "DEREGISTERING", "NOT_REGISTERED", "FAILED"
resp.autonomous_databases[0].database_management_status #=> String, one of "ENABLING", "ENABLED", "DISABLING", "NOT_ENABLED", "FAILED_ENABLING", "FAILED_DISABLING"
resp.autonomous_databases[0].operations_insights_status #=> String, one of "ENABLING", "ENABLED", "DISABLING", "NOT_ENABLED", "FAILED_ENABLING", "FAILED_DISABLING"
resp.autonomous_databases[0].availability_zone #=> String
resp.autonomous_databases[0].availability_zone_id #=> String
resp.autonomous_databases[0].maintenance_target_component #=> String
resp.autonomous_databases[0].connection_urls.apex_url #=> String
resp.autonomous_databases[0].connection_urls.database_transforms_url #=> String
resp.autonomous_databases[0].connection_urls.graph_studio_url #=> String
resp.autonomous_databases[0].connection_urls.machine_learning_notebook_url #=> String
resp.autonomous_databases[0].connection_urls.machine_learning_user_management_url #=> String
resp.autonomous_databases[0].connection_urls.mongo_db_url #=> String
resp.autonomous_databases[0].connection_urls.ords_url #=> String
resp.autonomous_databases[0].connection_urls.spatial_studio_url #=> String
resp.autonomous_databases[0].connection_urls.sql_dev_web_url #=> String
resp.autonomous_databases[0].db_tools_details #=> Array
resp.autonomous_databases[0].db_tools_details[0].is_enabled #=> Boolean
resp.autonomous_databases[0].db_tools_details[0].name #=> String
resp.autonomous_databases[0].db_tools_details[0].compute_count #=> Float
resp.autonomous_databases[0].db_tools_details[0].max_idle_time_in_minutes #=> Integer
resp.autonomous_databases[0].scheduled_operations #=> Array
resp.autonomous_databases[0].scheduled_operations[0].day_of_week.name #=> String, one of "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY"
resp.autonomous_databases[0].scheduled_operations[0].scheduled_start_time #=> String
resp.autonomous_databases[0].scheduled_operations[0].scheduled_stop_time #=> String
resp.autonomous_databases[0].resource_pool_leader_id #=> String
resp.autonomous_databases[0].compute_count #=> Float
resp.autonomous_databases[0].compute_model #=> String, one of "ECPU", "OCPU"
resp.autonomous_databases[0].cpu_core_count #=> Integer
resp.autonomous_databases[0].memory_per_oracle_compute_unit_in_g_bs #=> Integer
resp.autonomous_databases[0].provisionable_cpus #=> Array
resp.autonomous_databases[0].provisionable_cpus[0] #=> Integer
resp.autonomous_databases[0].is_auto_scaling_enabled #=> Boolean
resp.autonomous_databases[0].data_storage_size_in_t_bs #=> Float
resp.autonomous_databases[0].data_storage_size_in_g_bs #=> Integer
resp.autonomous_databases[0].used_data_storage_size_in_t_bs #=> Float
resp.autonomous_databases[0].used_data_storage_size_in_g_bs #=> Integer
resp.autonomous_databases[0].actual_used_data_storage_size_in_t_bs #=> Float
resp.autonomous_databases[0].allocated_storage_size_in_t_bs #=> Float
resp.autonomous_databases[0].in_memory_area_in_g_bs #=> Integer
resp.autonomous_databases[0].is_auto_scaling_for_storage_enabled #=> Boolean
resp.autonomous_databases[0].odb_network_id #=> String
resp.autonomous_databases[0].odb_network_arn #=> String
resp.autonomous_databases[0].private_endpoint #=> String
resp.autonomous_databases[0].private_endpoint_ip #=> String
resp.autonomous_databases[0].private_endpoint_label #=> String
resp.autonomous_databases[0].allowlisted_ips #=> Array
resp.autonomous_databases[0].allowlisted_ips[0] #=> String
resp.autonomous_databases[0].standby_allowlisted_ips #=> Array
resp.autonomous_databases[0].standby_allowlisted_ips[0] #=> String
resp.autonomous_databases[0].standby_allowlisted_ips_source #=> String, one of "PRIMARY", "SEPARATE", "NOT_APPLICABLE"
resp.autonomous_databases[0].is_local_data_guard_enabled #=> Boolean
resp.autonomous_databases[0].is_remote_data_guard_enabled #=> Boolean
resp.autonomous_databases[0].local_disaster_recovery_type #=> String, one of "ADG", "BACKUP_BASED"
resp.autonomous_databases[0].role #=> String, one of "PRIMARY", "STANDBY", "DISABLED_STANDBY", "BACKUP_COPY", "SNAPSHOT_STANDBY"
resp.autonomous_databases[0].peer_db_ids #=> Array
resp.autonomous_databases[0].peer_db_ids[0] #=> String
resp.autonomous_databases[0].failed_data_recovery_in_seconds #=> Integer
resp.autonomous_databases[0].local_adg_auto_failover_max_data_loss_limit #=> Integer
resp.autonomous_databases[0].remote_disaster_recovery_configuration.disaster_recovery_type #=> String, one of "ADG", "BACKUP_BASED"
resp.autonomous_databases[0].remote_disaster_recovery_configuration.is_replicate_automatic_backups #=> Boolean
resp.autonomous_databases[0].remote_disaster_recovery_configuration.is_snapshot_standby #=> Boolean
resp.autonomous_databases[0].remote_disaster_recovery_configuration.time_snapshot_standby_enabled_till #=> Time
resp.autonomous_databases[0].is_refreshable_clone #=> Boolean
resp.autonomous_databases[0].refreshable_mode #=> String, one of "AUTOMATIC", "MANUAL"
resp.autonomous_databases[0].refreshable_status #=> String, one of "REFRESHING", "NOT_REFRESHING"
resp.autonomous_databases[0].auto_refresh_frequency_in_seconds #=> Integer
resp.autonomous_databases[0].auto_refresh_point_lag_in_seconds #=> Integer
resp.autonomous_databases[0].is_reconnect_clone_enabled #=> Boolean
resp.autonomous_databases[0].clone_table_space_list #=> Array
resp.autonomous_databases[0].clone_table_space_list[0] #=> Integer
resp.autonomous_databases[0].backup_retention_period_in_days #=> Integer
resp.autonomous_databases[0].long_term_backup_schedule.is_disabled #=> Boolean
resp.autonomous_databases[0].long_term_backup_schedule.repeat_cadence #=> String, one of "ONE_TIME", "WEEKLY", "MONTHLY", "YEARLY"
resp.autonomous_databases[0].long_term_backup_schedule.retention_period_in_days #=> Integer
resp.autonomous_databases[0].long_term_backup_schedule.time_of_backup #=> Time
resp.autonomous_databases[0].is_backup_retention_locked #=> Boolean
resp.autonomous_databases[0].total_backup_storage_size_in_g_bs #=> Float
resp.autonomous_databases[0].resource_pool_summary.is_disabled #=> Boolean
resp.autonomous_databases[0].resource_pool_summary.pool_size #=> Integer
resp.autonomous_databases[0].resource_pool_summary.pool_storage_size_in_t_bs #=> Integer
resp.autonomous_databases[0].resource_pool_summary.available_storage_capacity_in_t_bs #=> Float
resp.autonomous_databases[0].resource_pool_summary.total_compute_capacity #=> Integer
resp.autonomous_databases[0].resource_pool_summary.available_compute_capacity #=> Integer
resp.autonomous_databases[0].encryption_summary.encryption_key_provider #=> String, one of "ORACLE_MANAGED", "AWS_KMS", "OKV", "OCI"
resp.autonomous_databases[0].encryption_summary.encryption_key_configuration.aws_encryption_key.iam_role_arn #=> String
resp.autonomous_databases[0].encryption_summary.encryption_key_configuration.aws_encryption_key.external_id_type #=> String, one of "database_ocid", "compartment_ocid", "tenant_ocid"
resp.autonomous_databases[0].encryption_summary.encryption_key_configuration.aws_encryption_key.kms_key_id #=> String
resp.autonomous_databases[0].encryption_summary.encryption_key_configuration.oci_encryption_key.kms_key_id #=> String
resp.autonomous_databases[0].encryption_summary.encryption_key_configuration.oci_encryption_key.vault_id #=> String
resp.autonomous_databases[0].encryption_summary.encryption_key_configuration.okv_encryption_key.certificate_directory_name #=> String
resp.autonomous_databases[0].encryption_summary.encryption_key_configuration.okv_encryption_key.certificate_id #=> String
resp.autonomous_databases[0].encryption_summary.encryption_key_configuration.okv_encryption_key.directory_name #=> String
resp.autonomous_databases[0].encryption_summary.encryption_key_configuration.okv_encryption_key.okv_kms_key #=> String
resp.autonomous_databases[0].encryption_summary.encryption_key_configuration.okv_encryption_key.okv_uri #=> String
resp.autonomous_databases[0].created_at #=> Time
resp.autonomous_databases[0].time_of_last_backup #=> Time
resp.autonomous_databases[0].time_maintenance_begin #=> Time
resp.autonomous_databases[0].time_maintenance_end #=> Time
resp.autonomous_databases[0].time_local_data_guard_enabled #=> Time
resp.autonomous_databases[0].time_data_guard_role_changed #=> Time
resp.autonomous_databases[0].time_of_last_switchover #=> Time
resp.autonomous_databases[0].time_of_last_failover #=> Time
resp.autonomous_databases[0].time_of_last_refresh #=> Time
resp.autonomous_databases[0].time_of_last_refresh_point #=> Time
resp.autonomous_databases[0].time_of_next_refresh #=> Time
resp.autonomous_databases[0].time_of_auto_refresh_start #=> Time
resp.autonomous_databases[0].time_deletion_of_free_autonomous_database #=> Time
resp.autonomous_databases[0].time_reclamation_of_free_autonomous_database #=> Time
resp.autonomous_databases[0].time_disaster_recovery_role_changed #=> Time
resp.autonomous_databases[0].time_until_reconnect_clone_enabled #=> Time
resp.autonomous_databases[0].next_long_term_backup_time_stamp #=> Time
resp.autonomous_databases[0].time_undeleted #=> Time
resp.autonomous_databases[0].admin_password_source_summary.admin_password_source #=> String, one of "CUSTOMER_MANAGED_AWS_SECRET", "API_REQUEST_PARAMETER"
resp.autonomous_databases[0].admin_password_source_summary.admin_password_source_configuration.customer_managed_aws_secret.iam_role_arn #=> String
resp.autonomous_databases[0].admin_password_source_summary.admin_password_source_configuration.customer_managed_aws_secret.secret_id #=> String
resp.autonomous_databases[0].admin_password_source_summary.admin_password_source_configuration.customer_managed_aws_secret.external_id_type #=> String, one of "database_ocid", "compartment_ocid", "tenant_ocid"

Parameters:

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

    ({})

Options Hash (params):

  • :max_results (Integer) —

    The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output.

  • :next_token (String) —

    The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

Returns:

See Also:



4066
4067
4068
4069
 
# File 'gems/aws-sdk-odb/lib/aws-sdk-odb/client.rb', line 4066

def list_autonomous_databases(params = {}, options = {})
  req = build_request(:list_autonomous_databases, params)
  req.send_request(options)
end

#list_autonomous_virtual_machines(params = {}) ⇒ Types::ListAutonomousVirtualMachinesOutput

Lists all Autonomous VMs in an Autonomous VM cluster.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_autonomous_virtual_machines({
  max_results: 1,
  next_token: "ListAutonomousVirtualMachinesInputNextTokenString",
  cloud_autonomous_vm_cluster_id: "ResourceId", # required
})

Response structure


resp.next_token #=> String
resp.autonomous_virtual_machines #=> Array
resp.autonomous_virtual_machines[0].autonomous_virtual_machine_id #=> String
resp.autonomous_virtual_machines[0].status #=> String, one of "AVAILABLE", "FAILED", "PROVISIONING", "TERMINATED", "TERMINATING", "UPDATING", "MAINTENANCE_IN_PROGRESS"
resp.autonomous_virtual_machines[0].status_reason #=> String
resp.autonomous_virtual_machines[0].vm_name #=> String
resp.autonomous_virtual_machines[0].db_server_id #=> String
resp.autonomous_virtual_machines[0].db_server_display_name #=> String
resp.autonomous_virtual_machines[0].cpu_core_count #=> Integer
resp.autonomous_virtual_machines[0].memory_size_in_g_bs #=> Integer
resp.autonomous_virtual_machines[0].db_node_storage_size_in_g_bs #=> Integer
resp.autonomous_virtual_machines[0].client_ip_address #=> String
resp.autonomous_virtual_machines[0].cloud_autonomous_vm_cluster_id #=> String
resp.autonomous_virtual_machines[0].ocid #=> String
resp.autonomous_virtual_machines[0].oci_resource_anchor_name #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :max_results (Integer) —

    The maximum number of items to return per page.

  • :next_token (String) —

    The pagination token to continue listing from.

  • :cloud_autonomous_vm_cluster_id (required, String) —

    The unique identifier of the Autonomous VM cluster whose virtual machines you're listing.

Returns:

See Also:



4120
4121
4122
4123
 
# File 'gems/aws-sdk-odb/lib/aws-sdk-odb/client.rb', line 4120

def list_autonomous_virtual_machines(params = {}, options = {})
  req = build_request(:list_autonomous_virtual_machines, params)
  req.send_request(options)
end

#list_cloud_autonomous_vm_clusters(params = {}) ⇒ Types::ListCloudAutonomousVmClustersOutput

Lists all Autonomous VM clusters in a specified Cloud Exadata infrastructure.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_cloud_autonomous_vm_clusters({
  max_results: 1,
  next_token: "ListCloudAutonomousVmClustersInputNextTokenString",
  cloud_exadata_infrastructure_id: "ResourceIdOrArn",
})

Response structure


resp.next_token #=> String
resp.cloud_autonomous_vm_clusters #=> Array
resp.cloud_autonomous_vm_clusters[0].cloud_autonomous_vm_cluster_id #=> String
resp.cloud_autonomous_vm_clusters[0].cloud_autonomous_vm_cluster_arn #=> String
resp.cloud_autonomous_vm_clusters[0].odb_network_id #=> String
resp.cloud_autonomous_vm_clusters[0].odb_network_arn #=> String
resp.cloud_autonomous_vm_clusters[0].oci_resource_anchor_name #=> String
resp.cloud_autonomous_vm_clusters[0].percent_progress #=> Float
resp.cloud_autonomous_vm_clusters[0].display_name #=> String
resp.cloud_autonomous_vm_clusters[0].status #=> String, one of "AVAILABLE", "FAILED", "PROVISIONING", "TERMINATED", "TERMINATING", "UPDATING", "MAINTENANCE_IN_PROGRESS"
resp.cloud_autonomous_vm_clusters[0].status_reason #=> String
resp.cloud_autonomous_vm_clusters[0].cloud_exadata_infrastructure_id #=> String
resp.cloud_autonomous_vm_clusters[0].cloud_exadata_infrastructure_arn #=> String
resp.cloud_autonomous_vm_clusters[0].autonomous_data_storage_percentage #=> Float
resp.cloud_autonomous_vm_clusters[0].autonomous_data_storage_size_in_t_bs #=> Float
resp.cloud_autonomous_vm_clusters[0].available_autonomous_data_storage_size_in_t_bs #=> Float
resp.cloud_autonomous_vm_clusters[0].available_container_databases #=> Integer
resp.cloud_autonomous_vm_clusters[0].available_cpus #=> Float
resp.cloud_autonomous_vm_clusters[0].compute_model #=> String, one of "ECPU", "OCPU"
resp.cloud_autonomous_vm_clusters[0].cpu_core_count #=> Integer
resp.cloud_autonomous_vm_clusters[0].cpu_core_count_per_node #=> Integer
resp.cloud_autonomous_vm_clusters[0].cpu_percentage #=> Float
resp.cloud_autonomous_vm_clusters[0].data_storage_size_in_g_bs #=> Float
resp.cloud_autonomous_vm_clusters[0].data_storage_size_in_t_bs #=> Float
resp.cloud_autonomous_vm_clusters[0].db_node_storage_size_in_g_bs #=> Integer
resp.cloud_autonomous_vm_clusters[0].db_servers #=> Array
resp.cloud_autonomous_vm_clusters[0].db_servers[0] #=> String
resp.cloud_autonomous_vm_clusters[0].description #=> String
resp.cloud_autonomous_vm_clusters[0].domain #=> String
resp.cloud_autonomous_vm_clusters[0].exadata_storage_in_t_bs_lowest_scaled_value #=> Float
resp.cloud_autonomous_vm_clusters[0].hostname #=> String
resp.cloud_autonomous_vm_clusters[0].ocid #=> String
resp.cloud_autonomous_vm_clusters[0].oci_url #=> String
resp.cloud_autonomous_vm_clusters[0].is_mtls_enabled_vm_cluster #=> Boolean
resp.cloud_autonomous_vm_clusters[0].license_model #=> String, one of "BRING_YOUR_OWN_LICENSE", "LICENSE_INCLUDED"
resp.cloud_autonomous_vm_clusters[0].maintenance_window.custom_action_timeout_in_mins #=> Integer
resp.cloud_autonomous_vm_clusters[0].maintenance_window.days_of_week #=> Array
resp.cloud_autonomous_vm_clusters[0].maintenance_window.days_of_week[0].name #=> String, one of "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY"
resp.cloud_autonomous_vm_clusters[0].maintenance_window.hours_of_day #=> Array
resp.cloud_autonomous_vm_clusters[0].maintenance_window.hours_of_day[0] #=> Integer
resp.cloud_autonomous_vm_clusters[0].maintenance_window.is_custom_action_timeout_enabled #=> Boolean
resp.cloud_autonomous_vm_clusters[0].maintenance_window.lead_time_in_weeks #=> Integer
resp.cloud_autonomous_vm_clusters[0].maintenance_window.months #=> Array
resp.cloud_autonomous_vm_clusters[0].maintenance_window.months[0].name #=> String, one of "JANUARY", "FEBRUARY", "MARCH", "APRIL", "MAY", "JUNE", "JULY", "AUGUST", "SEPTEMBER", "OCTOBER", "NOVEMBER", "DECEMBER"
resp.cloud_autonomous_vm_clusters[0].maintenance_window.patching_mode #=> String, one of "ROLLING", "NONROLLING"
resp.cloud_autonomous_vm_clusters[0].maintenance_window.preference #=> String, one of "NO_PREFERENCE", "CUSTOM_PREFERENCE"
resp.cloud_autonomous_vm_clusters[0].maintenance_window.skip_ru #=> Boolean
resp.cloud_autonomous_vm_clusters[0].maintenance_window.weeks_of_month #=> Array
resp.cloud_autonomous_vm_clusters[0].maintenance_window.weeks_of_month[0] #=> Integer
resp.cloud_autonomous_vm_clusters[0].max_acds_lowest_scaled_value #=> Integer
resp.cloud_autonomous_vm_clusters[0].memory_per_oracle_compute_unit_in_g_bs #=> Integer
resp.cloud_autonomous_vm_clusters[0].memory_size_in_g_bs #=> Integer
resp.cloud_autonomous_vm_clusters[0].node_count #=> Integer
resp.cloud_autonomous_vm_clusters[0].non_provisionable_autonomous_container_databases #=> Integer
resp.cloud_autonomous_vm_clusters[0].ocpus_lowest_scaled_value #=> Integer
resp.cloud_autonomous_vm_clusters[0].provisionable_autonomous_container_databases #=> Integer
resp.cloud_autonomous_vm_clusters[0].provisioned_autonomous_container_databases #=> Integer
resp.cloud_autonomous_vm_clusters[0].provisioned_cpus #=> Float
resp.cloud_autonomous_vm_clusters[0].reclaimable_cpus #=> Float
resp.cloud_autonomous_vm_clusters[0].reserved_cpus #=> Float
resp.cloud_autonomous_vm_clusters[0].scan_listener_port_non_tls #=> Integer
resp.cloud_autonomous_vm_clusters[0].scan_listener_port_tls #=> Integer
resp.cloud_autonomous_vm_clusters[0].shape #=> String
resp.cloud_autonomous_vm_clusters[0].created_at #=> Time
resp.cloud_autonomous_vm_clusters[0].time_database_ssl_certificate_expires #=> Time
resp.cloud_autonomous_vm_clusters[0].time_ords_certificate_expires #=> Time
resp.cloud_autonomous_vm_clusters[0].time_zone #=> String
resp.cloud_autonomous_vm_clusters[0].total_container_databases #=> Integer
resp.cloud_autonomous_vm_clusters[0].iam_roles #=> Array
resp.cloud_autonomous_vm_clusters[0].iam_roles[0].iam_role_arn #=> String
resp.cloud_autonomous_vm_clusters[0].iam_roles[0].status #=> String, one of "ASSOCIATING", "DISASSOCIATING", "FAILED", "CONNECTED", "DISCONNECTED", "PARTIALLY_CONNECTED", "UNKNOWN"
resp.cloud_autonomous_vm_clusters[0].iam_roles[0].status_reason #=> String
resp.cloud_autonomous_vm_clusters[0].iam_roles[0].aws_integration #=> String, one of "KmsTde"

Parameters:

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

    ({})

Options Hash (params):

  • :max_results (Integer) —

    The maximum number of items to return per page.

  • :next_token (String) —

    The pagination token to continue listing from.

  • :cloud_exadata_infrastructure_id (String) —

    The unique identifier of the Cloud Exadata Infrastructure that hosts the Autonomous VM clusters to be listed.

Returns:

See Also:



4233
4234
4235
4236
 
# File 'gems/aws-sdk-odb/lib/aws-sdk-odb/client.rb', line 4233

def list_cloud_autonomous_vm_clusters(params = {}, options = {})
  req = build_request(:list_cloud_autonomous_vm_clusters, params)
  req.send_request(options)
end

#list_cloud_exadata_infrastructures(params = {}) ⇒ Types::ListCloudExadataInfrastructuresOutput

Returns information about the Exadata infrastructures owned by your Amazon Web Services account.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_cloud_exadata_infrastructures({
  max_results: 1,
  next_token: "ListCloudExadataInfrastructuresInputNextTokenString",
})

Response structure


resp.next_token #=> String
resp.cloud_exadata_infrastructures #=> Array
resp.cloud_exadata_infrastructures[0].cloud_exadata_infrastructure_id #=> String
resp.cloud_exadata_infrastructures[0].display_name #=> String
resp.cloud_exadata_infrastructures[0].status #=> String, one of "AVAILABLE", "FAILED", "PROVISIONING", "TERMINATED", "TERMINATING", "UPDATING", "MAINTENANCE_IN_PROGRESS"
resp.cloud_exadata_infrastructures[0].status_reason #=> String
resp.cloud_exadata_infrastructures[0].cloud_exadata_infrastructure_arn #=> String
resp.cloud_exadata_infrastructures[0].activated_storage_count #=> Integer
resp.cloud_exadata_infrastructures[0].additional_storage_count #=> Integer
resp.cloud_exadata_infrastructures[0].available_storage_size_in_g_bs #=> Integer
resp.cloud_exadata_infrastructures[0].availability_zone #=> String
resp.cloud_exadata_infrastructures[0].availability_zone_id #=> String
resp.cloud_exadata_infrastructures[0].compute_count #=> Integer
resp.cloud_exadata_infrastructures[0].cpu_count #=> Integer
resp.cloud_exadata_infrastructures[0].customer_contacts_to_send_to_oci #=> Array
resp.cloud_exadata_infrastructures[0].customer_contacts_to_send_to_oci[0].email #=> String
resp.cloud_exadata_infrastructures[0].data_storage_size_in_t_bs #=> Float
resp.cloud_exadata_infrastructures[0].db_node_storage_size_in_g_bs #=> Integer
resp.cloud_exadata_infrastructures[0].db_server_version #=> String
resp.cloud_exadata_infrastructures[0].last_maintenance_run_id #=> String
resp.cloud_exadata_infrastructures[0].maintenance_window.custom_action_timeout_in_mins #=> Integer
resp.cloud_exadata_infrastructures[0].maintenance_window.days_of_week #=> Array
resp.cloud_exadata_infrastructures[0].maintenance_window.days_of_week[0].name #=> String, one of "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY"
resp.cloud_exadata_infrastructures[0].maintenance_window.hours_of_day #=> Array
resp.cloud_exadata_infrastructures[0].maintenance_window.hours_of_day[0] #=> Integer
resp.cloud_exadata_infrastructures[0].maintenance_window.is_custom_action_timeout_enabled #=> Boolean
resp.cloud_exadata_infrastructures[0].maintenance_window.lead_time_in_weeks #=> Integer
resp.cloud_exadata_infrastructures[0].maintenance_window.months #=> Array
resp.cloud_exadata_infrastructures[0].maintenance_window.months[0].name #=> String, one of "JANUARY", "FEBRUARY", "MARCH", "APRIL", "MAY", "JUNE", "JULY", "AUGUST", "SEPTEMBER", "OCTOBER", "NOVEMBER", "DECEMBER"
resp.cloud_exadata_infrastructures[0].maintenance_window.patching_mode #=> String, one of "ROLLING", "NONROLLING"
resp.cloud_exadata_infrastructures[0].maintenance_window.preference #=> String, one of "NO_PREFERENCE", "CUSTOM_PREFERENCE"
resp.cloud_exadata_infrastructures[0].maintenance_window.skip_ru #=> Boolean
resp.cloud_exadata_infrastructures[0].maintenance_window.weeks_of_month #=> Array
resp.cloud_exadata_infrastructures[0].maintenance_window.weeks_of_month[0] #=> Integer
resp.cloud_exadata_infrastructures[0].max_cpu_count #=> Integer
resp.cloud_exadata_infrastructures[0].max_data_storage_in_t_bs #=> Float
resp.cloud_exadata_infrastructures[0].max_db_node_storage_size_in_g_bs #=> Integer
resp.cloud_exadata_infrastructures[0].max_memory_in_g_bs #=> Integer
resp.cloud_exadata_infrastructures[0].memory_size_in_g_bs #=> Integer
resp.cloud_exadata_infrastructures[0].monthly_db_server_version #=> String
resp.cloud_exadata_infrastructures[0].monthly_storage_server_version #=> String
resp.cloud_exadata_infrastructures[0].next_maintenance_run_id #=> String
resp.cloud_exadata_infrastructures[0].oci_resource_anchor_name #=> String
resp.cloud_exadata_infrastructures[0].oci_url #=> String
resp.cloud_exadata_infrastructures[0].ocid #=> String
resp.cloud_exadata_infrastructures[0].shape #=> String
resp.cloud_exadata_infrastructures[0].storage_count #=> Integer
resp.cloud_exadata_infrastructures[0].storage_server_version #=> String
resp.cloud_exadata_infrastructures[0].created_at #=> Time
resp.cloud_exadata_infrastructures[0].total_storage_size_in_g_bs #=> Integer
resp.cloud_exadata_infrastructures[0].percent_progress #=> Float
resp.cloud_exadata_infrastructures[0].database_server_type #=> String
resp.cloud_exadata_infrastructures[0].storage_server_type #=> String
resp.cloud_exadata_infrastructures[0].compute_model #=> String, one of "ECPU", "OCPU"
resp.cloud_exadata_infrastructures[0].exascale_configuration.total_storage_size_in_g_bs #=> Integer
resp.cloud_exadata_infrastructures[0].exascale_configuration.available_storage_size_in_g_bs #=> Integer
resp.cloud_exadata_infrastructures[0].exascale_configuration.total_vm_storage_size_in_g_bs #=> Integer
resp.cloud_exadata_infrastructures[0].exascale_configuration.available_vm_storage_size_in_g_bs #=> Integer

Parameters:

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

    ({})

Options Hash (params):

  • :max_results (Integer) —

    The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output.

    Default: 10

  • :next_token (String) —

    The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

Returns:

See Also:



4331
4332
4333
4334
 
# File 'gems/aws-sdk-odb/lib/aws-sdk-odb/client.rb', line 4331

def list_cloud_exadata_infrastructures(params = {}, options = {})
  req = build_request(:list_cloud_exadata_infrastructures, params)
  req.send_request(options)
end

#list_cloud_vm_clusters(params = {}) ⇒ Types::ListCloudVmClustersOutput

Returns information about the VM clusters owned by your Amazon Web Services account or only the ones on the specified Exadata infrastructure.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_cloud_vm_clusters({
  max_results: 1,
  next_token: "ListCloudVmClustersInputNextTokenString",
  cloud_exadata_infrastructure_id: "ResourceIdOrArn",
})

Response structure


resp.next_token #=> String
resp.cloud_vm_clusters #=> Array
resp.cloud_vm_clusters[0].cloud_vm_cluster_id #=> String
resp.cloud_vm_clusters[0].display_name #=> String
resp.cloud_vm_clusters[0].status #=> String, one of "AVAILABLE", "FAILED", "PROVISIONING", "TERMINATED", "TERMINATING", "UPDATING", "MAINTENANCE_IN_PROGRESS"
resp.cloud_vm_clusters[0].status_reason #=> String
resp.cloud_vm_clusters[0].cloud_vm_cluster_arn #=> String
resp.cloud_vm_clusters[0].cloud_exadata_infrastructure_id #=> String
resp.cloud_vm_clusters[0].cloud_exadata_infrastructure_arn #=> String
resp.cloud_vm_clusters[0].exascale_db_storage_vault_id #=> String
resp.cloud_vm_clusters[0].exascale_db_storage_vault_arn #=> String
resp.cloud_vm_clusters[0].storage_management_type #=> String, one of "ASM", "EXASCALE"
resp.cloud_vm_clusters[0].vm_file_system_storage_type #=> String, one of "LOCAL", "EXASCALE"
resp.cloud_vm_clusters[0].vm_backup_storage_type #=> String, one of "LOCAL", "EXASCALE"
resp.cloud_vm_clusters[0].file_system_configuration_details #=> Array
resp.cloud_vm_clusters[0].file_system_configuration_details[0].mount_point #=> String
resp.cloud_vm_clusters[0].file_system_configuration_details[0].file_system_size_in_g_bs #=> Integer
resp.cloud_vm_clusters[0].cluster_name #=> String
resp.cloud_vm_clusters[0].cpu_core_count #=> Integer
resp.cloud_vm_clusters[0].data_collection_options.is_diagnostics_events_enabled #=> Boolean
resp.cloud_vm_clusters[0].data_collection_options.is_health_monitoring_enabled #=> Boolean
resp.cloud_vm_clusters[0].data_collection_options.is_incident_logs_enabled #=> Boolean
resp.cloud_vm_clusters[0].data_storage_size_in_t_bs #=> Float
resp.cloud_vm_clusters[0].db_node_storage_size_in_g_bs #=> Integer
resp.cloud_vm_clusters[0].db_servers #=> Array
resp.cloud_vm_clusters[0].db_servers[0] #=> String
resp.cloud_vm_clusters[0].disk_redundancy #=> String, one of "HIGH", "NORMAL"
resp.cloud_vm_clusters[0].gi_version #=> String
resp.cloud_vm_clusters[0].hostname #=> String
resp.cloud_vm_clusters[0].iorm_config_cache.db_plans #=> Array
resp.cloud_vm_clusters[0].iorm_config_cache.db_plans[0].db_name #=> String
resp.cloud_vm_clusters[0].iorm_config_cache.db_plans[0].flash_cache_limit #=> String
resp.cloud_vm_clusters[0].iorm_config_cache.db_plans[0].share #=> Integer
resp.cloud_vm_clusters[0].iorm_config_cache.lifecycle_details #=> String
resp.cloud_vm_clusters[0].iorm_config_cache.lifecycle_state #=> String, one of "BOOTSTRAPPING", "DISABLED", "ENABLED", "FAILED", "UPDATING"
resp.cloud_vm_clusters[0].iorm_config_cache.objective #=> String, one of "AUTO", "BALANCED", "BASIC", "HIGH_THROUGHPUT", "LOW_LATENCY"
resp.cloud_vm_clusters[0].is_local_backup_enabled #=> Boolean
resp.cloud_vm_clusters[0].is_sparse_diskgroup_enabled #=> Boolean
resp.cloud_vm_clusters[0].last_update_history_entry_id #=> String
resp.cloud_vm_clusters[0].license_model #=> String, one of "BRING_YOUR_OWN_LICENSE", "LICENSE_INCLUDED"
resp.cloud_vm_clusters[0].listener_port #=> Integer
resp.cloud_vm_clusters[0].memory_size_in_g_bs #=> Integer
resp.cloud_vm_clusters[0].node_count #=> Integer
resp.cloud_vm_clusters[0].ocid #=> String
resp.cloud_vm_clusters[0].oci_resource_anchor_name #=> String
resp.cloud_vm_clusters[0].oci_url #=> String
resp.cloud_vm_clusters[0].domain #=> String
resp.cloud_vm_clusters[0].scan_dns_name #=> String
resp.cloud_vm_clusters[0].scan_dns_record_id #=> String
resp.cloud_vm_clusters[0].scan_ip_ids #=> Array
resp.cloud_vm_clusters[0].scan_ip_ids[0] #=> String
resp.cloud_vm_clusters[0].shape #=> String
resp.cloud_vm_clusters[0].ssh_public_keys #=> Array
resp.cloud_vm_clusters[0].ssh_public_keys[0] #=> String
resp.cloud_vm_clusters[0].storage_size_in_g_bs #=> Integer
resp.cloud_vm_clusters[0].system_version #=> String
resp.cloud_vm_clusters[0].created_at #=> Time
resp.cloud_vm_clusters[0].time_zone #=> String
resp.cloud_vm_clusters[0].vip_ids #=> Array
resp.cloud_vm_clusters[0].vip_ids[0] #=> String
resp.cloud_vm_clusters[0].odb_network_id #=> String
resp.cloud_vm_clusters[0].odb_network_arn #=> String
resp.cloud_vm_clusters[0].percent_progress #=> Float
resp.cloud_vm_clusters[0].compute_model #=> String, one of "ECPU", "OCPU"
resp.cloud_vm_clusters[0].iam_roles #=> Array
resp.cloud_vm_clusters[0].iam_roles[0].iam_role_arn #=> String
resp.cloud_vm_clusters[0].iam_roles[0].status #=> String, one of "ASSOCIATING", "DISASSOCIATING", "FAILED", "CONNECTED", "DISCONNECTED", "PARTIALLY_CONNECTED", "UNKNOWN"
resp.cloud_vm_clusters[0].iam_roles[0].status_reason #=> String
resp.cloud_vm_clusters[0].iam_roles[0].aws_integration #=> String, one of "KmsTde"

Parameters:

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

    ({})

Options Hash (params):

  • :max_results (Integer) —

    The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output.

    Default: 10

  • :next_token (String) —

    The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

  • :cloud_exadata_infrastructure_id (String) —

    The unique identifier of the Oracle Exadata infrastructure.

Returns:

See Also:



4445
4446
4447
4448
 
# File 'gems/aws-sdk-odb/lib/aws-sdk-odb/client.rb', line 4445

def list_cloud_vm_clusters(params = {}, options = {})
  req = build_request(:list_cloud_vm_clusters, params)
  req.send_request(options)
end

#list_db_nodes(params = {}) ⇒ Types::ListDbNodesOutput

Returns information about the DB nodes for the specified VM cluster.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_db_nodes({
  max_results: 1,
  next_token: "ListDbNodesInputNextTokenString",
  cloud_vm_cluster_id: "ResourceId",
  exadb_vm_cluster_id: "ResourceId",
})

Response structure


resp.next_token #=> String
resp.db_nodes #=> Array
resp.db_nodes[0].db_node_id #=> String
resp.db_nodes[0].db_node_arn #=> String
resp.db_nodes[0].status #=> String, one of "AVAILABLE", "FAILED", "PROVISIONING", "TERMINATED", "TERMINATING", "UPDATING", "STOPPING", "STOPPED", "STARTING"
resp.db_nodes[0].status_reason #=> String
resp.db_nodes[0].additional_details #=> String
resp.db_nodes[0].backup_ip_id #=> String
resp.db_nodes[0].backup_vnic_2_id #=> String
resp.db_nodes[0].backup_vnic_id #=> String
resp.db_nodes[0].cpu_core_count #=> Integer
resp.db_nodes[0].db_node_storage_size_in_g_bs #=> Integer
resp.db_nodes[0].db_server_id #=> String
resp.db_nodes[0].db_system_id #=> String
resp.db_nodes[0].fault_domain #=> String
resp.db_nodes[0].host_ip_id #=> String
resp.db_nodes[0].hostname #=> String
resp.db_nodes[0].ocid #=> String
resp.db_nodes[0].oci_resource_anchor_name #=> String
resp.db_nodes[0].maintenance_type #=> String, one of "VMDB_REBOOT_MIGRATION"
resp.db_nodes[0].memory_size_in_g_bs #=> Integer
resp.db_nodes[0].software_storage_size_in_gb #=> Integer
resp.db_nodes[0].created_at #=> Time
resp.db_nodes[0].time_maintenance_window_end #=> String
resp.db_nodes[0].time_maintenance_window_start #=> String
resp.db_nodes[0].total_cpu_core_count #=> Integer
resp.db_nodes[0].vnic2_id #=> String
resp.db_nodes[0].vnic_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :max_results (Integer) —

    The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output.

    Default: 10

  • :next_token (String) —

    The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

  • :cloud_vm_cluster_id (String) —

    The unique identifier of the VM cluster. You must specify either this parameter or exadbVmClusterId.

  • :exadb_vm_cluster_id (String) —

    The unique identifier of the Exascale VM cluster. You must specify either this parameter or cloudVmClusterId.

Returns:

See Also:



4522
4523
4524
4525
 
# File 'gems/aws-sdk-odb/lib/aws-sdk-odb/client.rb', line 4522

def list_db_nodes(params = {}, options = {})
  req = build_request(:list_db_nodes, params)
  req.send_request(options)
end

#list_db_servers(params = {}) ⇒ Types::ListDbServersOutput

Returns information about the database servers that belong to the specified Exadata infrastructure.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_db_servers({
  cloud_exadata_infrastructure_id: "ResourceIdOrArn", # required
  max_results: 1,
  next_token: "ListDbServersInputNextTokenString",
})

Response structure


resp.next_token #=> String
resp.db_servers #=> Array
resp.db_servers[0].db_server_id #=> String
resp.db_servers[0].status #=> String, one of "AVAILABLE", "FAILED", "PROVISIONING", "TERMINATED", "TERMINATING", "UPDATING", "MAINTENANCE_IN_PROGRESS"
resp.db_servers[0].status_reason #=> String
resp.db_servers[0].cpu_core_count #=> Integer
resp.db_servers[0].db_node_storage_size_in_g_bs #=> Integer
resp.db_servers[0].db_server_patching_details.estimated_patch_duration #=> Integer
resp.db_servers[0].db_server_patching_details.patching_status #=> String, one of "COMPLETE", "FAILED", "MAINTENANCE_IN_PROGRESS", "SCHEDULED"
resp.db_servers[0].db_server_patching_details.time_patching_ended #=> String
resp.db_servers[0].db_server_patching_details.time_patching_started #=> String
resp.db_servers[0].display_name #=> String
resp.db_servers[0].exadata_infrastructure_id #=> String
resp.db_servers[0].ocid #=> String
resp.db_servers[0].oci_resource_anchor_name #=> String
resp.db_servers[0].max_cpu_count #=> Integer
resp.db_servers[0].max_db_node_storage_in_g_bs #=> Integer
resp.db_servers[0].max_memory_in_g_bs #=> Integer
resp.db_servers[0].memory_size_in_g_bs #=> Integer
resp.db_servers[0].shape #=> String
resp.db_servers[0].created_at #=> Time
resp.db_servers[0].vm_cluster_ids #=> Array
resp.db_servers[0].vm_cluster_ids[0] #=> String
resp.db_servers[0].compute_model #=> String, one of "ECPU", "OCPU"
resp.db_servers[0].autonomous_vm_cluster_ids #=> Array
resp.db_servers[0].autonomous_vm_cluster_ids[0] #=> String
resp.db_servers[0].autonomous_virtual_machine_ids #=> Array
resp.db_servers[0].autonomous_virtual_machine_ids[0] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :cloud_exadata_infrastructure_id (required, String) —

    The unique identifier of the Oracle Exadata infrastructure.

  • :max_results (Integer) —

    The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output.

    Default: 10

  • :next_token (String) —

    The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

Returns:

See Also:



4594
4595
4596
4597
 
# File 'gems/aws-sdk-odb/lib/aws-sdk-odb/client.rb', line 4594

def list_db_servers(params = {}, options = {})
  req = build_request(:list_db_servers, params)
  req.send_request(options)
end

#list_db_system_shapes(params = {}) ⇒ Types::ListDbSystemShapesOutput

Returns information about the shapes that are available for an Exadata infrastructure.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_db_system_shapes({
  max_results: 1,
  next_token: "ListDbSystemShapesInputNextTokenString",
  availability_zone: "ListDbSystemShapesInputAvailabilityZoneString",
  availability_zone_id: "ListDbSystemShapesInputAvailabilityZoneIdString",
  shape_family: "ListDbSystemShapesInputShapeFamilyString",
})

Response structure


resp.next_token #=> String
resp.db_system_shapes #=> Array
resp.db_system_shapes[0].available_core_count #=> Integer
resp.db_system_shapes[0].available_core_count_per_node #=> Integer
resp.db_system_shapes[0].available_data_storage_in_t_bs #=> Integer
resp.db_system_shapes[0].available_data_storage_per_server_in_t_bs #=> Integer
resp.db_system_shapes[0].available_db_node_per_node_in_g_bs #=> Integer
resp.db_system_shapes[0].available_db_node_storage_in_g_bs #=> Integer
resp.db_system_shapes[0].available_memory_in_g_bs #=> Integer
resp.db_system_shapes[0].available_memory_per_node_in_g_bs #=> Integer
resp.db_system_shapes[0].core_count_increment #=> Integer
resp.db_system_shapes[0].max_storage_count #=> Integer
resp.db_system_shapes[0].maximum_node_count #=> Integer
resp.db_system_shapes[0].min_core_count_per_node #=> Integer
resp.db_system_shapes[0].min_data_storage_in_t_bs #=> Integer
resp.db_system_shapes[0].min_db_node_storage_per_node_in_g_bs #=> Integer
resp.db_system_shapes[0].min_memory_per_node_in_g_bs #=> Integer
resp.db_system_shapes[0].min_storage_count #=> Integer
resp.db_system_shapes[0].minimum_core_count #=> Integer
resp.db_system_shapes[0].minimum_node_count #=> Integer
resp.db_system_shapes[0].runtime_minimum_core_count #=> Integer
resp.db_system_shapes[0].shape_family #=> String
resp.db_system_shapes[0].shape_type #=> String, one of "AMD", "INTEL", "INTEL_FLEX_X9", "AMPERE_FLEX_A1"
resp.db_system_shapes[0].shape_attributes #=> Array
resp.db_system_shapes[0].shape_attributes[0] #=> String, one of "SMART_STORAGE", "BLOCK_STORAGE"
resp.db_system_shapes[0].name #=> String
resp.db_system_shapes[0].compute_model #=> String, one of "ECPU", "OCPU"
resp.db_system_shapes[0].are_server_types_supported #=> Boolean

Parameters:

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

    ({})

Options Hash (params):

  • :max_results (Integer) —

    The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output.

    Default: 10

  • :next_token (String) —

    The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

  • :availability_zone (String) —

    The logical name of the AZ, for example, us-east-1a. This name varies depending on the account.

  • :availability_zone_id (String) —

    The physical ID of the AZ, for example, use1-az4. This ID persists across accounts.

  • :shape_family (String) —

    The shape family to filter results by.

Returns:

See Also:



4676
4677
4678
4679
 
# File 'gems/aws-sdk-odb/lib/aws-sdk-odb/client.rb', line 4676

def list_db_system_shapes(params = {}, options = {})
  req = build_request(:list_db_system_shapes, params)
  req.send_request(options)
end

#list_exadb_vm_clusters(params = {}) ⇒ Types::ListExadbVmClustersOutput

Returns information about the Exascale VM clusters owned by your Amazon Web Services account.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_exadb_vm_clusters({
  exascale_db_storage_vault_id: "ResourceIdOrArn",
  max_results: 1,
  next_token: "ListExadbVmClustersInputNextTokenString",
})

Response structure


resp.next_token #=> String
resp.exadb_vm_clusters #=> Array
resp.exadb_vm_clusters[0].exadb_vm_cluster_id #=> String
resp.exadb_vm_clusters[0].cluster_name #=> String
resp.exadb_vm_clusters[0].created_at #=> Time
resp.exadb_vm_clusters[0].data_collection_options.is_diagnostics_events_enabled #=> Boolean
resp.exadb_vm_clusters[0].data_collection_options.is_health_monitoring_enabled #=> Boolean
resp.exadb_vm_clusters[0].data_collection_options.is_incident_logs_enabled #=> Boolean
resp.exadb_vm_clusters[0].display_name #=> String
resp.exadb_vm_clusters[0].domain #=> String
resp.exadb_vm_clusters[0].enabled_ecpu_count #=> Integer
resp.exadb_vm_clusters[0].exadb_vm_cluster_arn #=> String
resp.exadb_vm_clusters[0].exascale_db_storage_vault_arn #=> String
resp.exadb_vm_clusters[0].exascale_db_storage_vault_id #=> String
resp.exadb_vm_clusters[0].gi_version #=> String
resp.exadb_vm_clusters[0].grid_image_id #=> String
resp.exadb_vm_clusters[0].grid_image_type #=> String, one of "RELEASE_UPDATE", "CUSTOM_IMAGE"
resp.exadb_vm_clusters[0].hostname #=> String
resp.exadb_vm_clusters[0].iam_roles #=> Array
resp.exadb_vm_clusters[0].iam_roles[0].iam_role_arn #=> String
resp.exadb_vm_clusters[0].iam_roles[0].status #=> String, one of "ASSOCIATING", "DISASSOCIATING", "FAILED", "CONNECTED", "DISCONNECTED", "PARTIALLY_CONNECTED", "UNKNOWN"
resp.exadb_vm_clusters[0].iam_roles[0].status_reason #=> String
resp.exadb_vm_clusters[0].iam_roles[0].aws_integration #=> String, one of "KmsTde"
resp.exadb_vm_clusters[0].iorm_config_cache.db_plans #=> Array
resp.exadb_vm_clusters[0].iorm_config_cache.db_plans[0].db_name #=> String
resp.exadb_vm_clusters[0].iorm_config_cache.db_plans[0].flash_cache_limit #=> String
resp.exadb_vm_clusters[0].iorm_config_cache.db_plans[0].share #=> Integer
resp.exadb_vm_clusters[0].iorm_config_cache.lifecycle_details #=> String
resp.exadb_vm_clusters[0].iorm_config_cache.lifecycle_state #=> String, one of "BOOTSTRAPPING", "DISABLED", "ENABLED", "FAILED", "UPDATING"
resp.exadb_vm_clusters[0].iorm_config_cache.objective #=> String, one of "AUTO", "BALANCED", "BASIC", "HIGH_THROUGHPUT", "LOW_LATENCY"
resp.exadb_vm_clusters[0].last_update_history_entry_id #=> String
resp.exadb_vm_clusters[0].license_model #=> String, one of "BRING_YOUR_OWN_LICENSE", "LICENSE_INCLUDED"
resp.exadb_vm_clusters[0].listener_port #=> Integer
resp.exadb_vm_clusters[0].memory_size_in_g_bs #=> Integer
resp.exadb_vm_clusters[0].node_count #=> Integer
resp.exadb_vm_clusters[0].ocid #=> String
resp.exadb_vm_clusters[0].oci_resource_anchor_name #=> String
resp.exadb_vm_clusters[0].oci_url #=> String
resp.exadb_vm_clusters[0].odb_network_arn #=> String
resp.exadb_vm_clusters[0].odb_network_id #=> String
resp.exadb_vm_clusters[0].percent_progress #=> Float
resp.exadb_vm_clusters[0].scan_dns_name #=> String
resp.exadb_vm_clusters[0].scan_dns_record_id #=> String
resp.exadb_vm_clusters[0].scan_ip_ids #=> Array
resp.exadb_vm_clusters[0].scan_ip_ids[0] #=> String
resp.exadb_vm_clusters[0].scan_listener_port_tcp #=> Integer
resp.exadb_vm_clusters[0].scan_listener_port_tcp_ssl #=> Integer
resp.exadb_vm_clusters[0].shape #=> String
resp.exadb_vm_clusters[0].shape_attribute #=> String, one of "SMART_STORAGE", "BLOCK_STORAGE"
resp.exadb_vm_clusters[0].snapshot_file_system_storage.total_size_in_g_bs #=> Integer
resp.exadb_vm_clusters[0].ssh_public_keys #=> Array
resp.exadb_vm_clusters[0].ssh_public_keys[0] #=> String
resp.exadb_vm_clusters[0].status #=> String, one of "AVAILABLE", "FAILED", "PROVISIONING", "TERMINATED", "TERMINATING", "UPDATING", "MAINTENANCE_IN_PROGRESS"
resp.exadb_vm_clusters[0].status_reason #=> String
resp.exadb_vm_clusters[0].system_version #=> String
resp.exadb_vm_clusters[0].time_zone #=> String
resp.exadb_vm_clusters[0].total_ecpu_count #=> Integer
resp.exadb_vm_clusters[0].total_file_system_storage.total_size_in_g_bs #=> Integer
resp.exadb_vm_clusters[0].vip_ids #=> Array
resp.exadb_vm_clusters[0].vip_ids[0] #=> String
resp.exadb_vm_clusters[0].vm_file_system_storage.total_size_in_g_bs #=> Integer

Parameters:

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

    ({})

Options Hash (params):

  • :exascale_db_storage_vault_id (String) —

    The unique identifier of the Exascale storage vault to list the associated Exascale VM clusters.

  • :max_results (Integer) —

    The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output.

  • :next_token (String) —

    The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

Returns:

See Also:



4780
4781
4782
4783
 
# File 'gems/aws-sdk-odb/lib/aws-sdk-odb/client.rb', line 4780

def list_exadb_vm_clusters(params = {}, options = {})
  req = build_request(:list_exadb_vm_clusters, params)
  req.send_request(options)
end

#list_exascale_db_storage_vaults(params = {}) ⇒ Types::ListExascaleDbStorageVaultsOutput

Returns information about the Exascale storage vaults owned by your Amazon Web Services account.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_exascale_db_storage_vaults({
  max_results: 1,
  next_token: "ListExascaleDbStorageVaultsInputNextTokenString",
  cloud_exadata_infrastructure_id: "ResourceIdOrArn",
  vault_type: "EXASCALE_INFRASTRUCTURE", # accepts EXASCALE_INFRASTRUCTURE, DEDICATED_INFRASTRUCTURE
})

Response structure


resp.next_token #=> String
resp.exascale_db_storage_vaults #=> Array
resp.exascale_db_storage_vaults[0].exascale_db_storage_vault_id #=> String
resp.exascale_db_storage_vaults[0].additional_flash_cache_in_percent #=> Integer
resp.exascale_db_storage_vaults[0].attached_shape_attributes #=> Array
resp.exascale_db_storage_vaults[0].attached_shape_attributes[0] #=> String, one of "SMART_STORAGE", "BLOCK_STORAGE"
resp.exascale_db_storage_vaults[0].autoscale_limit_in_g_bs #=> Integer
resp.exascale_db_storage_vaults[0].availability_zone #=> String
resp.exascale_db_storage_vaults[0].availability_zone_id #=> String
resp.exascale_db_storage_vaults[0].cloud_exadata_infrastructure_arn #=> String
resp.exascale_db_storage_vaults[0].cloud_exadata_infrastructure_id #=> String
resp.exascale_db_storage_vaults[0].created_at #=> Time
resp.exascale_db_storage_vaults[0].description #=> String
resp.exascale_db_storage_vaults[0].display_name #=> String
resp.exascale_db_storage_vaults[0].vm_cluster_arns #=> Array
resp.exascale_db_storage_vaults[0].vm_cluster_arns[0] #=> String
resp.exascale_db_storage_vaults[0].vm_cluster_count #=> Integer
resp.exascale_db_storage_vaults[0].vm_cluster_ids #=> Array
resp.exascale_db_storage_vaults[0].vm_cluster_ids[0] #=> String
resp.exascale_db_storage_vaults[0].exascale_db_storage_vault_arn #=> String
resp.exascale_db_storage_vaults[0].high_capacity_database_storage.available_size_in_g_bs #=> Integer
resp.exascale_db_storage_vaults[0].high_capacity_database_storage.total_size_in_g_bs #=> Integer
resp.exascale_db_storage_vaults[0].is_autoscale_enabled #=> Boolean
resp.exascale_db_storage_vaults[0].ocid #=> String
resp.exascale_db_storage_vaults[0].oci_resource_anchor_name #=> String
resp.exascale_db_storage_vaults[0].oci_url #=> String
resp.exascale_db_storage_vaults[0].percent_progress #=> Float
resp.exascale_db_storage_vaults[0].status #=> String, one of "AVAILABLE", "FAILED", "PROVISIONING", "TERMINATED", "TERMINATING", "UPDATING", "MAINTENANCE_IN_PROGRESS"
resp.exascale_db_storage_vaults[0].status_reason #=> String
resp.exascale_db_storage_vaults[0].time_zone #=> String
resp.exascale_db_storage_vaults[0].vault_type #=> String, one of "EXASCALE_INFRASTRUCTURE", "DEDICATED_INFRASTRUCTURE"

Parameters:

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

    ({})

Options Hash (params):

  • :max_results (Integer) —

    The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output.

  • :next_token (String) —

    The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

  • :cloud_exadata_infrastructure_id (String) —

    The unique identifier or Amazon Resource Name (ARN) of an Exadata infrastructure. If you specify this value, the operation returns only the Exascale storage vaults on that infrastructure that you own or that are shared with you. The infrastructure can be one that's shared with you through Amazon Web Services Resource Access Manager (Amazon Web Services RAM). You can't combine this filter with a vaultType of EXASCALE_INFRASTRUCTURE.

  • :vault_type (String) —

    The type of Exascale storage vaults to return. Specify DEDICATED_INFRASTRUCTURE to return Exascale storage vaults on dedicated Exadata infrastructure, or EXASCALE_INFRASTRUCTURE to return Exascale storage vaults for Exascale VM clusters. If you don't specify a value, the operation returns both types. You can't combine EXASCALE_INFRASTRUCTURE with the cloudExadataInfrastructureId filter.

Returns:

See Also:



4869
4870
4871
4872
 
# File 'gems/aws-sdk-odb/lib/aws-sdk-odb/client.rb', line 4869

def list_exascale_db_storage_vaults(params = {}, options = {})
  req = build_request(:list_exascale_db_storage_vaults, params)
  req.send_request(options)
end

#list_flex_components(params = {}) ⇒ Types::ListFlexComponentsOutput

Returns information about the flex components that are available for an Exadata infrastructure.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_flex_components({
  max_results: 1,
  next_token: "ListFlexComponentsInputNextTokenString",
  shape: "ListFlexComponentsInputShapeString",
})

Response structure


resp.next_token #=> String
resp.flex_components #=> Array
resp.flex_components[0].available_core_count #=> Integer
resp.flex_components[0].available_db_storage_in_g_bs #=> Integer
resp.flex_components[0].available_local_storage_in_g_bs #=> Integer
resp.flex_components[0].available_memory_in_g_bs #=> Integer
resp.flex_components[0].compute_model #=> String, one of "ECPU", "OCPU"
resp.flex_components[0].description_summary #=> String
resp.flex_components[0].hardware_type #=> String, one of "COMPUTE", "CELL"
resp.flex_components[0].minimum_core_count #=> Integer
resp.flex_components[0].name #=> String
resp.flex_components[0].runtime_minimum_core_count #=> Integer
resp.flex_components[0].shape #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :max_results (Integer) —

    The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output.

  • :next_token (String) —

    The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

  • :shape (String) —

    The shape to return flex components for. For a list of valid shapes, use the ListDbSystemShapes operation.

Returns:

See Also:



4925
4926
4927
4928
 
# File 'gems/aws-sdk-odb/lib/aws-sdk-odb/client.rb', line 4925

def list_flex_components(params = {}, options = {})
  req = build_request(:list_flex_components, params)
  req.send_request(options)
end

#list_gi_minor_versions(params = {}) ⇒ Types::ListGiMinorVersionsOutput

Returns a list of the Oracle Grid Infrastructure (GI) minor versions for the specified major version.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_gi_minor_versions({
  gi_version: "ListGiMinorVersionsInputGiVersionString", # required
  max_results: 1,
  next_token: "ListGiMinorVersionsInputNextTokenString",
  shape_family: "ListGiMinorVersionsInputShapeFamilyString",
  availability_zone: "ListGiMinorVersionsInputAvailabilityZoneString",
  availability_zone_id: "ListGiMinorVersionsInputAvailabilityZoneIdString",
})

Response structure


resp.next_token #=> String
resp.gi_minor_versions #=> Array
resp.gi_minor_versions[0].version #=> String
resp.gi_minor_versions[0].grid_image_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :gi_version (required, String) —

    The Oracle Grid Infrastructure (GI) major version.

  • :max_results (Integer) —

    The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output.

  • :next_token (String) —

    The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

  • :shape_family (String) —

    The shape family for the GI minor version.

  • :availability_zone (String) —

    The Availability Zone to filter GI minor versions.

  • :availability_zone_id (String) —

    The Availability Zone ID to filter GI minor versions.

Returns:

See Also:



4983
4984
4985
4986
 
# File 'gems/aws-sdk-odb/lib/aws-sdk-odb/client.rb', line 4983

def list_gi_minor_versions(params = {}, options = {})
  req = build_request(:list_gi_minor_versions, params)
  req.send_request(options)
end

#list_gi_versions(params = {}) ⇒ Types::ListGiVersionsOutput

Returns information about Oracle Grid Infrastructure (GI) software versions that are available for a VM cluster for the specified shape.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_gi_versions({
  max_results: 1,
  next_token: "ListGiVersionsInputNextTokenString",
  shape: "ListGiVersionsInputShapeString",
})

Response structure


resp.next_token #=> String
resp.gi_versions #=> Array
resp.gi_versions[0].version #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :max_results (Integer) —

    The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output.

    Default: 10

  • :next_token (String) —

    The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

  • :shape (String) —

    The shape to return GI versions for. For a list of valid shapes, use the ListDbSystemShapes operation..

Returns:

See Also:



5031
5032
5033
5034
 
# File 'gems/aws-sdk-odb/lib/aws-sdk-odb/client.rb', line 5031

def list_gi_versions(params = {}, options = {})
  req = build_request(:list_gi_versions, params)
  req.send_request(options)
end

#list_odb_networks(params = {}) ⇒ Types::ListOdbNetworksOutput

Returns information about the ODB networks owned by your Amazon Web Services account.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_odb_networks({
  max_results: 1,
  next_token: "ListOdbNetworksInputNextTokenString",
})

Response structure


resp.next_token #=> String
resp.odb_networks #=> Array
resp.odb_networks[0].odb_network_id #=> String
resp.odb_networks[0].display_name #=> String
resp.odb_networks[0].status #=> String, one of "AVAILABLE", "FAILED", "PROVISIONING", "TERMINATED", "TERMINATING", "UPDATING", "MAINTENANCE_IN_PROGRESS"
resp.odb_networks[0].status_reason #=> String
resp.odb_networks[0].odb_network_arn #=> String
resp.odb_networks[0].availability_zone #=> String
resp.odb_networks[0].availability_zone_id #=> String
resp.odb_networks[0].client_subnet_cidr #=> String
resp.odb_networks[0].backup_subnet_cidr #=> String
resp.odb_networks[0].custom_domain_name #=> String
resp.odb_networks[0].default_dns_prefix #=> String
resp.odb_networks[0].peered_cidrs #=> Array
resp.odb_networks[0].peered_cidrs[0] #=> String
resp.odb_networks[0].oci_network_anchor_id #=> String
resp.odb_networks[0].oci_network_anchor_url #=> String
resp.odb_networks[0].oci_resource_anchor_name #=> String
resp.odb_networks[0].oci_vcn_id #=> String
resp.odb_networks[0].oci_vcn_url #=> String
resp.odb_networks[0].oci_dns_forwarding_configs #=> Array
resp.odb_networks[0].oci_dns_forwarding_configs[0].domain_name #=> String
resp.odb_networks[0].oci_dns_forwarding_configs[0].oci_dns_listener_ip #=> String
resp.odb_networks[0].created_at #=> Time
resp.odb_networks[0].percent_progress #=> Float
resp.odb_networks[0].managed_services.service_network_arn #=> String
resp.odb_networks[0].managed_services.resource_gateway_arn #=> String
resp.odb_networks[0].managed_services.managed_services_ipv_4_cidrs #=> Array
resp.odb_networks[0].managed_services.managed_services_ipv_4_cidrs[0] #=> String
resp.odb_networks[0].managed_services.service_network_endpoint.vpc_endpoint_id #=> String
resp.odb_networks[0].managed_services.service_network_endpoint.vpc_endpoint_type #=> String, one of "SERVICENETWORK"
resp.odb_networks[0].managed_services.managed_s3_backup_access.status #=> String, one of "ENABLED", "ENABLING", "DISABLED", "DISABLING"
resp.odb_networks[0].managed_services.managed_s3_backup_access.ipv4_addresses #=> Array
resp.odb_networks[0].managed_services.managed_s3_backup_access.ipv4_addresses[0] #=> String
resp.odb_networks[0].managed_services.zero_etl_access.status #=> String, one of "ENABLED", "ENABLING", "DISABLED", "DISABLING"
resp.odb_networks[0].managed_services.zero_etl_access.cidr #=> String
resp.odb_networks[0].managed_services.s3_access.status #=> String, one of "ENABLED", "ENABLING", "DISABLED", "DISABLING"
resp.odb_networks[0].managed_services.s3_access.ipv4_addresses #=> Array
resp.odb_networks[0].managed_services.s3_access.ipv4_addresses[0] #=> String
resp.odb_networks[0].managed_services.s3_access.domain_name #=> String
resp.odb_networks[0].managed_services.s3_access.s3_policy_document #=> String
resp.odb_networks[0].managed_services.sts_access.status #=> String, one of "ENABLED", "ENABLING", "DISABLED", "DISABLING"
resp.odb_networks[0].managed_services.sts_access.ipv4_addresses #=> Array
resp.odb_networks[0].managed_services.sts_access.ipv4_addresses[0] #=> String
resp.odb_networks[0].managed_services.sts_access.domain_name #=> String
resp.odb_networks[0].managed_services.sts_access.sts_policy_document #=> String
resp.odb_networks[0].managed_services.kms_access.status #=> String, one of "ENABLED", "ENABLING", "DISABLED", "DISABLING"
resp.odb_networks[0].managed_services.kms_access.ipv4_addresses #=> Array
resp.odb_networks[0].managed_services.kms_access.ipv4_addresses[0] #=> String
resp.odb_networks[0].managed_services.kms_access.domain_name #=> String
resp.odb_networks[0].managed_services.kms_access.kms_policy_document #=> String
resp.odb_networks[0].managed_services.cross_region_s3_restore_sources_access #=> Array
resp.odb_networks[0].managed_services.cross_region_s3_restore_sources_access[0].region #=> String
resp.odb_networks[0].managed_services.cross_region_s3_restore_sources_access[0].ipv4_addresses #=> Array
resp.odb_networks[0].managed_services.cross_region_s3_restore_sources_access[0].ipv4_addresses[0] #=> String
resp.odb_networks[0].managed_services.cross_region_s3_restore_sources_access[0].status #=> String, one of "ENABLED", "ENABLING", "DISABLED", "DISABLING"
resp.odb_networks[0].ec2_placement_group_ids #=> Array
resp.odb_networks[0].ec2_placement_group_ids[0] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :max_results (Integer) —

    The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output.

    Default: 10

  • :next_token (String) —

    The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

Returns:

See Also:



5129
5130
5131
5132
 
# File 'gems/aws-sdk-odb/lib/aws-sdk-odb/client.rb', line 5129

def list_odb_networks(params = {}, options = {})
  req = build_request(:list_odb_networks, params)
  req.send_request(options)
end

#list_odb_peering_connections(params = {}) ⇒ Types::ListOdbPeeringConnectionsOutput

Lists all ODB peering connections or those associated with a specific ODB network.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_odb_peering_connections({
  max_results: 1,
  next_token: "ListOdbPeeringConnectionsInputNextTokenString",
  odb_network_id: "ResourceIdOrArn",
})

Response structure


resp.next_token #=> String
resp.odb_peering_connections #=> Array
resp.odb_peering_connections[0].odb_peering_connection_id #=> String
resp.odb_peering_connections[0].display_name #=> String
resp.odb_peering_connections[0].status #=> String, one of "AVAILABLE", "FAILED", "PROVISIONING", "TERMINATED", "TERMINATING", "UPDATING", "MAINTENANCE_IN_PROGRESS"
resp.odb_peering_connections[0].status_reason #=> String
resp.odb_peering_connections[0].odb_peering_connection_arn #=> String
resp.odb_peering_connections[0].odb_network_arn #=> String
resp.odb_peering_connections[0].peer_network_arn #=> String
resp.odb_peering_connections[0].odb_peering_connection_type #=> String
resp.odb_peering_connections[0].peer_network_cidrs #=> Array
resp.odb_peering_connections[0].peer_network_cidrs[0] #=> String
resp.odb_peering_connections[0].created_at #=> Time
resp.odb_peering_connections[0].percent_progress #=> Float

Parameters:

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

    ({})

Options Hash (params):

  • :max_results (Integer) —

    The maximum number of ODB peering connections to return in the response.

    Default: 20

    Constraints:

    • Must be between 1 and 100.

    ^

  • :next_token (String) —

    The pagination token for the next page of ODB peering connections.

  • :odb_network_id (String) —

    The identifier of the ODB network to list peering connections for.

    If not specified, lists all ODB peering connections in the account.

Returns:

See Also:



5193
5194
5195
5196
 
# File 'gems/aws-sdk-odb/lib/aws-sdk-odb/client.rb', line 5193

def list_odb_peering_connections(params = {}, options = {})
  req = build_request(:list_odb_peering_connections, params)
  req.send_request(options)
end

#list_system_versions(params = {}) ⇒ Types::ListSystemVersionsOutput

Returns information about the system versions that are available for a VM cluster for the specified giVersion and shape.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_system_versions({
  max_results: 1,
  next_token: "ListSystemVersionsInputNextTokenString",
  gi_version: "ListSystemVersionsInputGiVersionString", # required
  shape: "ListSystemVersionsInputShapeString", # required
})

Response structure


resp.next_token #=> String
resp.system_versions #=> Array
resp.system_versions[0].gi_version #=> String
resp.system_versions[0].shape #=> String
resp.system_versions[0].system_versions #=> Array
resp.system_versions[0].system_versions[0] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :max_results (Integer) —

    The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output.

    Default: 10

  • :next_token (String) —

    The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

  • :gi_version (required, String) —

    The software version of the Exadata Grid Infrastructure (GI).

  • :shape (required, String) —

    The Exadata hardware system model.

Returns:

See Also:



5247
5248
5249
5250
 
# File 'gems/aws-sdk-odb/lib/aws-sdk-odb/client.rb', line 5247

def list_system_versions(params = {}, options = {})
  req = build_request(:list_system_versions, params)
  req.send_request(options)
end

#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse

Returns information about the tags applied to this resource.

Examples:

Request syntax with placeholder values


resp = client.list_tags_for_resource({
  resource_arn: "ResourceArn", # required
})

Response structure


resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the resource to list tags for.

Returns:

See Also:



5276
5277
5278
5279
 
# File 'gems/aws-sdk-odb/lib/aws-sdk-odb/client.rb', line 5276

def list_tags_for_resource(params = {}, options = {})
  req = build_request(:list_tags_for_resource, params)
  req.send_request(options)
end

#reboot_autonomous_database(params = {}) ⇒ Types::RebootAutonomousDatabaseOutput

Reboots the specified Autonomous Database.

Examples:

Request syntax with placeholder values


resp = client.reboot_autonomous_database({
  autonomous_database_id: "ResourceIdOrArn", # required
  is_online_reboot: false,
})

Response structure


resp.autonomous_database_id #=> String
resp.display_name #=> String
resp.status #=> String, one of "AVAILABLE", "FAILED", "PROVISIONING", "TERMINATED", "TERMINATING", "UPDATING", "MAINTENANCE_IN_PROGRESS", "STOPPING", "STOPPED", "STARTING", "UNAVAILABLE", "RESTORE_IN_PROGRESS", "RESTORE_FAILED", "BACKUP_IN_PROGRESS", "SCALE_IN_PROGRESS", "AVAILABLE_NEEDS_ATTENTION", "RESTARTING", "RECREATING", "ROLE_CHANGE_IN_PROGRESS", "UPGRADING", "INACCESSIBLE", "STANDBY"
resp.status_reason #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :autonomous_database_id (required, String) —

    The unique identifier of the Autonomous Database to reboot.

  • :is_online_reboot (Boolean) —

    Specifies whether to perform an online reboot of the Autonomous Database without interrupting active connections.

Returns:

See Also:



5315
5316
5317
5318
 
# File 'gems/aws-sdk-odb/lib/aws-sdk-odb/client.rb', line 5315

def reboot_autonomous_database(params = {}, options = {})
  req = build_request(:reboot_autonomous_database, params)
  req.send_request(options)
end

#reboot_db_node(params = {}) ⇒ Types::RebootDbNodeOutput

Reboots the specified DB node in a VM cluster.

Examples:

Request syntax with placeholder values


resp = client.reboot_db_node({
  cloud_vm_cluster_id: "ResourceId",
  exadb_vm_cluster_id: "ResourceId",
  db_node_id: "ResourceId", # required
})

Response structure


resp.db_node_id #=> String
resp.status #=> String, one of "AVAILABLE", "FAILED", "PROVISIONING", "TERMINATED", "TERMINATING", "UPDATING", "STOPPING", "STOPPED", "STARTING"
resp.status_reason #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :cloud_vm_cluster_id (String) —

    The unique identifier of the VM cluster that contains the DB node to reboot. You must specify either this parameter or exadbVmClusterId.

  • :exadb_vm_cluster_id (String) —

    The unique identifier of the Exascale VM cluster that contains the DB node to reboot. You must specify either this parameter or cloudVmClusterId.

  • :db_node_id (required, String) —

    The unique identifier of the DB node to reboot.

Returns:

See Also:



5358
5359
5360
5361
 
# File 'gems/aws-sdk-odb/lib/aws-sdk-odb/client.rb', line 5358

def reboot_db_node(params = {}, options = {})
  req = build_request(:reboot_db_node, params)
  req.send_request(options)
end

#restore_autonomous_database(params = {}) ⇒ Types::RestoreAutonomousDatabaseOutput

Restores the specified Autonomous Database to a point in time.

Examples:

Request syntax with placeholder values


resp = client.restore_autonomous_database({
  autonomous_database_id: "ResourceIdOrArn", # required
  timestamp: Time.now, # required
})

Response structure


resp.autonomous_database_id #=> String
resp.display_name #=> String
resp.status #=> String, one of "AVAILABLE", "FAILED", "PROVISIONING", "TERMINATED", "TERMINATING", "UPDATING", "MAINTENANCE_IN_PROGRESS", "STOPPING", "STOPPED", "STARTING", "UNAVAILABLE", "RESTORE_IN_PROGRESS", "RESTORE_FAILED", "BACKUP_IN_PROGRESS", "SCALE_IN_PROGRESS", "AVAILABLE_NEEDS_ATTENTION", "RESTARTING", "RECREATING", "ROLE_CHANGE_IN_PROGRESS", "UPGRADING", "INACCESSIBLE", "STANDBY"
resp.status_reason #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :autonomous_database_id (required, String) —

    The unique identifier of the Autonomous Database to restore.

  • :timestamp (required, Time, DateTime, Date, Integer, String) —

    The date and time to which to restore the Autonomous Database.

Returns:

See Also:



5396
5397
5398
5399
 
# File 'gems/aws-sdk-odb/lib/aws-sdk-odb/client.rb', line 5396

def restore_autonomous_database(params = {}, options = {})
  req = build_request(:restore_autonomous_database, params)
  req.send_request(options)
end

#shrink_autonomous_database(params = {}) ⇒ Types::ShrinkAutonomousDatabaseOutput

Shrinks the storage of the specified Autonomous Database to reclaim unused space.

Examples:

Request syntax with placeholder values


resp = client.shrink_autonomous_database({
  autonomous_database_id: "ResourceIdOrArn", # required
})

Response structure


resp.autonomous_database_id #=> String
resp.display_name #=> String
resp.status #=> String, one of "AVAILABLE", "FAILED", "PROVISIONING", "TERMINATED", "TERMINATING", "UPDATING", "MAINTENANCE_IN_PROGRESS", "STOPPING", "STOPPED", "STARTING", "UNAVAILABLE", "RESTORE_IN_PROGRESS", "RESTORE_FAILED", "BACKUP_IN_PROGRESS", "SCALE_IN_PROGRESS", "AVAILABLE_NEEDS_ATTENTION", "RESTARTING", "RECREATING", "ROLE_CHANGE_IN_PROGRESS", "UPGRADING", "INACCESSIBLE", "STANDBY"
resp.status_reason #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :autonomous_database_id (required, String) —

    The unique identifier of the Autonomous Database to shrink.

Returns:

See Also:



5431
5432
5433
5434
 
# File 'gems/aws-sdk-odb/lib/aws-sdk-odb/client.rb', line 5431

def shrink_autonomous_database(params = {}, options = {})
  req = build_request(:shrink_autonomous_database, params)
  req.send_request(options)
end

#start_autonomous_database(params = {}) ⇒ Types::StartAutonomousDatabaseOutput

Starts the specified Autonomous Database.

Examples:

Request syntax with placeholder values


resp = client.start_autonomous_database({
  autonomous_database_id: "ResourceIdOrArn", # required
})

Response structure


resp.autonomous_database_id #=> String
resp.display_name #=> String
resp.status #=> String, one of "AVAILABLE", "FAILED", "PROVISIONING", "TERMINATED", "TERMINATING", "UPDATING", "MAINTENANCE_IN_PROGRESS", "STOPPING", "STOPPED", "STARTING", "UNAVAILABLE", "RESTORE_IN_PROGRESS", "RESTORE_FAILED", "BACKUP_IN_PROGRESS", "SCALE_IN_PROGRESS", "AVAILABLE_NEEDS_ATTENTION", "RESTARTING", "RECREATING", "ROLE_CHANGE_IN_PROGRESS", "UPGRADING", "INACCESSIBLE", "STANDBY"
resp.status_reason #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :autonomous_database_id (required, String) —

    The unique identifier of the Autonomous Database to start.

Returns:

See Also:



5465
5466
5467
5468
 
# File 'gems/aws-sdk-odb/lib/aws-sdk-odb/client.rb', line 5465

def start_autonomous_database(params = {}, options = {})
  req = build_request(:start_autonomous_database, params)
  req.send_request(options)
end

#start_db_node(params = {}) ⇒ Types::StartDbNodeOutput

Starts the specified DB node in a VM cluster.

Examples:

Request syntax with placeholder values


resp = client.start_db_node({
  cloud_vm_cluster_id: "ResourceId",
  exadb_vm_cluster_id: "ResourceId",
  db_node_id: "ResourceId", # required
})

Response structure


resp.db_node_id #=> String
resp.status #=> String, one of "AVAILABLE", "FAILED", "PROVISIONING", "TERMINATED", "TERMINATING", "UPDATING", "STOPPING", "STOPPED", "STARTING"
resp.status_reason #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :cloud_vm_cluster_id (String) —

    The unique identifier of the VM cluster that contains the DB node to start. You must specify either this parameter or exadbVmClusterId.

  • :exadb_vm_cluster_id (String) —

    The unique identifier of the Exascale VM cluster that contains the DB node to start. You must specify either this parameter or cloudVmClusterId.

  • :db_node_id (required, String) —

    The unique identifier of the DB node to start.

Returns:

See Also:



5508
5509
5510
5511
 
# File 'gems/aws-sdk-odb/lib/aws-sdk-odb/client.rb', line 5508

def start_db_node(params = {}, options = {})
  req = build_request(:start_db_node, params)
  req.send_request(options)
end

#stop_autonomous_database(params = {}) ⇒ Types::StopAutonomousDatabaseOutput

Stops the specified Autonomous Database.

Examples:

Request syntax with placeholder values


resp = client.stop_autonomous_database({
  autonomous_database_id: "ResourceIdOrArn", # required
})

Response structure


resp.autonomous_database_id #=> String
resp.display_name #=> String
resp.status #=> String, one of "AVAILABLE", "FAILED", "PROVISIONING", "TERMINATED", "TERMINATING", "UPDATING", "MAINTENANCE_IN_PROGRESS", "STOPPING", "STOPPED", "STARTING", "UNAVAILABLE", "RESTORE_IN_PROGRESS", "RESTORE_FAILED", "BACKUP_IN_PROGRESS", "SCALE_IN_PROGRESS", "AVAILABLE_NEEDS_ATTENTION", "RESTARTING", "RECREATING", "ROLE_CHANGE_IN_PROGRESS", "UPGRADING", "INACCESSIBLE", "STANDBY"
resp.status_reason #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :autonomous_database_id (required, String) —

    The unique identifier of the Autonomous Database to stop.

Returns:

See Also:



5542
5543
5544
5545
 
# File 'gems/aws-sdk-odb/lib/aws-sdk-odb/client.rb', line 5542

def stop_autonomous_database(params = {}, options = {})
  req = build_request(:stop_autonomous_database, params)
  req.send_request(options)
end

#stop_db_node(params = {}) ⇒ Types::StopDbNodeOutput

Stops the specified DB node in a VM cluster.

Examples:

Request syntax with placeholder values


resp = client.stop_db_node({
  cloud_vm_cluster_id: "ResourceId",
  exadb_vm_cluster_id: "ResourceId",
  db_node_id: "ResourceId", # required
})

Response structure


resp.db_node_id #=> String
resp.status #=> String, one of "AVAILABLE", "FAILED", "PROVISIONING", "TERMINATED", "TERMINATING", "UPDATING", "STOPPING", "STOPPED", "STARTING"
resp.status_reason #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :cloud_vm_cluster_id (String) —

    The unique identifier of the VM cluster that contains the DB node to stop. You must specify either this parameter or exadbVmClusterId.

  • :exadb_vm_cluster_id (String) —

    The unique identifier of the Exascale VM cluster that contains the DB node to stop. You must specify either this parameter or cloudVmClusterId.

  • :db_node_id (required, String) —

    The unique identifier of the DB node to stop.

Returns:

See Also:



5585
5586
5587
5588
 
# File 'gems/aws-sdk-odb/lib/aws-sdk-odb/client.rb', line 5585

def stop_db_node(params = {}, options = {})
  req = build_request(:stop_db_node, params)
  req.send_request(options)
end

#switchover_autonomous_database(params = {}) ⇒ Types::SwitchoverAutonomousDatabaseOutput

Performs a switchover of the specified Autonomous Database to a standby peer database.

Examples:

Request syntax with placeholder values


resp = client.switchover_autonomous_database({
  autonomous_database_id: "ResourceIdOrArn", # required
  peer_db_arn: "ResourceArn",
})

Response structure


resp.autonomous_database_id #=> String
resp.display_name #=> String
resp.status #=> String, one of "AVAILABLE", "FAILED", "PROVISIONING", "TERMINATED", "TERMINATING", "UPDATING", "MAINTENANCE_IN_PROGRESS", "STOPPING", "STOPPED", "STARTING", "UNAVAILABLE", "RESTORE_IN_PROGRESS", "RESTORE_FAILED", "BACKUP_IN_PROGRESS", "SCALE_IN_PROGRESS", "AVAILABLE_NEEDS_ATTENTION", "RESTARTING", "RECREATING", "ROLE_CHANGE_IN_PROGRESS", "UPGRADING", "INACCESSIBLE", "STANDBY"
resp.status_reason #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :autonomous_database_id (required, String) —

    The unique identifier of the Autonomous Database to switch over.

  • :peer_db_arn (String) —

    The Amazon Resource Name (ARN) of the peer Autonomous Database to switch over to.

Returns:

See Also:



5625
5626
5627
5628
 
# File 'gems/aws-sdk-odb/lib/aws-sdk-odb/client.rb', line 5625

def switchover_autonomous_database(params = {}, options = {})
  req = build_request(:switchover_autonomous_database, params)
  req.send_request(options)
end

#tag_resource(params = {}) ⇒ Struct

Applies tags to the specified resource.

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  resource_arn: "ResourceArn", # required
  tags: { # required
    "TagKey" => "TagValue",
  },
})

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the resource to apply tags to.

  • :tags (required, Hash<String,String>) —

    The list of tags to apply to the resource.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



5653
5654
5655
5656
 
# File 'gems/aws-sdk-odb/lib/aws-sdk-odb/client.rb', line 5653

def tag_resource(params = {}, options = {})
  req = build_request(:tag_resource, params)
  req.send_request(options)
end

#untag_resource(params = {}) ⇒ Struct

Removes tags from the specified resource.

Examples:

Request syntax with placeholder values


resp = client.untag_resource({
  resource_arn: "ResourceArn", # required
  tag_keys: ["TagKey"], # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the resource to remove tags from.

  • :tag_keys (required, Array<String>) —

    The names (keys) of the tags to remove from the resource.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



5679
5680
5681
5682
 
# File 'gems/aws-sdk-odb/lib/aws-sdk-odb/client.rb', line 5679

def untag_resource(params = {}, options = {})
  req = build_request(:untag_resource, params)
  req.send_request(options)
end

#update_autonomous_database(params = {}) ⇒ Types::UpdateAutonomousDatabaseOutput

Updates the properties of an Autonomous Database.

Examples:

Request syntax with placeholder values


resp = client.update_autonomous_database({
  autonomous_database_id: "ResourceIdOrArn", # required
  admin_password: "UpdateAutonomousDatabaseInputAdminPasswordString",
  compute_count: 1.0,
  cpu_core_count: 1,
  data_storage_size_in_t_bs: 1,
  data_storage_size_in_g_bs: 1,
  display_name: "ResourceDisplayName",
  db_name: "UpdateAutonomousDatabaseInputDbNameString",
  db_version: "UpdateAutonomousDatabaseInputDbVersionString",
  db_workload: "OLTP", # accepts OLTP, AJD, APEX, LH
  db_tools_details: [
    {
      is_enabled: false,
      name: "String",
      compute_count: 1.0,
      max_idle_time_in_minutes: 1,
    },
  ],
  database_edition: "STANDARD_EDITION", # accepts STANDARD_EDITION, ENTERPRISE_EDITION
  license_model: "BRING_YOUR_OWN_LICENSE", # accepts BRING_YOUR_OWN_LICENSE, LICENSE_INCLUDED
  is_auto_scaling_enabled: false,
  is_auto_scaling_for_storage_enabled: false,
  is_backup_retention_locked: false,
  is_local_data_guard_enabled: false,
  is_mtls_connection_required: false,
  is_refreshable_clone: false,
  is_disconnect_peer: false,
  backup_retention_period_in_days: 1,
  byol_compute_count_limit: 1.0,
  local_adg_auto_failover_max_data_loss_limit: 1,
  autonomous_maintenance_schedule_type: "EARLY", # accepts EARLY, REGULAR
  customer_contacts_to_send_to_oci: [
    {
      email: "CustomerContactEmailString",
    },
  ],
  scheduled_operations: [
    {
      day_of_week: { # required
        name: "MONDAY", # accepts MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY
      },
      scheduled_start_time: "String",
      scheduled_stop_time: "String",
    },
  ],
  long_term_backup_schedule: {
    is_disabled: false,
    repeat_cadence: "ONE_TIME", # accepts ONE_TIME, WEEKLY, MONTHLY, YEARLY
    retention_period_in_days: 1,
    time_of_backup: Time.now,
  },
  open_mode: "READ_ONLY", # accepts READ_ONLY, READ_WRITE
  permission_level: "RESTRICTED", # accepts RESTRICTED, UNRESTRICTED
  refreshable_mode: "AUTOMATIC", # accepts AUTOMATIC, MANUAL
  private_endpoint_ip: "String",
  private_endpoint_label: "String",
  peer_db_id: "ResourceIdOrArn",
  resource_pool_leader_id: "ResourceIdOrArn",
  resource_pool_summary: {
    is_disabled: false,
    pool_size: 1,
    pool_storage_size_in_t_bs: 1,
    available_storage_capacity_in_t_bs: 1.0,
    total_compute_capacity: 1,
    available_compute_capacity: 1,
  },
  standby_allowlisted_ips_source: "PRIMARY", # accepts PRIMARY, SEPARATE, NOT_APPLICABLE
  standby_allowlisted_ips: ["String"],
  allowlisted_ips: ["String"],
  auto_refresh_frequency_in_seconds: 1,
  auto_refresh_point_lag_in_seconds: 1,
  time_of_auto_refresh_start: Time.now,
  encryption_key_provider: "ORACLE_MANAGED", # accepts ORACLE_MANAGED, AWS_KMS
  encryption_key_configuration: {
    aws_encryption_key: {
      iam_role_arn: "RoleArn",
      external_id_type: "database_ocid", # accepts database_ocid, compartment_ocid, tenant_ocid
      kms_key_id: "KmsKeyIdOrArn",
    },
  },
  admin_password_source: "CUSTOMER_MANAGED_AWS_SECRET", # accepts CUSTOMER_MANAGED_AWS_SECRET, API_REQUEST_PARAMETER
  admin_password_source_configuration: {
    customer_managed_aws_secret: {
      secret_id: "SecretIdOrArn",
      iam_role_arn: "RoleArn",
      external_id_type: "database_ocid", # accepts database_ocid, compartment_ocid, tenant_ocid
    },
  },
})

Response structure


resp.autonomous_database_id #=> String
resp.display_name #=> String
resp.status #=> String, one of "AVAILABLE", "FAILED", "PROVISIONING", "TERMINATED", "TERMINATING", "UPDATING", "MAINTENANCE_IN_PROGRESS", "STOPPING", "STOPPED", "STARTING", "UNAVAILABLE", "RESTORE_IN_PROGRESS", "RESTORE_FAILED", "BACKUP_IN_PROGRESS", "SCALE_IN_PROGRESS", "AVAILABLE_NEEDS_ATTENTION", "RESTARTING", "RECREATING", "ROLE_CHANGE_IN_PROGRESS", "UPGRADING", "INACCESSIBLE", "STANDBY"
resp.status_reason #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :autonomous_database_id (required, String) —

    The unique identifier of the Autonomous Database to update.

  • :admin_password (String) —

    The new password for the ADMIN user of the Autonomous Database.

  • :compute_count (Float) —

    The compute capacity, in number of ECPUs or OCPUs, to assign to the Autonomous Database.

  • :cpu_core_count (Integer) —

    The number of CPU cores to allocate to the Autonomous Database.

  • :data_storage_size_in_t_bs (Integer) —

    The size, in terabytes (TB), of the data volume to allocate for the Autonomous Database.

  • :data_storage_size_in_g_bs (Integer) —

    The size, in gigabytes (GB), of the data volume to allocate for the Autonomous Database.

  • :display_name (String) —

    The new user-friendly name for the Autonomous Database.

  • :db_name (String) —

    The new name of the Autonomous Database.

  • :db_version (String) —

    The Oracle Database software version to use for the Autonomous Database.

  • :db_workload (String) —

    The intended use of the Autonomous Database, such as transaction processing, data warehouse, JSON database, or APEX.

  • :db_tools_details (Array<Types::DatabaseTool>) —

    The list of database management tools to enable for the Autonomous Database.

  • :database_edition (String) —

    The Oracle Database edition to apply to the Autonomous Database.

  • :license_model (String) —

    The Oracle license model to apply to the Autonomous Database.

  • :is_auto_scaling_enabled (Boolean) —

    Specifies whether to enable automatic scaling of the compute resources for the Autonomous Database.

  • :is_auto_scaling_for_storage_enabled (Boolean) —

    Specifies whether to enable automatic scaling of the storage for the Autonomous Database.

  • :is_backup_retention_locked (Boolean) —

    Specifies whether to lock the backup retention period of the Autonomous Database to prevent it from being shortened.

  • :is_local_data_guard_enabled (Boolean) —

    Specifies whether to enable local Oracle Data Guard for the Autonomous Database.

  • :is_mtls_connection_required (Boolean) —

    Specifies whether mutual TLS (mTLS) authentication is required to connect to the Autonomous Database.

  • :is_refreshable_clone (Boolean) —

    Specifies whether the Autonomous Database is a refreshable clone.

  • :is_disconnect_peer (Boolean) —

    Specifies whether to disconnect the Autonomous Database from its peer database.

  • :backup_retention_period_in_days (Integer) —

    The retention period, in days, for automatic backups of the Autonomous Database.

  • :byol_compute_count_limit (Float) —

    The maximum number of compute resources that you can allocate to the Autonomous Database under the bring-your-own-license (BYOL) model.

  • :local_adg_auto_failover_max_data_loss_limit (Integer) —

    The maximum data loss limit, in seconds, for automatic failover to the local Oracle Data Guard standby database.

  • :autonomous_maintenance_schedule_type (String) —

    The maintenance schedule type for the Autonomous Database.

  • :customer_contacts_to_send_to_oci (Array<Types::CustomerContact>) —

    The list of customer contacts to receive operational notifications from OCI for the Autonomous Database.

  • :scheduled_operations (Array<Types::ScheduledOperationDetails>) —

    The list of scheduled start and stop times for the Autonomous Database.

  • :long_term_backup_schedule (Types::LongTermBackupSchedule) —

    The long-term backup schedule for the Autonomous Database.

  • :open_mode (String) —

    The mode in which to open the Autonomous Database, either read-only or read/write.

  • :permission_level (String) —

    The permission level of the Autonomous Database.

  • :refreshable_mode (String) —

    The refresh mode of the refreshable clone Autonomous Database.

  • :private_endpoint_ip (String) —

    The private endpoint IP address for the Autonomous Database.

  • :private_endpoint_label (String) —

    The private endpoint label for the Autonomous Database.

  • :peer_db_id (String) —

    The unique identifier of the peer Autonomous Database.

  • :resource_pool_leader_id (String) —

    The unique identifier of the resource pool leader Autonomous Database.

  • :resource_pool_summary (Types::ResourcePoolSummary) —

    The configuration of the resource pool for the Autonomous Database.

  • :standby_allowlisted_ips_source (String) —

    The source of the allowlisted IP addresses for the standby Autonomous Database.

  • :standby_allowlisted_ips (Array<String>) —

    The list of IP addresses that are allowed to access the standby Autonomous Database.

  • :allowlisted_ips (Array<String>) —

    The list of IP addresses that are allowed to access the Autonomous Database.

  • :auto_refresh_frequency_in_seconds (Integer) —

    The frequency, in seconds, at which the refreshable clone Autonomous Database is automatically refreshed.

  • :auto_refresh_point_lag_in_seconds (Integer) —

    The time lag, in seconds, between the refreshable clone and its source Autonomous Database.

  • :time_of_auto_refresh_start (Time, DateTime, Date, Integer, String) —

    The date and time at which the automatic refresh of the refreshable clone Autonomous Database starts.

  • :encryption_key_provider (String) —

    The provider of the encryption key to use for the Autonomous Database.

  • :encryption_key_configuration (Types::EncryptionKeyConfigurationInput) —

    The configuration of the encryption key to use for the Autonomous Database.

  • :admin_password_source (String) —

    The source of the admin password for the Autonomous Database. When set to CUSTOMER_MANAGED_AWS_SECRET, the admin password is retrieved from an Amazon Web Services Secrets Manager secret.

  • :admin_password_source_configuration (Types::AdminPasswordSourceConfigurationInput) —

    The configuration of the admin password source for the Autonomous Database.

Returns:

See Also:



5960
5961
5962
5963
 
# File 'gems/aws-sdk-odb/lib/aws-sdk-odb/client.rb', line 5960

def update_autonomous_database(params = {}, options = {})
  req = build_request(:update_autonomous_database, params)
  req.send_request(options)
end

#update_autonomous_database_backup(params = {}) ⇒ Types::UpdateAutonomousDatabaseBackupOutput

Updates the properties of an Autonomous Database backup.

Examples:

Request syntax with placeholder values


resp = client.update_autonomous_database_backup({
  autonomous_database_backup_id: "ResourceId", # required
  retention_period_in_days: 1,
})

Response structure


resp.display_name #=> String
resp.status #=> String, one of "AVAILABLE", "FAILED", "PROVISIONING", "TERMINATED", "TERMINATING", "UPDATING", "MAINTENANCE_IN_PROGRESS"
resp.status_reason #=> String
resp.autonomous_database_backup_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :autonomous_database_backup_id (required, String) —

    The unique identifier of the Autonomous Database backup to update.

  • :retention_period_in_days (Integer) —

    The retention period, in days, for the Autonomous Database backup.

Returns:

See Also:



5998
5999
6000
6001
 
# File 'gems/aws-sdk-odb/lib/aws-sdk-odb/client.rb', line 5998

def update_autonomous_database_backup(params = {}, options = {})
  req = build_request(:update_autonomous_database_backup, params)
  req.send_request(options)
end

#update_cloud_autonomous_vm_cluster(params = {}) ⇒ Types::UpdateCloudAutonomousVmClusterOutput

Updates the properties of the specified Autonomous VM cluster.

Examples:

Request syntax with placeholder values


resp = client.update_cloud_autonomous_vm_cluster({
  cloud_autonomous_vm_cluster_id: "ResourceId", # required
  autonomous_data_storage_size_in_t_bs: 1.0,
  cpu_core_count_per_node: 1,
  description: "UpdateCloudAutonomousVmClusterInputDescriptionString",
  display_name: "ResourceDisplayName",
  license_model: "BRING_YOUR_OWN_LICENSE", # accepts BRING_YOUR_OWN_LICENSE, LICENSE_INCLUDED
  maintenance_window: {
    custom_action_timeout_in_mins: 1,
    days_of_week: [
      {
        name: "MONDAY", # accepts MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY
      },
    ],
    hours_of_day: [1],
    is_custom_action_timeout_enabled: false,
    lead_time_in_weeks: 1,
    months: [
      {
        name: "JANUARY", # accepts JANUARY, FEBRUARY, MARCH, APRIL, MAY, JUNE, JULY, AUGUST, SEPTEMBER, OCTOBER, NOVEMBER, DECEMBER
      },
    ],
    patching_mode: "ROLLING", # accepts ROLLING, NONROLLING
    preference: "NO_PREFERENCE", # accepts NO_PREFERENCE, CUSTOM_PREFERENCE
    skip_ru: false,
    weeks_of_month: [1],
  },
  total_container_databases: 1,
})

Response structure


resp.display_name #=> String
resp.status #=> String, one of "AVAILABLE", "FAILED", "PROVISIONING", "TERMINATED", "TERMINATING", "UPDATING", "MAINTENANCE_IN_PROGRESS"
resp.status_reason #=> String
resp.cloud_autonomous_vm_cluster_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :cloud_autonomous_vm_cluster_id (required, String) —

    The unique identifier of the Autonomous VM cluster to update.

  • :autonomous_data_storage_size_in_t_bs (Float) —

    The data storage size to allocate for Autonomous Databases in the Autonomous VM cluster, in terabytes (TB).

  • :cpu_core_count_per_node (Integer) —

    The number of CPU cores to enable per node in the Autonomous VM cluster. If you don't specify a value, the existing number of CPU cores per node is retained.

  • :description (String) —

    A user-provided description of the Autonomous VM cluster.

  • :display_name (String) —

    A new user-friendly name for the Autonomous VM cluster.

  • :license_model (String) —

    The Oracle license model to apply to the Autonomous VM cluster.

  • :maintenance_window (Types::MaintenanceWindow) —

    The scheduling details for the maintenance window. Patching and system updates take place during the maintenance window.

  • :total_container_databases (Integer) —

    The total number of Autonomous Container Databases that can be created in the Autonomous VM cluster.

Returns:

See Also:



6084
6085
6086
6087
 
# File 'gems/aws-sdk-odb/lib/aws-sdk-odb/client.rb', line 6084

def update_cloud_autonomous_vm_cluster(params = {}, options = {})
  req = build_request(:update_cloud_autonomous_vm_cluster, params)
  req.send_request(options)
end

#update_cloud_exadata_infrastructure(params = {}) ⇒ Types::UpdateCloudExadataInfrastructureOutput

Updates the properties of an Exadata infrastructure resource.

Examples:

Request syntax with placeholder values


resp = client.update_cloud_exadata_infrastructure({
  cloud_exadata_infrastructure_id: "ResourceIdOrArn", # required
  display_name: "ResourceDisplayName",
  compute_count: 1,
  maintenance_window: {
    custom_action_timeout_in_mins: 1,
    days_of_week: [
      {
        name: "MONDAY", # accepts MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY
      },
    ],
    hours_of_day: [1],
    is_custom_action_timeout_enabled: false,
    lead_time_in_weeks: 1,
    months: [
      {
        name: "JANUARY", # accepts JANUARY, FEBRUARY, MARCH, APRIL, MAY, JUNE, JULY, AUGUST, SEPTEMBER, OCTOBER, NOVEMBER, DECEMBER
      },
    ],
    patching_mode: "ROLLING", # accepts ROLLING, NONROLLING
    preference: "NO_PREFERENCE", # accepts NO_PREFERENCE, CUSTOM_PREFERENCE
    skip_ru: false,
    weeks_of_month: [1],
  },
  storage_count: 1,
})

Response structure


resp.display_name #=> String
resp.status #=> String, one of "AVAILABLE", "FAILED", "PROVISIONING", "TERMINATED", "TERMINATING", "UPDATING", "MAINTENANCE_IN_PROGRESS"
resp.status_reason #=> String
resp.cloud_exadata_infrastructure_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :cloud_exadata_infrastructure_id (required, String) —

    The unique identifier of the Exadata infrastructure to update.

  • :display_name (String) —

    A new user-friendly name for the Exadata infrastructure.

  • :compute_count (Integer) —

    The number of database servers for the Exadata infrastructure.

  • :maintenance_window (Types::MaintenanceWindow) —

    The maintenance window configuration for the Exadata Cloud infrastructure.

    This allows you to define when maintenance operations such as patching and updates can be performed on the infrastructure.

  • :storage_count (Integer) —

    The number of storage servers to activate for the Exadata infrastructure.

Returns:

See Also:



6158
6159
6160
6161
 
# File 'gems/aws-sdk-odb/lib/aws-sdk-odb/client.rb', line 6158

def update_cloud_exadata_infrastructure(params = {}, options = {})
  req = build_request(:update_cloud_exadata_infrastructure, params)
  req.send_request(options)
end

#update_cloud_exadata_infrastructure_storage_capacity(params = {}) ⇒ Types::UpdateCloudExadataInfrastructureStorageCapacityOutput

Adds storage capacity to the specified Exadata infrastructure.

Examples:

Request syntax with placeholder values


resp = client.update_cloud_exadata_infrastructure_storage_capacity({
  cloud_exadata_infrastructure_id: "ResourceIdOrArn", # required
})

Response structure


resp.display_name #=> String
resp.status #=> String, one of "AVAILABLE", "FAILED", "PROVISIONING", "TERMINATED", "TERMINATING", "UPDATING", "MAINTENANCE_IN_PROGRESS"
resp.status_reason #=> String
resp.cloud_exadata_infrastructure_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :cloud_exadata_infrastructure_id (required, String) —

    The unique identifier or Amazon Resource Name (ARN) of the Exadata infrastructure to update.

Returns:

See Also:



6193
6194
6195
6196
 
# File 'gems/aws-sdk-odb/lib/aws-sdk-odb/client.rb', line 6193

def update_cloud_exadata_infrastructure_storage_capacity(params = {}, options = {})
  req = build_request(:update_cloud_exadata_infrastructure_storage_capacity, params)
  req.send_request(options)
end

#update_cloud_vm_cluster(params = {}) ⇒ Types::UpdateCloudVmClusterOutput

Updates the properties of the specified VM cluster.

Examples:

Request syntax with placeholder values


resp = client.update_cloud_vm_cluster({
  cloud_vm_cluster_id: "ResourceId", # required
  cpu_core_count: 1,
  data_collection_options: {
    is_diagnostics_events_enabled: false,
    is_health_monitoring_enabled: false,
    is_incident_logs_enabled: false,
  },
  data_storage_size_in_t_bs: 1.0,
  db_node_storage_size_in_g_bs: 1,
  display_name: "ResourceDisplayName",
  ssh_public_keys: ["String"],
  license_model: "BRING_YOUR_OWN_LICENSE", # accepts BRING_YOUR_OWN_LICENSE, LICENSE_INCLUDED
  memory_size_in_g_bs: 1,
  storage_size_in_g_bs: 1,
})

Response structure


resp.display_name #=> String
resp.status #=> String, one of "AVAILABLE", "FAILED", "PROVISIONING", "TERMINATED", "TERMINATING", "UPDATING", "MAINTENANCE_IN_PROGRESS"
resp.status_reason #=> String
resp.cloud_vm_cluster_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :cloud_vm_cluster_id (required, String) —

    The unique identifier of the VM cluster to update.

  • :cpu_core_count (Integer) —

    The number of CPU cores to enable on the VM cluster. If you don't specify a value, the existing number of CPU cores is retained.

  • :data_collection_options (Types::DataCollectionOptions) —

    The set of preferences for the diagnostic collection options for the VM cluster.

  • :data_storage_size_in_t_bs (Float) —

    The size of the data disk group, in terabytes (TB), to allocate for the VM cluster.

  • :db_node_storage_size_in_g_bs (Integer) —

    The amount of local node storage, in gigabytes (GB), to allocate for the VM cluster.

  • :display_name (String) —

    A new user-friendly name for the VM cluster.

  • :ssh_public_keys (Array<String>) —

    The public key portion of one or more key pairs used for SSH access to the VM cluster.

  • :license_model (String) —

    The Oracle license model to apply to the VM cluster.

  • :memory_size_in_g_bs (Integer) —

    The amount of memory, in gigabytes (GB), to allocate for the VM cluster.

  • :storage_size_in_g_bs (Integer) —

    The amount of local node storage, in gigabytes (GB), to allocate to the VM cluster.

Returns:

See Also:



6274
6275
6276
6277
 
# File 'gems/aws-sdk-odb/lib/aws-sdk-odb/client.rb', line 6274

def update_cloud_vm_cluster(params = {}, options = {})
  req = build_request(:update_cloud_vm_cluster, params)
  req.send_request(options)
end

#update_exadb_vm_cluster(params = {}) ⇒ Types::UpdateExadbVmClusterOutput

Updates the specified Exascale VM cluster.

Examples:

Request syntax with placeholder values


resp = client.update_exadb_vm_cluster({
  exadb_vm_cluster_id: "ResourceIdOrArn", # required
  data_collection_options: {
    is_diagnostics_events_enabled: false,
    is_health_monitoring_enabled: false,
    is_incident_logs_enabled: false,
  },
  display_name: "ResourceDisplayName",
  enabled_ecpu_count: 1,
  grid_image_id: "UpdateExadbVmClusterInputGridImageIdString",
  license_model: "BRING_YOUR_OWN_LICENSE", # accepts BRING_YOUR_OWN_LICENSE, LICENSE_INCLUDED
  ssh_public_keys: ["String"],
  system_version: "UpdateExadbVmClusterInputSystemVersionString",
  total_ecpu_count: 1,
  update_action: "ROLLING_APPLY", # accepts ROLLING_APPLY, NON_ROLLING_APPLY, PRECHECK, ROLLBACK
  vm_file_system_storage_total_size_in_g_bs: 1,
})

Response structure


resp.display_name #=> String
resp.status #=> String, one of "AVAILABLE", "FAILED", "PROVISIONING", "TERMINATED", "TERMINATING", "UPDATING", "MAINTENANCE_IN_PROGRESS"
resp.status_reason #=> String
resp.exadb_vm_cluster_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :exadb_vm_cluster_id (required, String) —

    The unique identifier of the Exascale VM cluster to update.

  • :data_collection_options (Types::DataCollectionOptions) —

    The set of preferences for the various diagnostic collection options for the Exascale VM cluster.

  • :display_name (String) —

    A new user-friendly name for the Exascale VM cluster.

  • :enabled_ecpu_count (Integer) —

    The number of ECPUs to enable for the Exascale VM cluster.

  • :grid_image_id (String) —

    The Grid Infrastructure software image ID for the Exascale VM cluster.

  • :license_model (String) —

    The Oracle license model to apply to the Exascale VM cluster.

  • :ssh_public_keys (Array<String>) —

    The public key portion of one or more key pairs used for SSH access to the Exascale VM cluster.

  • :system_version (String) —

    The version of the operating system of the image for the Exascale VM cluster.

  • :total_ecpu_count (Integer) —

    The total number of ECPUs for the Exascale VM cluster.

  • :update_action (String) —

    The update action to perform on the Exascale VM cluster.

  • :vm_file_system_storage_total_size_in_g_bs (Integer) —

    The total amount of file system storage, in gigabytes (GB), for the Exascale VM cluster.

Returns:

See Also:



6356
6357
6358
6359
 
# File 'gems/aws-sdk-odb/lib/aws-sdk-odb/client.rb', line 6356

def update_exadb_vm_cluster(params = {}, options = {})
  req = build_request(:update_exadb_vm_cluster, params)
  req.send_request(options)
end

#update_exascale_cloud_exadata_infrastructure(params = {}) ⇒ Types::UpdateExascaleCloudExadataInfrastructureOutput

Configures or updates the Exascale storage on an Exadata infrastructure. After you configure Exascale storage, you can create Exascale storage vaults on the infrastructure and VM clusters that use Exascale storage.

Examples:

Request syntax with placeholder values


resp = client.update_exascale_cloud_exadata_infrastructure({
  cloud_exadata_infrastructure_id: "ResourceIdOrArn", # required
  total_storage_size_in_g_bs: 1, # required
  total_vm_storage_size_in_g_bs: 1,
})

Response structure


resp.display_name #=> String
resp.status #=> String, one of "AVAILABLE", "FAILED", "PROVISIONING", "TERMINATED", "TERMINATING", "UPDATING", "MAINTENANCE_IN_PROGRESS"
resp.status_reason #=> String
resp.cloud_exadata_infrastructure_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :cloud_exadata_infrastructure_id (required, String) —

    The unique identifier or Amazon Resource Name (ARN) of the Exadata infrastructure to update.

  • :total_storage_size_in_g_bs (required, Integer) —

    The total amount of Exascale storage, in gigabytes (GB), to configure on the Exadata infrastructure.

  • :total_vm_storage_size_in_g_bs (Integer) —

    The total amount of Exascale storage, in gigabytes (GB), to allocate for VM storage on the Exadata infrastructure. VM clusters that store their VM file systems or VM backups in Exascale storage use this capacity.

Returns:

See Also:



6406
6407
6408
6409
 
# File 'gems/aws-sdk-odb/lib/aws-sdk-odb/client.rb', line 6406

def update_exascale_cloud_exadata_infrastructure(params = {}, options = {})
  req = build_request(:update_exascale_cloud_exadata_infrastructure, params)
  req.send_request(options)
end

#update_exascale_db_storage_vault(params = {}) ⇒ Types::UpdateExascaleDbStorageVaultOutput

Updates the specified Exascale storage vault.

Examples:

Request syntax with placeholder values


resp = client.update_exascale_db_storage_vault({
  exascale_db_storage_vault_id: "ResourceIdOrArn", # required
  additional_flash_cache_in_percent: 1,
  autoscale_limit_in_g_bs: 1,
  description: "UpdateExascaleDbStorageVaultInputDescriptionString",
  display_name: "ResourceDisplayName",
  high_capacity_database_storage_total_size_in_g_bs: 1,
  is_autoscale_enabled: false,
})

Response structure


resp.display_name #=> String
resp.status #=> String, one of "AVAILABLE", "FAILED", "PROVISIONING", "TERMINATED", "TERMINATING", "UPDATING", "MAINTENANCE_IN_PROGRESS"
resp.status_reason #=> String
resp.exascale_db_storage_vault_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :exascale_db_storage_vault_id (required, String) —

    The unique identifier of the Exascale storage vault to update.

  • :additional_flash_cache_in_percent (Integer) —

    The additional flash cache percentage for the Exascale storage vault.

  • :autoscale_limit_in_g_bs (Integer) —

    The autoscale limit in gigabytes (GB) for the Exascale storage vault.

  • :description (String) —

    A new description for the Exascale storage vault.

  • :display_name (String) —

    A new user-friendly name for the Exascale storage vault.

  • :high_capacity_database_storage_total_size_in_g_bs (Integer) —

    The total size of the high-capacity database storage, in gigabytes (GB), for the Exascale storage vault.

  • :is_autoscale_enabled (Boolean) —

    Specifies whether autoscaling is enabled for the Exascale storage vault.

Returns:

See Also:



6466
6467
6468
6469
 
# File 'gems/aws-sdk-odb/lib/aws-sdk-odb/client.rb', line 6466

def update_exascale_db_storage_vault(params = {}, options = {})
  req = build_request(:update_exascale_db_storage_vault, params)
  req.send_request(options)
end

#update_odb_network(params = {}) ⇒ Types::UpdateOdbNetworkOutput

Updates properties of a specified ODB network.

Examples:

Request syntax with placeholder values


resp = client.update_odb_network({
  odb_network_id: "ResourceIdOrArn", # required
  display_name: "ResourceDisplayName",
  peered_cidrs_to_be_added: ["String"],
  peered_cidrs_to_be_removed: ["String"],
  s3_access: "ENABLED", # accepts ENABLED, DISABLED
  zero_etl_access: "ENABLED", # accepts ENABLED, DISABLED
  sts_access: "ENABLED", # accepts ENABLED, DISABLED
  kms_access: "ENABLED", # accepts ENABLED, DISABLED
  s3_policy_document: "PolicyDocument",
  sts_policy_document: "PolicyDocument",
  kms_policy_document: "PolicyDocument",
  cross_region_s3_restore_sources_to_enable: ["String"],
  cross_region_s3_restore_sources_to_disable: ["String"],
})

Response structure


resp.display_name #=> String
resp.status #=> String, one of "AVAILABLE", "FAILED", "PROVISIONING", "TERMINATED", "TERMINATING", "UPDATING", "MAINTENANCE_IN_PROGRESS"
resp.status_reason #=> String
resp.odb_network_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :odb_network_id (required, String) —

    The unique identifier of the ODB network to update.

  • :display_name (String) —

    The new user-friendly name of the ODB network.

  • :peered_cidrs_to_be_added (Array<String>) —

    The list of CIDR ranges from the peered VPC that allow access to the ODB network.

  • :peered_cidrs_to_be_removed (Array<String>) —

    The list of CIDR ranges from the peered VPC to remove from the ODB network.

  • :s3_access (String) —

    Specifies the updated configuration for Amazon S3 access from the ODB network.

  • :zero_etl_access (String) —

    Specifies the updated configuration for Zero-ETL access from the ODB network.

  • :sts_access (String) —

    The Amazon Web Services Security Token Service (STS) access configuration for the ODB network.

  • :kms_access (String) —

    The Amazon Web Services Key Management Service (KMS) access configuration for the ODB network.

  • :s3_policy_document (String) —

    Specifies the updated endpoint policy for Amazon S3 access from the ODB network.

  • :sts_policy_document (String) —

    The Amazon Web Services Security Token Service (STS) policy document that defines permissions for token service usage within the ODB network.

  • :kms_policy_document (String) —

    The Amazon Web Services Key Management Service (KMS) policy document that defines permissions for key usage within the ODB network.

  • :cross_region_s3_restore_sources_to_enable (Array<String>) —

    The cross-Region Amazon S3 restore sources to enable for the ODB network.

  • :cross_region_s3_restore_sources_to_disable (Array<String>) —

    The cross-Region Amazon S3 restore sources to disable for the ODB network.

Returns:

See Also:



6560
6561
6562
6563
 
# File 'gems/aws-sdk-odb/lib/aws-sdk-odb/client.rb', line 6560

def update_odb_network(params = {}, options = {})
  req = build_request(:update_odb_network, params)
  req.send_request(options)
end

#update_odb_peering_connection(params = {}) ⇒ Types::UpdateOdbPeeringConnectionOutput

Modifies the settings of an Oracle Database@Amazon Web Services peering connection. You can update the display name and add or remove CIDR blocks from the peering connection.

Examples:

Request syntax with placeholder values


resp = client.update_odb_peering_connection({
  odb_peering_connection_id: "ResourceIdOrArn", # required
  display_name: "ResourceDisplayName",
  peer_network_cidrs_to_be_added: ["PeeredCidr"],
  peer_network_cidrs_to_be_removed: ["PeeredCidr"],
})

Response structure


resp.display_name #=> String
resp.status #=> String, one of "AVAILABLE", "FAILED", "PROVISIONING", "TERMINATED", "TERMINATING", "UPDATING", "MAINTENANCE_IN_PROGRESS"
resp.status_reason #=> String
resp.odb_peering_connection_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :odb_peering_connection_id (required, String) —

    The identifier of the Oracle Database@Amazon Web Services peering connection to update.

  • :display_name (String) —

    A new display name for the peering connection.

  • :peer_network_cidrs_to_be_added (Array<String>) —

    A list of CIDR blocks to add to the peering connection. These CIDR blocks define the IP address ranges that can communicate through the peering connection. The CIDR blocks must not overlap with existing CIDR blocks in the Oracle Database@Amazon Web Services network.

  • :peer_network_cidrs_to_be_removed (Array<String>) —

    A list of CIDR blocks to remove from the peering connection. The CIDR blocks must currently exist in the peering connection.

Returns:

See Also:



6613
6614
6615
6616
 
# File 'gems/aws-sdk-odb/lib/aws-sdk-odb/client.rb', line 6613

def update_odb_peering_connection(params = {}, options = {})
  req = build_request(:update_odb_peering_connection, params)
  req.send_request(options)
end