Skip to content

CloudVmClusterSummary

Source code in docs_src/capo_odb/types/cloud_vm_cluster_summary.py
class CloudVmClusterSummary(TypedDict, closed=True):
    cloud_vm_cluster_id: "capo_odb.types.resource_id.ResourceId"
    """<p>The unique identifier of the VM cluster.</p>"""
    display_name: NotRequired["str"]
    """<p>The user-friendly name for the VM cluster.</p>"""
    status: NotRequired["capo_odb.types.resource_status.ResourceStatus"]
    """<p>The current status of the VM cluster.</p>"""
    status_reason: NotRequired["str"]
    """<p>Additional information about the status of the VM cluster.</p>"""
    cloud_vm_cluster_arn: NotRequired["str"]
    """<p>The Amazon Resource Name (ARN) of the VM cluster.</p>"""
    cloud_exadata_infrastructure_id: NotRequired["str"]
    """<p>The unique identifier of the Exadata infrastructure that this VM cluster belongs to.</p>"""
    cloud_exadata_infrastructure_arn: NotRequired[
        "capo_odb.types.resource_arn.ResourceArn"
    ]
    """<p>The Amazon Resource Name (ARN) of the Exadata infrastructure that this VM cluster belongs to.</p>"""
    cluster_name: NotRequired["str"]
    """<p>The name of the Grid Infrastructure (GI) cluster.</p>"""
    cpu_core_count: NotRequired["int"]
    """<p>The number of CPU cores enabled on the VM cluster.</p>"""
    data_collection_options: NotRequired[
        "capo_odb.types.data_collection_options.DataCollectionOptions"
    ]
    data_storage_size_in_t_bs: NotRequired["float"]
    """<p>The size of the data disk group, in terabytes (TB), that's allocated for the VM cluster.</p>"""
    db_node_storage_size_in_g_bs: NotRequired["int"]
    """<p>The amount of local node storage, in gigabytes (GB), that's allocated for the VM cluster.</p>"""
    db_servers: NotRequired["capo_odb.types.string_list.StringList"]
    """<p>The list of database servers for the VM cluster.</p>"""
    disk_redundancy: NotRequired["capo_odb.types.disk_redundancy.DiskRedundancy"]
    """<p>The type of redundancy configured for the VM cluster. <code>NORMAL</code> is 2-way redundancy. <code>HIGH</code> is 3-way redundancy.</p>"""
    gi_version: NotRequired["str"]
    """<p>The software version of the Oracle Grid Infrastructure (GI) for the VM cluster.</p>"""
    hostname: NotRequired["str"]
    """<p>The host name for the VM cluster.</p>"""
    iorm_config_cache: NotRequired[
        "capo_odb.types.exadata_iorm_config.ExadataIormConfig"
    ]
    is_local_backup_enabled: NotRequired["bool"]
    """<p>Indicates whether database backups to local Exadata storage is enabled for the VM cluster.</p>"""
    is_sparse_diskgroup_enabled: NotRequired["bool"]
    """<p>Indicates whether the VM cluster is configured with a sparse disk group.</p>"""
    last_update_history_entry_id: NotRequired["str"]
    """<p>The Oracle Cloud ID (OCID) of the last maintenance update history entry.</p>"""
    license_model: NotRequired["capo_odb.types.license_model.LicenseModel"]
    """<p>The Oracle license model applied to the VM cluster.</p>"""
    listener_port: NotRequired["int"]
    """<p>The port number configured for the listener on the VM cluster.</p>"""
    memory_size_in_g_bs: NotRequired["int"]
    """<p>The amount of memory, in gigabytes (GB), that's allocated for the VM cluster.</p>"""
    node_count: NotRequired["int"]
    """<p>The number of nodes in the VM cluster.</p>"""
    ocid: NotRequired["str"]
    """<p>The OCID of the VM cluster.</p>"""
    oci_resource_anchor_name: NotRequired["str"]
    """<p>The name of the OCI resource anchor for the VM cluster.</p>"""
    oci_url: NotRequired["str"]
    """<p>The HTTPS link to the VM cluster in OCI.</p>"""
    domain: NotRequired["str"]
    """<p>The domain of the VM cluster.</p>"""
    scan_dns_name: NotRequired["str"]
    """<p>The fully qualified domain name (FQDN) of the DNS record for the Single Client Access Name (SCAN) IP addresses that are associated with the VM cluster.</p>"""
    scan_dns_record_id: NotRequired["str"]
    """<p>The OCID of the DNS record for the SCAN IP addresses that are associated with the VM cluster.</p>"""
    scan_ip_ids: NotRequired["capo_odb.types.string_list.StringList"]
    """<p>The OCID of the SCAN IP addresses that are associated with the VM cluster.</p>"""
    shape: NotRequired["str"]
    """<p>The hardware model name of the Exadata infrastructure that's running the VM cluster.</p>"""
    ssh_public_keys: NotRequired[
        "capo_odb.types.sensitive_string_list.SensitiveStringList"
    ]
    """<p>The public key portion of one or more key pairs used for SSH access to the VM cluster.</p>"""
    storage_size_in_g_bs: NotRequired["int"]
    """<p>The amount of local node storage, in gigabytes (GB), that's allocated to the VM cluster.</p>"""
    system_version: NotRequired["str"]
    """<p>The operating system version of the image chosen for the VM cluster.</p>"""
    created_at: NotRequired["datetime.datetime"]
    """<p>The date and time when the VM cluster was created.</p>"""
    time_zone: NotRequired["str"]
    """<p>The time zone of the VM cluster.</p>"""
    vip_ids: NotRequired["capo_odb.types.string_list.StringList"]
    """<p>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.</p>"""
    odb_network_id: NotRequired["capo_odb.types.resource_id_or_arn.ResourceIdOrArn"]
    """<p>The unique identifier of the ODB network for the VM cluster.</p>"""
    odb_network_arn: NotRequired["capo_odb.types.resource_arn.ResourceArn"]
    """<p>The Amazon Resource Name (ARN) of the ODB network associated with this VM cluster.</p>"""
    percent_progress: NotRequired["float"]
    """<p>The amount of progress made on the current operation on the VM cluster, expressed as a percentage.</p>"""
    compute_model: NotRequired["capo_odb.types.compute_model.ComputeModel"]
    """<p>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. </p>"""
    iam_roles: NotRequired["capo_odb.types.iam_role_list.IamRoleList"]
    """<p>The Amazon Web Services Identity and Access Management (IAM) service roles associated with the VM cluster in the summary information.</p>"""

cloud_exadata_infrastructure_arn instance-attribute

cloud_exadata_infrastructure_arn: NotRequired[ResourceArn]

The Amazon Resource Name (ARN) of the Exadata infrastructure that this VM cluster belongs to.

cloud_exadata_infrastructure_id instance-attribute

cloud_exadata_infrastructure_id: NotRequired[str]

The unique identifier of the Exadata infrastructure that this VM cluster belongs to.

cloud_vm_cluster_arn instance-attribute

cloud_vm_cluster_arn: NotRequired[str]

The Amazon Resource Name (ARN) of the VM cluster.

cloud_vm_cluster_id instance-attribute

cloud_vm_cluster_id: ResourceId

The unique identifier of the VM cluster.

cluster_name instance-attribute

cluster_name: NotRequired[str]

The name of the Grid Infrastructure (GI) cluster.

compute_model instance-attribute

compute_model: NotRequired[ComputeModel]

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 instance-attribute

cpu_core_count: NotRequired[int]

The number of CPU cores enabled on the VM cluster.

created_at instance-attribute

created_at: NotRequired[datetime]

The date and time when the VM cluster was created.

data_collection_options instance-attribute

data_collection_options: NotRequired[DataCollectionOptions]

data_storage_size_in_t_bs instance-attribute

data_storage_size_in_t_bs: NotRequired[float]

The size of the data disk group, in terabytes (TB), that's allocated for the VM cluster.

db_node_storage_size_in_g_bs instance-attribute

db_node_storage_size_in_g_bs: NotRequired[int]

The amount of local node storage, in gigabytes (GB), that's allocated for the VM cluster.

db_servers instance-attribute

db_servers: NotRequired[StringList]

The list of database servers for the VM cluster.

disk_redundancy instance-attribute

disk_redundancy: NotRequired[DiskRedundancy]

The type of redundancy configured for the VM cluster. NORMAL is 2-way redundancy. HIGH is 3-way redundancy.

display_name instance-attribute

display_name: NotRequired[str]

The user-friendly name for the VM cluster.

domain instance-attribute

domain: NotRequired[str]

The domain of the VM cluster.

gi_version instance-attribute

gi_version: NotRequired[str]

The software version of the Oracle Grid Infrastructure (GI) for the VM cluster.

hostname instance-attribute

hostname: NotRequired[str]

The host name for the VM cluster.

iam_roles instance-attribute

iam_roles: NotRequired[IamRoleList]

The Amazon Web Services Identity and Access Management (IAM) service roles associated with the VM cluster in the summary information.

iorm_config_cache instance-attribute

iorm_config_cache: NotRequired[ExadataIormConfig]

is_local_backup_enabled instance-attribute

is_local_backup_enabled: NotRequired[bool]

Indicates whether database backups to local Exadata storage is enabled for the VM cluster.

is_sparse_diskgroup_enabled instance-attribute

is_sparse_diskgroup_enabled: NotRequired[bool]

Indicates whether the VM cluster is configured with a sparse disk group.

last_update_history_entry_id instance-attribute

last_update_history_entry_id: NotRequired[str]

The Oracle Cloud ID (OCID) of the last maintenance update history entry.

license_model instance-attribute

license_model: NotRequired[LicenseModel]

The Oracle license model applied to the VM cluster.

listener_port instance-attribute

listener_port: NotRequired[int]

The port number configured for the listener on the VM cluster.

memory_size_in_g_bs instance-attribute

memory_size_in_g_bs: NotRequired[int]

The amount of memory, in gigabytes (GB), that's allocated for the VM cluster.

node_count instance-attribute

node_count: NotRequired[int]

The number of nodes in the VM cluster.

oci_resource_anchor_name instance-attribute

oci_resource_anchor_name: NotRequired[str]

The name of the OCI resource anchor for the VM cluster.

oci_url instance-attribute

oci_url: NotRequired[str]

The HTTPS link to the VM cluster in OCI.

ocid instance-attribute

ocid: NotRequired[str]

The OCID of the VM cluster.

odb_network_arn instance-attribute

odb_network_arn: NotRequired[ResourceArn]

The Amazon Resource Name (ARN) of the ODB network associated with this VM cluster.

odb_network_id instance-attribute

odb_network_id: NotRequired[ResourceIdOrArn]

The unique identifier of the ODB network for the VM cluster.

percent_progress instance-attribute

percent_progress: NotRequired[float]

The amount of progress made on the current operation on the VM cluster, expressed as a percentage.

scan_dns_name instance-attribute

scan_dns_name: NotRequired[str]

The fully qualified domain name (FQDN) of the DNS record for the Single Client Access Name (SCAN) IP addresses that are associated with the VM cluster.

scan_dns_record_id instance-attribute

scan_dns_record_id: NotRequired[str]

The OCID of the DNS record for the SCAN IP addresses that are associated with the VM cluster.

scan_ip_ids instance-attribute

scan_ip_ids: NotRequired[StringList]

The OCID of the SCAN IP addresses that are associated with the VM cluster.

shape instance-attribute

shape: NotRequired[str]

The hardware model name of the Exadata infrastructure that's running the VM cluster.

ssh_public_keys instance-attribute

ssh_public_keys: NotRequired[SensitiveStringList]

The public key portion of one or more key pairs used for SSH access to the VM cluster.

status instance-attribute

status: NotRequired[ResourceStatus]

The current status of the VM cluster.

status_reason instance-attribute

status_reason: NotRequired[str]

Additional information about the status of the VM cluster.

storage_size_in_g_bs instance-attribute

storage_size_in_g_bs: NotRequired[int]

The amount of local node storage, in gigabytes (GB), that's allocated to the VM cluster.

system_version instance-attribute

system_version: NotRequired[str]

The operating system version of the image chosen for the VM cluster.

time_zone instance-attribute

time_zone: NotRequired[str]

The time zone of the VM cluster.

vip_ids instance-attribute

vip_ids: NotRequired[StringList]

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.