db_nodes

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

Overview

Name	db_nodes
Type	Resource
Id	aws.odb.db_nodes

Fields

The following fields are returned by SELECT queries:

get_db_node

Name	Datatype	Description
additional_details	string	Additional information about the planned maintenance.
backup_ip_id	string	The Oracle Cloud ID (OCID) of the backup IP address that's associated with the DB node.
backup_vnic_2_id	string	The OCID of the second backup VNIC.
backup_vnic_id	string	The OCID of the backup VNIC.
cpu_core_count	integer	Number of CPU cores enabled on the DB node.
created_at	string (date-time)	The date and time when the DB node was created.
db_node_arn	string	The Amazon Resource Name (ARN) of the DB node. (pattern: <code>arn:(?:aws|aws-cn|aws-us-gov|aws-iso-{0,1}[a-z]{0,1}):[a-z0-9-]+:[a-z0-9-]*:[0-9]+:[a-z0-9-]+/[a-z0-9-_]{6,64}</code>)
db_node_id	string	The unique identifier of the DB node. (pattern: <code>[a-zA-Z0-9_~.-]+</code>)
db_node_storage_size_in_gbs	integer	The amount of local node storage, in gigabytes (GB), that's allocated on the DB node.
db_server_id	string	The unique identifier of the Db server that is associated with the DB node. (pattern: <code>[a-zA-Z0-9_~.-]+</code>)
db_system_id	string	The OCID of the DB system.
fault_domain	string	The name of the fault domain the instance is contained in.
floating_ip_address	string	The floating IP address assigned to the DB node.
host_ip_id	string	The OCID of the host IP address that's associated with the DB node.
hostname	string	The host name for the DB node.
maintenance_type	string	The type of database node maintenance. Either VMDB_REBOOT_MIGRATION or EXADBXS_REBOOT_MIGRATION. (VMDB_REBOOT_MIGRATION)
memory_size_in_gbs	integer	The allocated memory in GBs on the DB node.
oci_resource_anchor_name	string	The name of the OCI resource anchor for the DB node.
ocid	string	The OCID of the DB node.
private_ip_address	string	The private IP address assigned to the DB node.
software_storage_size_in_gb	integer	The size (in GB) of the block storage volume allocation for the DB system.
status	string	The current status of the DB node. (AVAILABLE, FAILED, PROVISIONING, TERMINATED, TERMINATING, UPDATING, STOPPING, STOPPED, STARTING)
status_reason	string	Additional information about the status of the DB node.
time_maintenance_window_end	string	End date and time of maintenance window.
time_maintenance_window_start	string	Start date and time of maintenance window.
total_cpu_core_count	integer	The total number of CPU cores reserved on the DB node.
vnic_2_id	string	The OCID of the second VNIC.
vnic_id	string	The OCID of the VNIC.

list_db_nodes

Name	Datatype	Description
additional_details	string	Additional information about the planned maintenance.
backup_ip_id	string	The Oracle Cloud ID (OCID) of the backup IP address that's associated with the DB node.
backup_vnic_2_id	string	The OCID of the second backup virtual network interface card (VNIC) for the DB node.
backup_vnic_id	string	The OCID of the backup VNIC for the DB node.
cpu_core_count	integer	The number of CPU cores enabled on the DB node.
created_at	string (date-time)	The date and time when the DB node was created.
db_node_arn	string	The Amazon Resource Name (ARN) of the DB node. (pattern: <code>arn:(?:aws|aws-cn|aws-us-gov|aws-iso-{0,1}[a-z]{0,1}):[a-z0-9-]+:[a-z0-9-]*:[0-9]+:[a-z0-9-]+/[a-z0-9-_]{6,64}</code>)
db_node_id	string	The unique identifier of the DB node. (pattern: <code>[a-zA-Z0-9_~.-]+</code>)
db_node_storage_size_in_gbs	integer	The amount of local node storage, in gigabytes (GB), that's allocated on the DB node.
db_server_id	string	The unique identifier of the database server that's associated with the DB node. (pattern: <code>[a-zA-Z0-9_~.-]+</code>)
db_system_id	string	The OCID of the DB system.
fault_domain	string	The name of the fault domain where the DB node is located.
host_ip_id	string	The OCID of the host IP address that's associated with the DB node.
hostname	string	The host name for the DB node.
maintenance_type	string	The type of maintenance the DB node. (VMDB_REBOOT_MIGRATION)
memory_size_in_gbs	integer	The amount of memory, in gigabytes (GB), that allocated on the DB node.
oci_resource_anchor_name	string	The name of the OCI resource anchor for the DB node.
ocid	string	The OCID of the DB node.
software_storage_size_in_gb	integer	The size of the block storage volume, in gigabytes (GB), that's allocated for the DB system. This attribute applies only for virtual machine DB systems.
status	string	The current status of the DB node. (AVAILABLE, FAILED, PROVISIONING, TERMINATED, TERMINATING, UPDATING, STOPPING, STOPPED, STARTING)
status_reason	string	Additional information about the status of the DB node.
time_maintenance_window_end	string	The end date and time of the maintenance window.
time_maintenance_window_start	string	The start date and time of the maintenance window.
total_cpu_core_count	integer	The total number of CPU cores reserved on the DB node.
vnic_2_id	string	The OCID of the second VNIC.
vnic_id	string	The OCID of the VNIC.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_db_node	select	region		Returns information about the specified DB node.
list_db_nodes	select	region		Returns information about the DB nodes for the specified VM cluster.

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_node

Returns information about the specified DB node.

SELECT
additional_details,
backup_ip_id,
backup_vnic_2_id,
backup_vnic_id,
cpu_core_count,
created_at,
db_node_arn,
db_node_id,
db_node_storage_size_in_gbs,
db_server_id,
db_system_id,
fault_domain,
floating_ip_address,
host_ip_id,
hostname,
maintenance_type,
memory_size_in_gbs,
oci_resource_anchor_name,
ocid,
private_ip_address,
software_storage_size_in_gb,
status,
status_reason,
time_maintenance_window_end,
time_maintenance_window_start,
total_cpu_core_count,
vnic_2_id,
vnic_id
FROM aws.odb.db_nodes
WHERE region = '{{ region }}' -- required
;

list_db_nodes

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

SELECT
additional_details,
backup_ip_id,
backup_vnic_2_id,
backup_vnic_id,
cpu_core_count,
created_at,
db_node_arn,
db_node_id,
db_node_storage_size_in_gbs,
db_server_id,
db_system_id,
fault_domain,
host_ip_id,
hostname,
maintenance_type,
memory_size_in_gbs,
oci_resource_anchor_name,
ocid,
software_storage_size_in_gb,
status,
status_reason,
time_maintenance_window_end,
time_maintenance_window_start,
total_cpu_core_count,
vnic_2_id,
vnic_id
FROM aws.odb.db_nodes
WHERE region = '{{ region }}' -- required
;