cloud_autonomous_vm_clusters

Creates, updates, deletes or gets a cloud_autonomous_vm_cluster resource or lists cloud_autonomous_vm_clusters in a region

Overview

Name	cloud_autonomous_vm_clusters
Type	Resource
Description	The AWS::ODB::CloudAutonomousVmCluster resource creates a Cloud Autonomous VM Cluster
Id	awscc.odb.cloud_autonomous_vm_clusters

Fields

get (all properties)

Name	Datatype	Description
cloud_autonomous_vm_cluster_id	string	The unique identifier of the Autonomous VM cluster.
cloud_autonomous_vm_cluster_arn	string	The Amazon Resource Name (ARN) for the Autonomous VM cluster.
odb_network_id	string	The unique identifier of the ODB network associated with this Autonomous VM cluster.
oci_resource_anchor_name	string	The name of the OCI resource anchor associated with this Autonomous VM cluster.
display_name	string	The display name of the Autonomous VM cluster.
cloud_exadata_infrastructure_id	string	The unique identifier of the Cloud Exadata Infrastructure containing this Autonomous VM cluster.
autonomous_data_storage_percentage	number	The percentage of data storage currently in use for Autonomous Databases in the Autonomous VM cluster.
autonomous_data_storage_size_in_tbs	number	The data storage size allocated for Autonomous Databases in the Autonomous VM cluster, in TB.
available_autonomous_data_storage_size_in_tbs	number	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	The number of CPU cores available for allocation to Autonomous Databases.
compute_model	string	The compute model of the Autonomous VM cluster: ECPU or 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	The percentage of total CPU cores currently in use in the Autonomous VM cluster.
data_storage_size_in_gbs	number	The total data storage allocated to the Autonomous VM cluster, in GB.
data_storage_size_in_tbs	number	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.
domain	string	The domain name for the Autonomous VM cluster.
exadata_storage_in_tbs_lowest_scaled_value	number	The minimum value to which you can scale down the Exadata storage, in TB.
hostname	string	The hostname for the Autonomous VM cluster.
ocid	string	The Oracle Cloud Identifier (OCID) of the Autonomous VM cluster.
oci_url	string	The URL for accessing the OCI console page for this 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. Valid values are LICENSE_INCLUDED or BRING_YOUR_OWN_LICENSE.
▶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.
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	The number of CPU cores currently provisioned in the Autonomous VM cluster.
reclaimable_cpus	number	The number of CPU cores that can be reclaimed from terminated or scaled-down Autonomous Databases.
reserved_cpus	number	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.
▶tags	array	The tags associated with the Autonomous VM cluster.
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.
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
cloud_autonomous_vm_cluster_arn	string	The Amazon Resource Name (ARN) for the Autonomous VM cluster.
region	string	AWS region.

For more information, see AWS::ODB::CloudAutonomousVmCluster.

Methods

Name	Resource	Accessible by	Required Params
create_resource	cloud_autonomous_vm_clusters	INSERT	region
delete_resource	cloud_autonomous_vm_clusters	DELETE	Identifier, region
update_resource	cloud_autonomous_vm_clusters	UPDATE	Identifier, PatchDocument, region
list_resources	cloud_autonomous_vm_clusters_list_only	SELECT	region
get_resource	cloud_autonomous_vm_clusters	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual cloud_autonomous_vm_cluster.

SELECT
  region,
  cloud_autonomous_vm_cluster_id,
  cloud_autonomous_vm_cluster_arn,
  odb_network_id,
  oci_resource_anchor_name,
  display_name,
  cloud_exadata_infrastructure_id,
  autonomous_data_storage_percentage,
  autonomous_data_storage_size_in_tbs,
  available_autonomous_data_storage_size_in_tbs,
  available_container_databases,
  available_cpus,
  compute_model,
  cpu_core_count,
  cpu_core_count_per_node,
  cpu_percentage,
  data_storage_size_in_gbs,
  data_storage_size_in_tbs,
  db_node_storage_size_in_gbs,
  db_servers,
  description,
  domain,
  exadata_storage_in_tbs_lowest_scaled_value,
  hostname,
  ocid,
  oci_url,
  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,
  provisionable_autonomous_container_databases,
  provisioned_autonomous_container_databases,
  provisioned_cpus,
  reclaimable_cpus,
  reserved_cpus,
  scan_listener_port_non_tls,
  scan_listener_port_tls,
  shape,
  tags,
  time_zone,
  total_container_databases
FROM awscc.odb.cloud_autonomous_vm_clusters
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ cloud_autonomous_vm_cluster_arn }}';

list (identifiers only)

Lists all cloud_autonomous_vm_clusters in a region.

SELECT
  region,
  cloud_autonomous_vm_cluster_arn
FROM awscc.odb.cloud_autonomous_vm_clusters_list_only
WHERE
  region = '{{ region }}';

INSERT example

Use the following StackQL query and manifest file to create a new cloud_autonomous_vm_cluster resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO awscc.odb.cloud_autonomous_vm_clusters (
  OdbNetworkId,
  DisplayName,
  CloudExadataInfrastructureId,
  AutonomousDataStorageSizeInTBs,
  CpuCoreCountPerNode,
  DbServers,
  Description,
  IsMtlsEnabledVmCluster,
  LicenseModel,
  MaintenanceWindow,
  MemoryPerOracleComputeUnitInGBs,
  ScanListenerPortNonTls,
  ScanListenerPortTls,
  Tags,
  TimeZone,
  TotalContainerDatabases,
  region
)
SELECT
  '{{ odb_network_id }}',
  '{{ display_name }}',
  '{{ cloud_exadata_infrastructure_id }}',
  '{{ autonomous_data_storage_size_in_tbs }}',
  '{{ cpu_core_count_per_node }}',
  '{{ db_servers }}',
  '{{ description }}',
  '{{ is_mtls_enabled_vm_cluster }}',
  '{{ license_model }}',
  '{{ maintenance_window }}',
  '{{ memory_per_oracle_compute_unit_in_gbs }}',
  '{{ scan_listener_port_non_tls }}',
  '{{ scan_listener_port_tls }}',
  '{{ tags }}',
  '{{ time_zone }}',
  '{{ total_container_databases }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.odb.cloud_autonomous_vm_clusters (
  OdbNetworkId,
  DisplayName,
  CloudExadataInfrastructureId,
  AutonomousDataStorageSizeInTBs,
  CpuCoreCountPerNode,
  DbServers,
  Description,
  IsMtlsEnabledVmCluster,
  LicenseModel,
  MaintenanceWindow,
  MemoryPerOracleComputeUnitInGBs,
  ScanListenerPortNonTls,
  ScanListenerPortTls,
  Tags,
  TimeZone,
  TotalContainerDatabases,
  region
)
SELECT
  '{{ odb_network_id }}',
  '{{ display_name }}',
  '{{ cloud_exadata_infrastructure_id }}',
  '{{ autonomous_data_storage_size_in_tbs }}',
  '{{ cpu_core_count_per_node }}',
  '{{ db_servers }}',
  '{{ description }}',
  '{{ is_mtls_enabled_vm_cluster }}',
  '{{ license_model }}',
  '{{ maintenance_window }}',
  '{{ memory_per_oracle_compute_unit_in_gbs }}',
  '{{ scan_listener_port_non_tls }}',
  '{{ scan_listener_port_tls }}',
  '{{ tags }}',
  '{{ time_zone }}',
  '{{ total_container_databases }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Manifest

version: 1
name: stack name
description: stack description
providers:
- aws
globals:
- name: region
  value: '{{ vars.AWS_REGION }}'
resources:
- name: cloud_autonomous_vm_cluster
  props:
    - name: odb_network_id
      value: '{{ odb_network_id }}'
    - name: display_name
      value: '{{ display_name }}'
    - name: cloud_exadata_infrastructure_id
      value: '{{ cloud_exadata_infrastructure_id }}'
    - name: autonomous_data_storage_size_in_tbs
      value: null
    - name: cpu_core_count_per_node
      value: '{{ cpu_core_count_per_node }}'
    - name: db_servers
      value:
        - '{{ db_servers[0] }}'
    - name: description
      value: '{{ description }}'
    - name: is_mtls_enabled_vm_cluster
      value: '{{ is_mtls_enabled_vm_cluster }}'
    - name: license_model
      value: '{{ license_model }}'
    - name: maintenance_window
      value:
        days_of_week:
          - '{{ days_of_week[0] }}'
        hours_of_day:
          - '{{ hours_of_day[0] }}'
        lead_time_in_weeks: '{{ lead_time_in_weeks }}'
        months:
          - '{{ months[0] }}'
        preference: '{{ preference }}'
        weeks_of_month:
          - '{{ weeks_of_month[0] }}'
    - name: memory_per_oracle_compute_unit_in_gbs
      value: '{{ memory_per_oracle_compute_unit_in_gbs }}'
    - name: scan_listener_port_non_tls
      value: '{{ scan_listener_port_non_tls }}'
    - name: scan_listener_port_tls
      value: '{{ scan_listener_port_tls }}'
    - name: tags
      value:
        - key: '{{ key }}'
          value: '{{ value }}'
    - name: time_zone
      value: '{{ time_zone }}'
    - name: total_container_databases
      value: '{{ total_container_databases }}'

UPDATE example

Use the following StackQL query and manifest file to update a cloud_autonomous_vm_cluster resource, using stack-deploy.

/*+ update */
UPDATE awscc.odb.cloud_autonomous_vm_clusters
SET PatchDocument = string('{{ {
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ cloud_autonomous_vm_cluster_arn }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.odb.cloud_autonomous_vm_clusters
WHERE
  Identifier = '{{ cloud_autonomous_vm_cluster_arn }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

Permissions

To operate on the cloud_autonomous_vm_clusters resource, the following permissions are required:

Create

ec2:DescribeAvailabilityZones,
iam:CreateServiceLinkedRole,
odb:CreateCloudAutonomousVmCluster,
odb:GetCloudAutonomousVmCluster,
odb:ListCloudAutonomousVmClusters,
odb:ListTagsForResource,
odb:TagResource,
sts:GetCallerIdentity

Read

odb:GetCloudAutonomousVmCluster,
odb:ListTagsForResource,
sts:GetCallerIdentity

Update

odb:TagResource,
odb:UntagResource,
odb:GetCloudAutonomousVmCluster,
odb:ListCloudAutonomousVmClusters,
odb:ListTagsForResource,
sts:GetCallerIdentity

Delete

odb:DeleteCloudAutonomousVmCluster,
odb:GetCloudAutonomousVmCluster,
odb:ListCloudAutonomousVmClusters,
odb:ListTagsForResource,
sts:GetCallerIdentity

List

odb:ListCloudAutonomousVmClusters,
odb:ListTagsForResource,
sts:GetCallerIdentity