db_servers

Creates, updates, deletes, gets or lists a db_servers resource.

Overview

Name	db_servers
Type	Resource
Id	aws.odb.db_servers

Fields

The following fields are returned by SELECT queries:

get_db_server

Name	Datatype	Description
autonomous_virtual_machine_ids	array	The list of unique identifiers for the Autonomous VMs associated with this database server.
autonomous_vm_cluster_ids	array	The list of identifiers for the Autonomous VM clusters associated with this database server.
compute_model	string	The compute model of the database server (ECPU or OCPU). (ECPU, OCPU)
cpu_core_count	integer	The number of CPU cores enabled on the database server.
created_at	string (date-time)	The date and time when the database server was created.
db_node_storage_size_in_gbs	integer	The allocated local node storage in GBs on the database server.
db_server_id	string	The unique identifier for the database server. (pattern: <code>[a-zA-Z0-9_~.-]+</code>)
db_server_patching_details	object	The scheduling details for the quarterly maintenance window. Patching and system updates take place during the maintenance window.
display_name	string	The user-friendly name of the database server.
exadata_infrastructure_id	string	The ID of the Exadata infrastructure the database server belongs to.
max_cpu_count	integer	The total number of CPU cores available.
max_db_node_storage_in_gbs	integer	The total local node storage available in GBs.
max_memory_in_gbs	integer	The total memory available in GBs.
memory_size_in_gbs	integer	The allocated memory in GBs on the database server.
oci_resource_anchor_name	string	The name of the OCI resource anchor for the database server.
ocid	string	The OCID of the database server.
shape	string	The shape of the database server. The shape determines the amount of CPU, storage, and memory resources available.
status	string	The current status of the database server. (AVAILABLE, FAILED, PROVISIONING, TERMINATED, TERMINATING, UPDATING, MAINTENANCE_IN_PROGRESS)
status_reason	string	Additional information about the current status of the database server.
vm_cluster_ids	array	The OCID of the VM clusters that are associated with the database server.

list_db_servers

Name	Datatype	Description
autonomous_virtual_machine_ids	array	A list of unique identifiers for the Autonomous VMs.
autonomous_vm_cluster_ids	array	A list of identifiers for the Autonomous VM clusters.
compute_model	string	The OCI model compute model used when you create or clone an instance: ECPU or OCPU. An ECPU is an abstracted measure of compute resources. ECPUs are based on the number of cores elastically allocated from a pool of compute and storage servers. An OCPU is a legacy physical measure of compute resources. OCPUs are based on the physical core of a processor with hyper-threading enabled. (ECPU, OCPU)
cpu_core_count	integer	The number of CPU cores enabled on the database server.
created_at	string (date-time)	The date and time when the database server was created.
db_node_storage_size_in_gbs	integer	The amount of local node storage, in gigabytes (GB), that's allocated on the database server.
db_server_id	string	The unique identifier of the database server. (pattern: <code>[a-zA-Z0-9_~.-]+</code>)
db_server_patching_details	object	The scheduling details for the quarterly maintenance window. Patching and system updates take place during the maintenance window.
display_name	string	The user-friendly name of the database server. The name doesn't need to be unique.
exadata_infrastructure_id	string	The ID of the Exadata infrastructure that hosts the database server.
max_cpu_count	integer	The total number of CPU cores available on the database server.
max_db_node_storage_in_gbs	integer	The total amount of local node storage, in gigabytes (GB), that's available on the database server.
max_memory_in_gbs	integer	The total amount of memory, in gigabytes (GB), that's available on the database server.
memory_size_in_gbs	integer	The amount of memory, in gigabytes (GB), that's allocated on the database server.
oci_resource_anchor_name	string	The name of the OCI resource anchor for the database server.
ocid	string	The OCID of the database server.
shape	string	The hardware system model of the Exadata infrastructure that the database server is hosted on. The shape determines the amount of CPU, storage, and memory resources available.
status	string	The current status of the database server. (AVAILABLE, FAILED, PROVISIONING, TERMINATED, TERMINATING, UPDATING, MAINTENANCE_IN_PROGRESS)
status_reason	string	Additional information about the status of the database server.
vm_cluster_ids	array	The IDs of the VM clusters that are associated with the database server.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_db_server	select	region		Returns information about the specified database server.
list_db_servers	select	region		Returns information about the database servers that belong to the specified Exadata infrastructure.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

get_db_server

Returns information about the specified database server.

SELECT
autonomous_virtual_machine_ids,
autonomous_vm_cluster_ids,
compute_model,
cpu_core_count,
created_at,
db_node_storage_size_in_gbs,
db_server_id,
db_server_patching_details,
display_name,
exadata_infrastructure_id,
max_cpu_count,
max_db_node_storage_in_gbs,
max_memory_in_gbs,
memory_size_in_gbs,
oci_resource_anchor_name,
ocid,
shape,
status,
status_reason,
vm_cluster_ids
FROM aws.odb.db_servers
WHERE region = '{{ region }}' -- required
;

list_db_servers

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

SELECT
autonomous_virtual_machine_ids,
autonomous_vm_cluster_ids,
compute_model,
cpu_core_count,
created_at,
db_node_storage_size_in_gbs,
db_server_id,
db_server_patching_details,
display_name,
exadata_infrastructure_id,
max_cpu_count,
max_db_node_storage_in_gbs,
max_memory_in_gbs,
memory_size_in_gbs,
oci_resource_anchor_name,
ocid,
shape,
status,
status_reason,
vm_cluster_ids
FROM aws.odb.db_servers
WHERE region = '{{ region }}' -- required
;