Skip to main content

exadb_vm_clusters

Creates, updates, deletes, gets or lists an exadb_vm_clusters resource.

Overview

Nameexadb_vm_clusters
TypeResource
Idaws.odb.exadb_vm_clusters

Fields

The following fields are returned by SELECT queries:

NameDatatypeDescription
cluster_namestringThe name of the Grid Infrastructure (GI) cluster. (pattern: <code>[a-zA-Z][a-zA-Z0-9-]*</code>)
created_atstring (date-time)The date and time when the Exascale VM cluster was created.
data_collection_optionsobjectThe set of diagnostic collection options enabled for the Exascale VM cluster.
display_namestringThe user-friendly name for the Exascale VM cluster. (pattern: <code>[a-zA-Z_](?!.--)[a-zA-Z0-9_-]</code>)
domainstringThe domain of the Exascale VM cluster.
enabled_ecpu_countintegerThe number of elastic compute processing units (ECPUs) enabled on the Exascale VM cluster.
exadb_vm_cluster_arnstringThe Amazon Resource Name (ARN) of the Exascale VM cluster. (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>)
exadb_vm_cluster_idstringThe unique identifier of the Exascale VM cluster. (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-zA-Z0-9_.-]{6,64}|[a-zA-Z0-9_.-]{6,64})</code>)
exascale_db_storage_vault_arnstringThe Amazon Resource Name (ARN) of the Exascale storage vault associated with this Exascale VM cluster. (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>)
exascale_db_storage_vault_idstringThe unique identifier of the Exascale storage vault associated with this Exascale VM cluster. (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-zA-Z0-9_.-]{6,64}|[a-zA-Z0-9_.-]{6,64})</code>)
gi_versionstringThe software version of the Oracle Grid Infrastructure (GI) for the Exascale VM cluster.
grid_image_idstringThe Grid Infrastructure software image ID for the Exascale VM cluster.
grid_image_typestringThe type of Grid Infrastructure image for the Exascale VM cluster. (RELEASE_UPDATE, CUSTOM_IMAGE)
hostnamestringThe host name for the Exascale VM cluster. (pattern: <code>[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]</code>)
iam_rolesarrayThe Amazon Web Services Identity and Access Management (IAM) service roles associated with the Exascale VM cluster.
iorm_config_cacheobjectThe I/O Resource Management (IORM) configuration cache details for the Exascale VM cluster.
last_update_history_entry_idstringThe Oracle Cloud ID (OCID) of the last maintenance update history entry.
license_modelstringThe Oracle license model applied to the Exascale VM cluster. (BRING_YOUR_OWN_LICENSE, LICENSE_INCLUDED)
listener_portintegerThe port number configured for the listener on the Exascale VM cluster.
memory_size_in_gbsintegerThe amount of memory, in gigabytes (GB), that's allocated for the Exascale VM cluster.
node_countintegerThe number of nodes in the Exascale VM cluster.
oci_resource_anchor_namestringThe name of the OCI resource anchor for the Exascale VM cluster.
oci_urlstringThe HTTPS link to the Exascale VM cluster in Oracle Cloud Infrastructure (OCI).
ocidstringThe OCID of the Exascale VM cluster.
odb_network_arnstringThe Amazon Resource Name (ARN) of the ODB network associated with this Exascale VM cluster. (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>)
odb_network_idstringThe unique identifier of the ODB network for the Exascale VM cluster. (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-zA-Z0-9_.-]{6,64}|[a-zA-Z0-9_.-]{6,64})</code>)
percent_progressnumber (float)The amount of progress made on the current operation on the Exascale VM cluster, expressed as a percentage.
scan_dns_namestringThe fully qualified domain name (FQDN) of the DNS record for the Single Client Access Name (SCAN) IP addresses that are associated with the Exascale VM cluster.
scan_dns_record_idstringThe OCID of the DNS record for the SCAN IP addresses that are associated with the Exascale VM cluster.
scan_ip_idsarrayThe OCID of the SCAN IP addresses that are associated with the Exascale VM cluster.
scan_listener_port_tcpintegerThe port number for TCP connections to the single client access name (SCAN) listener for the Exascale VM cluster.
scan_listener_port_tcp_sslintegerThe port number for TCP connections with SSL to the single client access name (SCAN) listener for the Exascale VM cluster.
shapestringThe hardware model name of the Exadata infrastructure that's running the Exascale VM cluster.
shape_attributestringThe shape attribute for the Exascale VM cluster. (SMART_STORAGE, BLOCK_STORAGE)
snapshot_file_system_storageobjectThe snapshot file system storage details for the Exascale VM cluster.
ssh_public_keysarrayThe public key portion of one or more key pairs used for SSH access to the Exascale VM cluster.
statusstringThe current status of the Exascale VM cluster. (AVAILABLE, FAILED, PROVISIONING, TERMINATED, TERMINATING, UPDATING, MAINTENANCE_IN_PROGRESS)
status_reasonstringAdditional information about the status of the Exascale VM cluster.
system_versionstringThe operating system version of the image chosen for the Exascale VM cluster.
time_zonestringThe time zone of the Exascale VM cluster.
total_ecpu_countintegerThe total number of ECPUs for the Exascale VM cluster.
total_file_system_storageobjectThe total file system storage details for the Exascale VM cluster.
vip_idsarrayThe virtual IP (VIP) addresses associated with the Exascale VM cluster. One VIP address is assigned per node to support failover. If a node fails, its VIP is reassigned to another active node in the cluster.
vm_file_system_storageobjectThe VM file system storage details for the Exascale VM cluster.

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
get_exadb_vm_clusterselectregionReturns information about the specified Exascale VM cluster.
list_exadb_vm_clustersselectregionReturns information about the Exascale VM clusters owned by your Amazon Web Services account.
create_exadb_vm_clusterinsertregion, displayName, enabledEcpuCount, exascaleDbStorageVaultId, gridImageId, hostname, nodeCount, odbNetworkId, shape, sshPublicKeys, totalEcpuCount, vmFileSystemStorageTotalSizeInGBsCreates an Exascale VM cluster.
associate_virtual_machines_to_exadb_vm_clusterupdateregion, exadbVmClusterId, desiredNodeCountAdds virtual machines to the specified Exascale VM cluster.
disassociate_virtual_machines_from_exadb_vm_clusterupdateregion, exadbVmClusterId, dbNodeIdsRemoves virtual machines from the specified Exascale VM cluster.
update_exadb_vm_clusterupdateregion, exadbVmClusterIdUpdates the specified Exascale VM cluster.
delete_exadb_vm_clusterdeleteregionDeletes the specified Exascale 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.

NameDatatypeDescription
regionstringAWS region (default: us-east-1)

SELECT examples

Returns information about the specified Exascale VM cluster.

SELECT
cluster_name,
created_at,
data_collection_options,
display_name,
domain,
enabled_ecpu_count,
exadb_vm_cluster_arn,
exadb_vm_cluster_id,
exascale_db_storage_vault_arn,
exascale_db_storage_vault_id,
gi_version,
grid_image_id,
grid_image_type,
hostname,
iam_roles,
iorm_config_cache,
last_update_history_entry_id,
license_model,
listener_port,
memory_size_in_gbs,
node_count,
oci_resource_anchor_name,
oci_url,
ocid,
odb_network_arn,
odb_network_id,
percent_progress,
scan_dns_name,
scan_dns_record_id,
scan_ip_ids,
scan_listener_port_tcp,
scan_listener_port_tcp_ssl,
shape,
shape_attribute,
snapshot_file_system_storage,
ssh_public_keys,
status,
status_reason,
system_version,
time_zone,
total_ecpu_count,
total_file_system_storage,
vip_ids,
vm_file_system_storage
FROM aws.odb.exadb_vm_clusters
WHERE region = '{{ region }}' -- required
;

INSERT examples

Creates an Exascale VM cluster.

INSERT INTO aws.odb.exadb_vm_clusters (
displayName,
enabledEcpuCount,
exascaleDbStorageVaultId,
gridImageId,
hostname,
nodeCount,
odbNetworkId,
shape,
sshPublicKeys,
totalEcpuCount,
vmFileSystemStorageTotalSizeInGBs,
clusterName,
dataCollectionOptions,
licenseModel,
scanListenerPortTcp,
scanListenerPortTcpSsl,
shapeAttribute,
systemVersion,
tags,
timeZone,
clientToken,
region
)
SELECT
'{{ displayName }}' /* required */,
{{ enabledEcpuCount }} /* required */,
'{{ exascaleDbStorageVaultId }}' /* required */,
'{{ gridImageId }}' /* required */,
'{{ hostname }}' /* required */,
{{ nodeCount }} /* required */,
'{{ odbNetworkId }}' /* required */,
'{{ shape }}' /* required */,
'{{ sshPublicKeys }}' /* required */,
{{ totalEcpuCount }} /* required */,
{{ vmFileSystemStorageTotalSizeInGBs }} /* required */,
'{{ clusterName }}',
'{{ dataCollectionOptions }}',
'{{ licenseModel }}',
{{ scanListenerPortTcp }},
{{ scanListenerPortTcpSsl }},
'{{ shapeAttribute }}',
'{{ systemVersion }}',
'{{ tags }}',
'{{ timeZone }}',
'{{ clientToken }}',
'{{ region }}'
RETURNING
display_name,
exadb_vm_cluster_id,
status,
status_reason
;

UPDATE examples

Adds virtual machines to the specified Exascale VM cluster.

UPDATE aws.odb.exadb_vm_clusters
SET
exadbVmClusterId = '{{ exadbVmClusterId }}',
desiredNodeCount = {{ desiredNodeCount }}
WHERE
region = '{{ region }}' --required
AND exadbVmClusterId = '{{ exadbVmClusterId }}' --required
AND desiredNodeCount = '{{ desiredNodeCount }}' --required
RETURNING
display_name,
exadb_vm_cluster_id,
status,
status_reason;

DELETE examples

Deletes the specified Exascale VM cluster.

DELETE FROM aws.odb.exadb_vm_clusters
WHERE region = '{{ region }}' --required
;