cloud_autonomous_vm_clusters
Creates, updates, deletes, gets or lists a cloud_autonomous_vm_clusters resource.
Overview
| Name | cloud_autonomous_vm_clusters |
| Type | Resource |
| Id | aws.odb.cloud_autonomous_vm_clusters |
Fields
The following fields are returned by SELECT queries:
- get_cloud_autonomous_vm_cluster
- list_cloud_autonomous_vm_clusters
| Name | Datatype | Description |
|---|---|---|
autonomous_data_storage_percentage | number (float) | The percentage of data storage currently in use for Autonomous Databases in the Autonomous VM cluster. |
autonomous_data_storage_size_in_tbs | number (double) | The data storage size allocated for Autonomous Databases in the Autonomous VM cluster, in TB. |
available_autonomous_data_storage_size_in_tbs | number (double) | The available data storage space for Autonomous Databases in the Autonomous VM cluster, in TB. |
available_container_databases | integer | The number of Autonomous CDBs that you can create with the currently available storage. |
available_cpus | number (float) | The number of CPU cores available for allocation to Autonomous Databases. |
cloud_autonomous_vm_cluster_arn | string | The Amazon Resource Name (ARN) for the Autonomous VM cluster. |
cloud_autonomous_vm_cluster_id | string | The unique identifier of the Autonomous VM cluster. (pattern: <code>[a-zA-Z0-9_~.-]+</code>) |
cloud_exadata_infrastructure_arn | string | The Amazon Resource Name (ARN) of the Cloud Exadata Infrastructure containing this Autonomous 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>) |
cloud_exadata_infrastructure_id | string | The unique identifier of the Cloud Exadata Infrastructure containing this Autonomous 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_ |
compute_model | string | The compute model of the Autonomous VM cluster: ECPU or OCPU. (ECPU, OCPU) |
cpu_core_count | integer | The total number of CPU cores in the Autonomous VM cluster. |
cpu_core_count_per_node | integer | The number of CPU cores enabled per node in the Autonomous VM cluster. |
cpu_percentage | number (float) | The percentage of total CPU cores currently in use in the Autonomous VM cluster. |
created_at | string (date-time) | The date and time when the Autonomous VM cluster was created. |
data_storage_size_in_gbs | number (double) | The total data storage allocated to the Autonomous VM cluster, in GB. |
data_storage_size_in_tbs | number (double) | The total data storage allocated to the Autonomous VM cluster, in TB. |
db_node_storage_size_in_gbs | integer | The local node storage allocated to the Autonomous VM cluster, in gigabytes (GB). |
db_servers | array | The list of database servers associated with the Autonomous VM cluster. |
description | string | The user-provided description of the Autonomous VM cluster. |
display_name | string | The display name of the Autonomous VM cluster. (pattern: <code>[a-zA-Z_](?!.--)[a-zA-Z0-9_-]</code>) |
domain | string | The domain name for the Autonomous VM cluster. |
exadata_storage_in_t_bs_lowest_scaled_value | number (double) | The minimum value to which you can scale down the Exadata storage, in TB. |
hostname | string | The hostname for the Autonomous VM cluster. |
iam_roles | array | The Amazon Web Services Identity and Access Management (IAM) service roles associated with the Autonomous VM cluster. |
is_mtls_enabled_vm_cluster | boolean | Indicates whether mutual TLS (mTLS) authentication is enabled for the Autonomous VM cluster. |
license_model | string | The Oracle license model that applies to the Autonomous VM cluster. (BRING_YOUR_OWN_LICENSE, LICENSE_INCLUDED) |
maintenance_window | object | The scheduling details for the maintenance window. Patching and system updates take place during the maintenance window. |
max_acds_lowest_scaled_value | integer | The minimum value to which you can scale down the maximum number of Autonomous CDBs. |
memory_per_oracle_compute_unit_in_gbs | integer | The amount of memory allocated per Oracle Compute Unit, in GB. |
memory_size_in_gbs | integer | The total amount of memory allocated to the Autonomous VM cluster, in gigabytes (GB). |
node_count | integer | The number of database server nodes in the Autonomous VM cluster. |
non_provisionable_autonomous_container_databases | integer | The number of Autonomous CDBs that can't be provisioned because of resource constraints. |
oci_resource_anchor_name | string | The name of the OCI resource anchor associated with this Autonomous VM cluster. |
oci_url | string | The URL for accessing the OCI console page for this Autonomous VM cluster. |
ocid | string | The Oracle Cloud Identifier (OCID) of the Autonomous VM cluster. |
odb_network_arn | string | The Amazon Resource Name (ARN) of the ODB network associated with this Autonomous 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 associated with this Autonomous 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 progress of the current operation on the Autonomous VM cluster, as a percentage. |
provisionable_autonomous_container_databases | integer | The number of Autonomous CDBs that can be provisioned in the Autonomous VM cluster. |
provisioned_autonomous_container_databases | integer | The number of Autonomous CDBs currently provisioned in the Autonomous VM cluster. |
provisioned_cpus | number (float) | The number of CPU cores currently provisioned in the Autonomous VM cluster. |
reclaimable_cpus | number (float) | The number of CPU cores that can be reclaimed from terminated or scaled-down Autonomous Databases. |
reserved_cpus | number (float) | The number of CPU cores reserved for system operations and redundancy. |
scan_listener_port_non_tls | integer | The SCAN listener port for non-TLS (TCP) protocol. The default is 1521. |
scan_listener_port_tls | integer | The SCAN listener port for TLS (TCP) protocol. The default is 2484. |
shape | string | The shape of the Exadata infrastructure for the Autonomous VM cluster. |
status | string | The current state of the Autonomous VM cluster. Possible values include CREATING, AVAILABLE, UPDATING, DELETING, DELETED, FAILED. (AVAILABLE, FAILED, PROVISIONING, TERMINATED, TERMINATING, UPDATING, MAINTENANCE_IN_PROGRESS) |
status_reason | string | Additional information about the current status of the Autonomous VM cluster. |
time_database_ssl_certificate_expires | string (date-time) | The expiration date and time of the database SSL certificate. |
time_ords_certificate_expires | string (date-time) | The expiration date and time of the Oracle REST Data Services (ORDS) certificate. |
time_zone | string | The time zone of the Autonomous VM cluster. |
total_container_databases | integer | The total number of Autonomous Container Databases that can be created with the allocated local storage. |
| Name | Datatype | Description |
|---|---|---|
autonomous_data_storage_percentage | number (float) | The percentage of data storage currently in use for Autonomous Databases in the Autonomous VM cluster. |
autonomous_data_storage_size_in_tbs | number (double) | The total data storage allocated for Autonomous Databases in the Autonomous VM cluster, in TB. |
available_autonomous_data_storage_size_in_tbs | number (double) | The available data storage for Autonomous Databases in the Autonomous VM cluster, in TB. |
available_container_databases | integer | The number of Autonomous Container Databases that you can create with the currently available storage. |
available_cpus | number (float) | The number of CPU cores available for allocation to Autonomous Databases. |
cloud_autonomous_vm_cluster_arn | string | The Amazon Resource Name (ARN) for the Autonomous VM cluster. |
cloud_autonomous_vm_cluster_id | string | The unique identifier of the Autonomous VM cluster. (pattern: <code>[a-zA-Z0-9_~.-]+</code>) |
cloud_exadata_infrastructure_arn | string | The Amazon Resource Name (ARN) of the Exadata infrastructure containing this Autonomous 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>) |
cloud_exadata_infrastructure_id | string | The unique identifier of the Exadata infrastructure containing this Autonomous 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_ |
compute_model | string | The compute model of the Autonomous VM cluster: ECPU or OCPU. (ECPU, OCPU) |
cpu_core_count | integer | The total number of CPU cores in the Autonomous VM cluster. |
cpu_core_count_per_node | integer | The number of CPU cores per node in the Autonomous VM cluster. |
cpu_percentage | number (float) | The percentage of total CPU cores currently in use in the Autonomous VM cluster. |
created_at | string (date-time) | The date and time when the Autonomous VM cluster was created. |
data_storage_size_in_gbs | number (double) | The total data storage allocated to the Autonomous VM cluster, in GB. |
data_storage_size_in_tbs | number (double) | The total data storage allocated to the Autonomous VM cluster, in TB. |
db_node_storage_size_in_gbs | integer | The local node storage allocated to the Autonomous VM cluster, in GB. |
db_servers | array | The list of database servers associated with the Autonomous VM cluster. |
description | string | The user-provided description of the Autonomous VM cluster. |
display_name | string | The user-friendly name for the Autonomous VM cluster. (pattern: <code>[a-zA-Z_](?!.--)[a-zA-Z0-9_-]</code>) |
domain | string | The domain name for the Autonomous VM cluster. |
exadata_storage_in_t_bs_lowest_scaled_value | number (double) | The lowest value to which Exadata storage can be scaled down, in TB. |
hostname | string | The host name for the Autonomous VM cluster. |
iam_roles | array | The Amazon Web Services Identity and Access Management (IAM) service roles associated with the Autonomous VM cluster in the summary information. |
is_mtls_enabled_vm_cluster | boolean | Indicates if mutual TLS (mTLS) authentication is enabled for the Autonomous VM cluster. |
license_model | string | The Oracle license model that applies to the Autonomous VM cluster. (BRING_YOUR_OWN_LICENSE, LICENSE_INCLUDED) |
maintenance_window | object | The scheduling details for the maintenance window. Patching and system updates take place during the maintenance window. |
max_acds_lowest_scaled_value | integer | The lowest value to which you can scale down the maximum number of Autonomous CDBs. |
memory_per_oracle_compute_unit_in_gbs | integer | The amount of memory allocated per Oracle Compute Unit (OCU), in GB. |
memory_size_in_gbs | integer | The total amount of memory allocated to the Autonomous VM cluster, in GB. |
node_count | integer | The number of database server nodes in the Autonomous VM cluster. |
non_provisionable_autonomous_container_databases | integer | The number of Autonomous CDBs that can't be provisioned because of resource constraints. |
oci_resource_anchor_name | string | The name of the OCI resource anchor associated with this Autonomous VM cluster. |
oci_url | string | The URL for accessing the OCI console page for this Autonomous VM cluster. |
ocid | string | The Oracle Cloud Identifier (OCID) of the Autonomous VM cluster. |
odb_network_arn | string | The Amazon Resource Name (ARN) of the ODB network associated with this Autonomous 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 associated with this Autonomous 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 progress of the current operation on the Autonomous VM cluster, as a percentage. |
provisionable_autonomous_container_databases | integer | The number of Autonomous CDBs that you can provision in the Autonomous VM cluster. |
provisioned_autonomous_container_databases | integer | The number of Autonomous Container Databases currently provisioned in the Autonomous VM cluster. |
provisioned_cpus | number (float) | The number of CPUs currently provisioned in the Autonomous VM cluster. |
reclaimable_cpus | number (float) | The number of CPUs that can be reclaimed from terminated or scaled-down Autonomous Databases. |
reserved_cpus | number (float) | The number of CPUs reserved for system operations and redundancy. |
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. |
shape | string | The shape of the Exadata infrastructure for the Autonomous VM cluster. |
status | string | The current status of the Autonomous VM cluster. (AVAILABLE, FAILED, PROVISIONING, TERMINATED, TERMINATING, UPDATING, MAINTENANCE_IN_PROGRESS) |
status_reason | string | Additional information about the current status of the Autonomous VM cluster, if applicable. |
time_database_ssl_certificate_expires | string (date-time) | The expiration date and time of the database SSL certificate. |
time_ords_certificate_expires | string (date-time) | The expiration date and time of the Oracle REST Data Services (ORDS) certificate. |
time_zone | string | The time zone of the Autonomous VM cluster. |
total_container_databases | integer | The total number of Autonomous Container Databases that can be created in the Autonomous VM cluster. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_cloud_autonomous_vm_cluster | select | region | Gets information about a specific Autonomous VM cluster. | |
list_cloud_autonomous_vm_clusters | select | region | Lists all Autonomous VM clusters in a specified Cloud Exadata infrastructure. | |
create_cloud_autonomous_vm_cluster | insert | region, cloudExadataInfrastructureId, odbNetworkId, displayName, autonomousDataStorageSizeInTBs, cpuCoreCountPerNode, memoryPerOracleComputeUnitInGBs, totalContainerDatabases | Creates a new Autonomous VM cluster in the specified Exadata infrastructure. | |
delete_cloud_autonomous_vm_cluster | delete | region | Deletes an Autonomous 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_cloud_autonomous_vm_cluster
- list_cloud_autonomous_vm_clusters
Gets information about a specific Autonomous VM cluster.
SELECT
autonomous_data_storage_percentage,
autonomous_data_storage_size_in_tbs,
available_autonomous_data_storage_size_in_tbs,
available_container_databases,
available_cpus,
cloud_autonomous_vm_cluster_arn,
cloud_autonomous_vm_cluster_id,
cloud_exadata_infrastructure_arn,
cloud_exadata_infrastructure_id,
compute_model,
cpu_core_count,
cpu_core_count_per_node,
cpu_percentage,
created_at,
data_storage_size_in_gbs,
data_storage_size_in_tbs,
db_node_storage_size_in_gbs,
db_servers,
description,
display_name,
domain,
exadata_storage_in_t_bs_lowest_scaled_value,
hostname,
iam_roles,
is_mtls_enabled_vm_cluster,
license_model,
maintenance_window,
max_acds_lowest_scaled_value,
memory_per_oracle_compute_unit_in_gbs,
memory_size_in_gbs,
node_count,
non_provisionable_autonomous_container_databases,
oci_resource_anchor_name,
oci_url,
ocid,
odb_network_arn,
odb_network_id,
percent_progress,
provisionable_autonomous_container_databases,
provisioned_autonomous_container_databases,
provisioned_cpus,
reclaimable_cpus,
reserved_cpus,
scan_listener_port_non_tls,
scan_listener_port_tls,
shape,
status,
status_reason,
time_database_ssl_certificate_expires,
time_ords_certificate_expires,
time_zone,
total_container_databases
FROM aws.odb.cloud_autonomous_vm_clusters
WHERE region = '{{ region }}' -- required
;
Lists all Autonomous VM clusters in a specified Cloud Exadata infrastructure.
SELECT
autonomous_data_storage_percentage,
autonomous_data_storage_size_in_tbs,
available_autonomous_data_storage_size_in_tbs,
available_container_databases,
available_cpus,
cloud_autonomous_vm_cluster_arn,
cloud_autonomous_vm_cluster_id,
cloud_exadata_infrastructure_arn,
cloud_exadata_infrastructure_id,
compute_model,
cpu_core_count,
cpu_core_count_per_node,
cpu_percentage,
created_at,
data_storage_size_in_gbs,
data_storage_size_in_tbs,
db_node_storage_size_in_gbs,
db_servers,
description,
display_name,
domain,
exadata_storage_in_t_bs_lowest_scaled_value,
hostname,
iam_roles,
is_mtls_enabled_vm_cluster,
license_model,
maintenance_window,
max_acds_lowest_scaled_value,
memory_per_oracle_compute_unit_in_gbs,
memory_size_in_gbs,
node_count,
non_provisionable_autonomous_container_databases,
oci_resource_anchor_name,
oci_url,
ocid,
odb_network_arn,
odb_network_id,
percent_progress,
provisionable_autonomous_container_databases,
provisioned_autonomous_container_databases,
provisioned_cpus,
reclaimable_cpus,
reserved_cpus,
scan_listener_port_non_tls,
scan_listener_port_tls,
shape,
status,
status_reason,
time_database_ssl_certificate_expires,
time_ords_certificate_expires,
time_zone,
total_container_databases
FROM aws.odb.cloud_autonomous_vm_clusters
WHERE region = '{{ region }}' -- required
;
INSERT examples
- create_cloud_autonomous_vm_cluster
- Manifest
Creates a new Autonomous VM cluster in the specified Exadata infrastructure.
INSERT INTO aws.odb.cloud_autonomous_vm_clusters (
cloudExadataInfrastructureId,
odbNetworkId,
displayName,
clientToken,
autonomousDataStorageSizeInTBs,
cpuCoreCountPerNode,
dbServers,
description,
isMtlsEnabledVmCluster,
licenseModel,
maintenanceWindow,
memoryPerOracleComputeUnitInGBs,
scanListenerPortNonTls,
scanListenerPortTls,
tags,
timeZone,
totalContainerDatabases,
region
)
SELECT
'{{ cloudExadataInfrastructureId }}' /* required */,
'{{ odbNetworkId }}' /* required */,
'{{ displayName }}' /* required */,
'{{ clientToken }}',
{{ autonomousDataStorageSizeInTBs }} /* required */,
{{ cpuCoreCountPerNode }} /* required */,
'{{ dbServers }}',
'{{ description }}',
{{ isMtlsEnabledVmCluster }},
'{{ licenseModel }}',
'{{ maintenanceWindow }}',
{{ memoryPerOracleComputeUnitInGBs }} /* required */,
{{ scanListenerPortNonTls }},
{{ scanListenerPortTls }},
'{{ tags }}',
'{{ timeZone }}',
{{ totalContainerDatabases }} /* required */,
'{{ region }}'
RETURNING
cloud_autonomous_vm_cluster_id,
display_name,
status,
status_reason
;
# Description fields are for documentation purposes
- name: cloud_autonomous_vm_clusters
props:
- name: region
value: "{{ region }}"
description: Required parameter for the cloud_autonomous_vm_clusters resource.
- name: cloudExadataInfrastructureId
value: "{{ cloudExadataInfrastructureId }}"
description: |
The unique identifier of the Exadata infrastructure where the VM cluster will be created.
- name: odbNetworkId
value: "{{ odbNetworkId }}"
description: |
The unique identifier of the ODB network to be used for the VM cluster.
- name: displayName
value: "{{ displayName }}"
description: |
The display name for the Autonomous VM cluster. The name does not need to be unique.
- name: clientToken
value: "{{ clientToken }}"
description: |
A client-provided token to ensure idempotency of the request.
- name: autonomousDataStorageSizeInTBs
value: {{ autonomousDataStorageSizeInTBs }}
description: |
The data disk group size to be allocated for Autonomous Databases, in terabytes (TB).
- name: cpuCoreCountPerNode
value: {{ cpuCoreCountPerNode }}
description: |
The number of CPU cores to be enabled per VM cluster node.
- name: dbServers
value:
- "{{ dbServers }}"
description: |
The list of database servers to be used for the Autonomous VM cluster.
- name: description
value: "{{ description }}"
description: |
A user-provided description of the Autonomous VM cluster.
- name: isMtlsEnabledVmCluster
value: {{ isMtlsEnabledVmCluster }}
description: |
Specifies whether to enable mutual TLS (mTLS) authentication for the Autonomous VM cluster.
- name: licenseModel
value: "{{ licenseModel }}"
description: |
The Oracle license model to apply to the Autonomous VM cluster.
valid_values: ['BRING_YOUR_OWN_LICENSE', 'LICENSE_INCLUDED']
- name: maintenanceWindow
description: |
The scheduling details for the maintenance window. Patching and system updates take place during the maintenance window.
value:
customActionTimeoutInMins: {{ customActionTimeoutInMins }}
daysOfWeek:
- name: "{{ name }}"
hoursOfDay:
- {{ hoursOfDay }}
isCustomActionTimeoutEnabled: {{ isCustomActionTimeoutEnabled }}
leadTimeInWeeks: {{ leadTimeInWeeks }}
months:
- name: "{{ name }}"
patchingMode: "{{ patchingMode }}"
preference: "{{ preference }}"
skipRu: {{ skipRu }}
weeksOfMonth:
- {{ weeksOfMonth }}
- name: memoryPerOracleComputeUnitInGBs
value: {{ memoryPerOracleComputeUnitInGBs }}
description: |
The amount of memory to be allocated per OCPU, in GB.
- name: scanListenerPortNonTls
value: {{ scanListenerPortNonTls }}
description: |
The SCAN listener port for non-TLS (TCP) protocol.
- name: scanListenerPortTls
value: {{ scanListenerPortTls }}
description: |
The SCAN listener port for TLS (TCP) protocol.
- name: tags
value: "{{ tags }}"
description: |
Free-form tags for this resource. Each tag is a key-value pair with no predefined name, type, or namespace.
- name: timeZone
value: "{{ timeZone }}"
description: |
The time zone to use for the Autonomous VM cluster.
- name: totalContainerDatabases
value: {{ totalContainerDatabases }}
description: |
The total number of Autonomous CDBs that you can create in the Autonomous VM cluster.
DELETE examples
- delete_cloud_autonomous_vm_cluster
Deletes an Autonomous VM cluster.
DELETE FROM aws.odb.cloud_autonomous_vm_clusters
WHERE region = '{{ region }}' --required
;