cloud_vm_clusters

Creates, updates, deletes or gets a cloud_vm_cluster resource or lists cloud_vm_clusters in a region

Overview

Name	cloud_vm_clusters
Type	Resource
Description	The AWS::ODB::CloudVmCluster resource creates a Cloud VM Cluster
Id	awscc.odb.cloud_vm_clusters

Fields

get (all properties)

Name	Datatype	Description
cloud_exadata_infrastructure_id	string	The unique identifier of the Exadata infrastructure that this VM cluster belongs to.
cloud_vm_cluster_arn	string	The Amazon Resource Name (ARN) of the VM cluster.
cloud_vm_cluster_id	string	The unique identifier of the VM cluster.
cluster_name	string	The name of the Grid Infrastructure (GI) cluster.
compute_model	string	The OCI model compute model used when you create or clone an instance: ECPU or OCPU. An ECPU is an abstracted measure of compute resources. ECPUs are based on the number of cores elastically allocated from a pool of compute and storage servers. An OCPU is a legacy physical measure of compute resources. OCPUs are based on the physical core of a processor with hyper-threading enabled.
cpu_core_count	integer	The number of CPU cores enabled on the VM cluster.
▶data_collection_options	object	The set of diagnostic collection options enabled for the VM cluster.
data_storage_size_in_tbs	number	The size of the data disk group, in terabytes (TB), that's allocated for the VM cluster.
db_node_storage_size_in_gbs	integer	The amount of local node storage, in gigabytes (GB), that's allocated for the VM cluster.
db_servers	array	The list of database servers for the VM cluster.
display_name	string	The user-friendly name for the VM cluster.
disk_redundancy	string	The type of redundancy configured for the VM cluster. NORMAL is 2-way redundancy. HIGH is 3-way redundancy.
domain	string	The domain of the VM cluster.
gi_version	string	The software version of the Oracle Grid Infrastructure (GI) for the VM cluster.
hostname	string	The host name for the VM cluster.
is_local_backup_enabled	boolean	Indicates whether database backups to local Exadata storage is enabled for the VM cluster.
is_sparse_diskgroup_enabled	boolean	Indicates whether the VM cluster is configured with a sparse disk group.
license_model	string	The Oracle license model applied to the VM cluster.
listener_port	integer	The port number configured for the listener on the VM cluster.
memory_size_in_gbs	integer	The amount of memory, in gigabytes (GB), that's allocated for the VM cluster.
node_count	integer	The number of nodes in the VM cluster.
odb_network_id	string	The unique identifier of the ODB network for the VM cluster.
ocid	string	The OCID of the VM cluster.
oci_resource_anchor_name	string	The name of the OCI resource anchor for the VM cluster.
oci_url	string	The HTTPS link to the VM cluster in OCI.
scan_dns_name	string	The FQDN of the DNS record for the Single Client Access Name (SCAN) IP addresses that are associated with the VM cluster.
scan_ip_ids	array	The OCID of the SCAN IP addresses that are associated with the VM cluster.
scan_listener_port_tcp	integer	Property description not available.
shape	string	The hardware model name of the Exadata infrastructure that's running the VM cluster.
ssh_public_keys	array	The public key portion of one or more key pairs used for SSH access to the VM cluster.
storage_size_in_gbs	integer	The amount of local node storage, in gigabytes (GB), that's allocated to the VM cluster.
system_version	string	The operating system version of the image chosen for the VM cluster.
▶tags	array	Tags to assign to the Vm Cluster.
time_zone	string	The time zone of the VM cluster.
vip_ids	array	The virtual IP (VIP) addresses that are associated with the VM cluster. Oracle's Cluster Ready Services (CRS) creates and maintains one VIP address for each node in the VM cluster to enable failover. If one node fails, the VIP is reassigned to another active node in the cluster.
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
cloud_vm_cluster_arn	string	The Amazon Resource Name (ARN) of the VM cluster.
region	string	AWS region.

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

Methods

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

SELECT examples

get (all properties)

Gets all properties from an individual cloud_vm_cluster.

SELECT
  region,
  cloud_exadata_infrastructure_id,
  cloud_vm_cluster_arn,
  cloud_vm_cluster_id,
  cluster_name,
  compute_model,
  cpu_core_count,
  data_collection_options,
  data_storage_size_in_tbs,
  db_node_storage_size_in_gbs,
  db_servers,
  display_name,
  disk_redundancy,
  domain,
  gi_version,
  hostname,
  is_local_backup_enabled,
  is_sparse_diskgroup_enabled,
  license_model,
  listener_port,
  memory_size_in_gbs,
  node_count,
  odb_network_id,
  ocid,
  oci_resource_anchor_name,
  oci_url,
  scan_dns_name,
  scan_ip_ids,
  scan_listener_port_tcp,
  shape,
  ssh_public_keys,
  storage_size_in_gbs,
  system_version,
  tags,
  time_zone,
  vip_ids
FROM awscc.odb.cloud_vm_clusters
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ cloud_vm_cluster_arn }}';

list (identifiers only)

Lists all cloud_vm_clusters in a region.

SELECT
  region,
  cloud_vm_cluster_arn
FROM awscc.odb.cloud_vm_clusters_list_only
WHERE
  region = 'us-east-1';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.odb.cloud_vm_clusters (
  CloudExadataInfrastructureId,
  ClusterName,
  CpuCoreCount,
  DataCollectionOptions,
  DataStorageSizeInTBs,
  DbNodeStorageSizeInGBs,
  DbServers,
  DisplayName,
  GiVersion,
  Hostname,
  IsLocalBackupEnabled,
  IsSparseDiskgroupEnabled,
  LicenseModel,
  MemorySizeInGBs,
  OdbNetworkId,
  ScanListenerPortTcp,
  SshPublicKeys,
  SystemVersion,
  Tags,
  TimeZone,
  region
)
SELECT
  '{{ cloud_exadata_infrastructure_id }}',
  '{{ cluster_name }}',
  '{{ cpu_core_count }}',
  '{{ data_collection_options }}',
  '{{ data_storage_size_in_tbs }}',
  '{{ db_node_storage_size_in_gbs }}',
  '{{ db_servers }}',
  '{{ display_name }}',
  '{{ gi_version }}',
  '{{ hostname }}',
  '{{ is_local_backup_enabled }}',
  '{{ is_sparse_diskgroup_enabled }}',
  '{{ license_model }}',
  '{{ memory_size_in_gbs }}',
  '{{ odb_network_id }}',
  '{{ scan_listener_port_tcp }}',
  '{{ ssh_public_keys }}',
  '{{ system_version }}',
  '{{ tags }}',
  '{{ time_zone }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.odb.cloud_vm_clusters (
  CloudExadataInfrastructureId,
  ClusterName,
  CpuCoreCount,
  DataCollectionOptions,
  DataStorageSizeInTBs,
  DbNodeStorageSizeInGBs,
  DbServers,
  DisplayName,
  GiVersion,
  Hostname,
  IsLocalBackupEnabled,
  IsSparseDiskgroupEnabled,
  LicenseModel,
  MemorySizeInGBs,
  OdbNetworkId,
  ScanListenerPortTcp,
  SshPublicKeys,
  SystemVersion,
  Tags,
  TimeZone,
  region
)
SELECT
  '{{ cloud_exadata_infrastructure_id }}',
  '{{ cluster_name }}',
  '{{ cpu_core_count }}',
  '{{ data_collection_options }}',
  '{{ data_storage_size_in_tbs }}',
  '{{ db_node_storage_size_in_gbs }}',
  '{{ db_servers }}',
  '{{ display_name }}',
  '{{ gi_version }}',
  '{{ hostname }}',
  '{{ is_local_backup_enabled }}',
  '{{ is_sparse_diskgroup_enabled }}',
  '{{ license_model }}',
  '{{ memory_size_in_gbs }}',
  '{{ odb_network_id }}',
  '{{ scan_listener_port_tcp }}',
  '{{ ssh_public_keys }}',
  '{{ system_version }}',
  '{{ tags }}',
  '{{ time_zone }}',
  '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: cloud_vm_cluster
    props:
      - name: cloud_exadata_infrastructure_id
        value: '{{ cloud_exadata_infrastructure_id }}'
      - name: cluster_name
        value: '{{ cluster_name }}'
      - name: cpu_core_count
        value: '{{ cpu_core_count }}'
      - name: data_collection_options
        value:
          is_diagnostics_events_enabled: '{{ is_diagnostics_events_enabled }}'
          is_health_monitoring_enabled: '{{ is_health_monitoring_enabled }}'
          is_incident_logs_enabled: '{{ is_incident_logs_enabled }}'
      - name: data_storage_size_in_tbs
        value: null
      - name: db_node_storage_size_in_gbs
        value: '{{ db_node_storage_size_in_gbs }}'
      - name: db_servers
        value:
          - '{{ db_servers[0] }}'
      - name: display_name
        value: '{{ display_name }}'
      - name: gi_version
        value: '{{ gi_version }}'
      - name: hostname
        value: '{{ hostname }}'
      - name: is_local_backup_enabled
        value: '{{ is_local_backup_enabled }}'
      - name: is_sparse_diskgroup_enabled
        value: '{{ is_sparse_diskgroup_enabled }}'
      - name: license_model
        value: '{{ license_model }}'
      - name: memory_size_in_gbs
        value: '{{ memory_size_in_gbs }}'
      - name: odb_network_id
        value: '{{ odb_network_id }}'
      - name: scan_listener_port_tcp
        value: '{{ scan_listener_port_tcp }}'
      - name: ssh_public_keys
        value:
          - '{{ ssh_public_keys[0] }}'
      - name: system_version
        value: '{{ system_version }}'
      - name: tags
        value:
          - key: '{{ key }}'
            value: '{{ value }}'
      - name: time_zone
        value: '{{ time_zone }}'

UPDATE example

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

/*+ update */
UPDATE awscc.odb.cloud_vm_clusters
SET PatchDocument = string('{{ {
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ cloud_vm_cluster_arn }}';

DELETE example

/*+ delete */
DELETE FROM awscc.odb.cloud_vm_clusters
WHERE
  Identifier = '{{ cloud_vm_cluster_arn }}' AND
  region = 'us-east-1';

Permissions

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

Create

odb:CreateCloudVmCluster,
odb:TagResource,
odb:GetCloudVmCluster,
odb:ListCloudVmClusters,
odb:ListTagsForResource,
sts:GetCallerIdentity,
ec2:DescribeAvailabilityZones,
odb:CreateDbNode

Read

odb:GetCloudVmCluster,
odb:ListTagsForResource,
sts:GetCallerIdentity

Update

odb:TagResource,
odb:UntagResource,
odb:GetCloudVmCluster,
odb:ListCloudVmClusters,
odb:ListTagsForResource,
sts:GetCallerIdentity

Delete

odb:DeleteCloudVmCluster,
odb:GetCloudVmCluster,
odb:ListCloudVmClusters,
odb:ListTagsForResource,
sts:GetCallerIdentity,
odb:DeleteDbNode

List

odb:ListCloudVmClusters,
odb:ListTagsForResource,
sts:GetCallerIdentity