exadb_vm_clusters
Creates, updates, deletes, gets or lists an exadb_vm_clusters resource.
Overview
| Name | exadb_vm_clusters |
| Type | Resource |
| Id | aws.odb.exadb_vm_clusters |
Fields
The following fields are returned by SELECT queries:
- get_exadb_vm_cluster
- list_exadb_vm_clusters
| Name | Datatype | Description |
|---|---|---|
cluster_name | string | The name of the Grid Infrastructure (GI) cluster. (pattern: <code>[a-zA-Z][a-zA-Z0-9-]*</code>) |
created_at | string (date-time) | The date and time when the Exascale VM cluster was created. |
data_collection_options | object | The set of diagnostic collection options enabled for the Exascale VM cluster. |
display_name | string | The user-friendly name for the Exascale VM cluster. (pattern: <code>[a-zA-Z_](?!.--)[a-zA-Z0-9_-]</code>) |
domain | string | The domain of the Exascale VM cluster. |
enabled_ecpu_count | integer | The number of elastic compute processing units (ECPUs) enabled on the Exascale VM cluster. |
exadb_vm_cluster_arn | string | The 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_id | string | The 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_ |
exascale_db_storage_vault_arn | string | The 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_id | string | The 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_ |
gi_version | string | The software version of the Oracle Grid Infrastructure (GI) for the Exascale VM cluster. |
grid_image_id | string | The Grid Infrastructure software image ID for the Exascale VM cluster. |
grid_image_type | string | The type of Grid Infrastructure image for the Exascale VM cluster. (RELEASE_UPDATE, CUSTOM_IMAGE) |
hostname | string | The host name for the Exascale VM cluster. (pattern: <code>[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]</code>) |
iam_roles | array | The Amazon Web Services Identity and Access Management (IAM) service roles associated with the Exascale VM cluster. |
iorm_config_cache | object | The I/O Resource Management (IORM) configuration cache details for the Exascale VM cluster. |
last_update_history_entry_id | string | The Oracle Cloud ID (OCID) of the last maintenance update history entry. |
license_model | string | The Oracle license model applied to the Exascale VM cluster. (BRING_YOUR_OWN_LICENSE, LICENSE_INCLUDED) |
listener_port | integer | The port number configured for the listener on the Exascale VM cluster. |
memory_size_in_gbs | integer | The amount of memory, in gigabytes (GB), that's allocated for the Exascale VM cluster. |
node_count | integer | The number of nodes in the Exascale VM cluster. |
oci_resource_anchor_name | string | The name of the OCI resource anchor for the Exascale VM cluster. |
oci_url | string | The HTTPS link to the Exascale VM cluster in Oracle Cloud Infrastructure (OCI). |
ocid | string | The OCID of the Exascale VM cluster. |
odb_network_arn | string | The 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_id | string | The 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_ |
percent_progress | number (float) | The amount of progress made on the current operation on the Exascale VM cluster, expressed as a percentage. |
scan_dns_name | string | The 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_id | string | The OCID of the DNS record for the SCAN IP addresses that are associated with the Exascale VM cluster. |
scan_ip_ids | array | The OCID of the SCAN IP addresses that are associated with the Exascale VM cluster. |
scan_listener_port_tcp | integer | The port number for TCP connections to the single client access name (SCAN) listener for the Exascale VM cluster. |
scan_listener_port_tcp_ssl | integer | The port number for TCP connections with SSL to the single client access name (SCAN) listener for the Exascale VM cluster. |
shape | string | The hardware model name of the Exadata infrastructure that's running the Exascale VM cluster. |
shape_attribute | string | The shape attribute for the Exascale VM cluster. (SMART_STORAGE, BLOCK_STORAGE) |
snapshot_file_system_storage | object | The snapshot file system storage details for the Exascale VM cluster. |
ssh_public_keys | array | The public key portion of one or more key pairs used for SSH access to the Exascale VM cluster. |
status | string | The current status of the Exascale VM cluster. (AVAILABLE, FAILED, PROVISIONING, TERMINATED, TERMINATING, UPDATING, MAINTENANCE_IN_PROGRESS) |
status_reason | string | Additional information about the status of the Exascale VM cluster. |
system_version | string | The operating system version of the image chosen for the Exascale VM cluster. |
time_zone | string | The time zone of the Exascale VM cluster. |
total_ecpu_count | integer | The total number of ECPUs for the Exascale VM cluster. |
total_file_system_storage | object | The total file system storage details for the Exascale VM cluster. |
vip_ids | array | The 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_storage | object | The VM file system storage details for the Exascale VM cluster. |
| Name | Datatype | Description |
|---|---|---|
cluster_name | string | The name of the Grid Infrastructure (GI) cluster. (pattern: <code>[a-zA-Z][a-zA-Z0-9-]*</code>) |
created_at | string (date-time) | The date and time when the Exascale VM cluster was created. |
data_collection_options | object | Information about the data collection options enabled for a VM cluster. |
display_name | string | The user-friendly name for the Exascale VM cluster. (pattern: <code>[a-zA-Z_](?!.--)[a-zA-Z0-9_-]</code>) |
domain | string | The domain of the Exascale VM cluster. |
enabled_ecpu_count | integer | The number of elastic compute processing units (ECPUs) enabled on the Exascale VM cluster. |
exadb_vm_cluster_arn | string | The 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_id | string | The 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_ |
exascale_db_storage_vault_arn | string | The 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_id | string | The 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_ |
gi_version | string | The software version of the Oracle Grid Infrastructure (GI) for the Exascale VM cluster. |
grid_image_id | string | The Grid Infrastructure software image ID for the Exascale VM cluster. |
grid_image_type | string | The type of Grid Infrastructure image for the Exascale VM cluster. (RELEASE_UPDATE, CUSTOM_IMAGE) |
hostname | string | The host name for the Exascale VM cluster. (pattern: <code>[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]</code>) |
iam_roles | array | The Amazon Web Services Identity and Access Management (IAM) service roles associated with the Exascale VM cluster. |
iorm_config_cache | object | The IORM settings of the Exadata DB system. |
last_update_history_entry_id | string | The Oracle Cloud ID (OCID) of the last maintenance update history entry. |
license_model | string | The Oracle license model applied to the Exascale VM cluster. (BRING_YOUR_OWN_LICENSE, LICENSE_INCLUDED) |
listener_port | integer | The port number configured for the listener on the Exascale VM cluster. |
memory_size_in_gbs | integer | The amount of memory, in gigabytes (GB), that's allocated for the Exascale VM cluster. |
node_count | integer | The number of nodes in the Exascale VM cluster. |
oci_resource_anchor_name | string | The name of the OCI resource anchor for the Exascale VM cluster. |
oci_url | string | The HTTPS link to the Exascale VM cluster in Oracle Cloud Infrastructure (OCI). |
ocid | string | The OCID of the Exascale VM cluster. |
odb_network_arn | string | The 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_id | string | The 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_ |
percent_progress | number (float) | The amount of progress made on the current operation on the Exascale VM cluster, expressed as a percentage. |
scan_dns_name | string | The 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_id | string | The OCID of the DNS record for the SCAN IP addresses that are associated with the Exascale VM cluster. |
scan_ip_ids | array | The OCID of the SCAN IP addresses that are associated with the Exascale VM cluster. |
scan_listener_port_tcp | integer | The port number for TCP connections to the single client access name (SCAN) listener for the Exascale VM cluster. |
scan_listener_port_tcp_ssl | integer | The port number for TCP connections with SSL to the single client access name (SCAN) listener for the Exascale VM cluster. |
shape | string | The hardware model name of the Exadata infrastructure that's running the Exascale VM cluster. |
shape_attribute | string | The shape attribute for the Exascale VM cluster. (SMART_STORAGE, BLOCK_STORAGE) |
snapshot_file_system_storage | object | The snapshot file system storage details for the Exascale VM cluster. |
ssh_public_keys | array | The public key portion of one or more key pairs used for SSH access to the Exascale VM cluster. |
status | string | The current status of the Exascale VM cluster. (AVAILABLE, FAILED, PROVISIONING, TERMINATED, TERMINATING, UPDATING, MAINTENANCE_IN_PROGRESS) |
status_reason | string | Additional information about the status of the Exascale VM cluster. |
system_version | string | The operating system version of the image chosen for the Exascale VM cluster. |
time_zone | string | The time zone of the Exascale VM cluster. |
total_ecpu_count | integer | The total number of ECPUs for the Exascale VM cluster. |
total_file_system_storage | object | The total file system storage details for the Exascale VM cluster. |
vip_ids | array | The 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_storage | object | The VM file system storage details for the Exascale VM cluster. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_exadb_vm_cluster | select | region | Returns information about the specified Exascale VM cluster. | |
list_exadb_vm_clusters | select | region | Returns information about the Exascale VM clusters owned by your Amazon Web Services account. | |
create_exadb_vm_cluster | insert | region, displayName, enabledEcpuCount, exascaleDbStorageVaultId, gridImageId, hostname, nodeCount, odbNetworkId, shape, sshPublicKeys, totalEcpuCount, vmFileSystemStorageTotalSizeInGBs | Creates an Exascale VM cluster. | |
associate_virtual_machines_to_exadb_vm_cluster | update | region, exadbVmClusterId, desiredNodeCount | Adds virtual machines to the specified Exascale VM cluster. | |
disassociate_virtual_machines_from_exadb_vm_cluster | update | region, exadbVmClusterId, dbNodeIds | Removes virtual machines from the specified Exascale VM cluster. | |
update_exadb_vm_cluster | update | region, exadbVmClusterId | Updates the specified Exascale VM cluster. | |
delete_exadb_vm_cluster | delete | region | Deletes 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.
| Name | Datatype | Description |
|---|---|---|
region | string | AWS region (default: us-east-1) |
SELECT examples
- get_exadb_vm_cluster
- list_exadb_vm_clusters
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
;
Returns information about the Exascale VM clusters owned by your Amazon Web Services account.
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
- create_exadb_vm_cluster
- Manifest
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
;
# Description fields are for documentation purposes
- name: exadb_vm_clusters
props:
- name: region
value: "{{ region }}"
description: Required parameter for the exadb_vm_clusters resource.
- name: displayName
value: "{{ displayName }}"
description: |
A user-friendly name for the Exascale VM cluster.
- name: enabledEcpuCount
value: {{ enabledEcpuCount }}
description: |
The number of ECPUs to enable for the Exascale VM cluster.
- name: exascaleDbStorageVaultId
value: "{{ exascaleDbStorageVaultId }}"
description: |
The unique identifier of the Exascale storage vault for this Exascale VM cluster.
- name: gridImageId
value: "{{ gridImageId }}"
description: |
The Grid Infrastructure software image ID for the Exascale VM cluster.
- name: hostname
value: "{{ hostname }}"
description: |
The host name for the Exascale VM cluster.
- name: nodeCount
value: {{ nodeCount }}
description: |
The number of nodes in the Exascale VM cluster.
- name: odbNetworkId
value: "{{ odbNetworkId }}"
description: |
The unique identifier of the ODB network for the Exascale VM cluster.
- name: shape
value: "{{ shape }}"
description: |
The shape of the Exascale VM cluster.
- name: sshPublicKeys
value:
- "{{ sshPublicKeys }}"
description: |
The public key portion of one or more key pairs used for SSH access to the Exascale VM cluster.
- name: totalEcpuCount
value: {{ totalEcpuCount }}
description: |
The total number of ECPUs for the Exascale VM cluster.
- name: vmFileSystemStorageTotalSizeInGBs
value: {{ vmFileSystemStorageTotalSizeInGBs }}
description: |
The total amount of file system storage, in gigabytes (GB), for the Exascale VM cluster.
- name: clusterName
value: "{{ clusterName }}"
description: |
A name for the Grid Infrastructure cluster. The name isn't case sensitive.
- name: dataCollectionOptions
description: |
The set of preferences for the various diagnostic collection options for the Exascale VM cluster.
value:
isDiagnosticsEventsEnabled: {{ isDiagnosticsEventsEnabled }}
isHealthMonitoringEnabled: {{ isHealthMonitoringEnabled }}
isIncidentLogsEnabled: {{ isIncidentLogsEnabled }}
- name: licenseModel
value: "{{ licenseModel }}"
description: |
The Oracle license model to apply to the Exascale VM cluster.
valid_values: ['BRING_YOUR_OWN_LICENSE', 'LICENSE_INCLUDED']
- name: scanListenerPortTcp
value: {{ scanListenerPortTcp }}
description: |
The port number for TCP connections to the single client access name (SCAN) listener.
- name: scanListenerPortTcpSsl
value: {{ scanListenerPortTcpSsl }}
description: |
The port number for TCP connections with SSL to the single client access name (SCAN) listener.
- name: shapeAttribute
value: "{{ shapeAttribute }}"
description: |
The shape attribute for the Exascale VM cluster.
valid_values: ['SMART_STORAGE', 'BLOCK_STORAGE']
- name: systemVersion
value: "{{ systemVersion }}"
description: |
The version of the operating system of the image for the Exascale VM cluster.
- name: tags
value: "{{ tags }}"
description: |
The list of resource tags to apply to the Exascale VM cluster.
- name: timeZone
value: "{{ timeZone }}"
description: |
The time zone for the Exascale VM cluster.
- name: clientToken
value: "{{ clientToken }}"
description: |
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 one and uses it for the request to ensure idempotency. The client token is valid for up to 24 hours after it's first used.
UPDATE examples
- associate_virtual_machines_to_exadb_vm_cluster
- disassociate_virtual_machines_from_exadb_vm_cluster
- update_exadb_vm_cluster
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;
Removes virtual machines from the specified Exascale VM cluster.
UPDATE aws.odb.exadb_vm_clusters
SET
exadbVmClusterId = '{{ exadbVmClusterId }}',
dbNodeIds = '{{ dbNodeIds }}'
WHERE
region = '{{ region }}' --required
AND exadbVmClusterId = '{{ exadbVmClusterId }}' --required
AND dbNodeIds = '{{ dbNodeIds }}' --required
RETURNING
display_name,
exadb_vm_cluster_id,
status,
status_reason;
Updates the specified Exascale VM cluster.
UPDATE aws.odb.exadb_vm_clusters
SET
exadbVmClusterId = '{{ exadbVmClusterId }}',
dataCollectionOptions = '{{ dataCollectionOptions }}',
displayName = '{{ displayName }}',
enabledEcpuCount = {{ enabledEcpuCount }},
gridImageId = '{{ gridImageId }}',
licenseModel = '{{ licenseModel }}',
sshPublicKeys = '{{ sshPublicKeys }}',
systemVersion = '{{ systemVersion }}',
totalEcpuCount = {{ totalEcpuCount }},
updateAction = '{{ updateAction }}',
vmFileSystemStorageTotalSizeInGBs = {{ vmFileSystemStorageTotalSizeInGBs }}
WHERE
region = '{{ region }}' --required
AND exadbVmClusterId = '{{ exadbVmClusterId }}' --required
RETURNING
display_name,
exadb_vm_cluster_id,
status,
status_reason;
DELETE examples
- delete_exadb_vm_cluster
Deletes the specified Exascale VM cluster.
DELETE FROM aws.odb.exadb_vm_clusters
WHERE region = '{{ region }}' --required
;