Package software.amazon.awscdk.services.odb

Class CfnCloudVmCluster

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.odb.CfnCloudVmCluster
All Implemented Interfaces:
IInspectable, IEnvironmentAware, ICloudVmClusterRef, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.120.0 (build 192dc88)", date="2025-12-05T22:26:40.901Z") @Stability(Stable) public class CfnCloudVmCluster extends CfnResource implements IInspectable, ICloudVmClusterRef, ITaggableV2
The AWS::ODB::CloudVmCluster resource creates a VM cluster on the specified Exadata infrastructure in the Oracle Database.

A VM cluster provides the compute resources for Oracle Database workloads.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.odb.*;
 CfnCloudVmCluster cfnCloudVmCluster = CfnCloudVmCluster.Builder.create(this, "MyCfnCloudVmCluster")
         .cloudExadataInfrastructureId("cloudExadataInfrastructureId")
         .clusterName("clusterName")
         .cpuCoreCount(123)
         .dataCollectionOptions(DataCollectionOptionsProperty.builder()
                 .isDiagnosticsEventsEnabled(false)
                 .isHealthMonitoringEnabled(false)
                 .isIncidentLogsEnabled(false)
                 .build())
         .dataStorageSizeInTBs(123)
         .dbNodes(List.of(DbNodeProperty.builder()
                 .dbServerId("dbServerId")
                 // the properties below are optional
                 .backupIpId("backupIpId")
                 .backupVnic2Id("backupVnic2Id")
                 .cpuCoreCount(123)
                 .dbNodeArn("dbNodeArn")
                 .dbNodeId("dbNodeId")
                 .dbNodeStorageSizeInGBs(123)
                 .dbSystemId("dbSystemId")
                 .hostIpId("hostIpId")
                 .hostname("hostname")
                 .memorySizeInGBs(123)
                 .ocid("ocid")
                 .status("status")
                 .tags(List.of(CfnTag.builder()
                         .key("key")
                         .value("value")
                         .build()))
                 .vnic2Id("vnic2Id")
                 .vnicId("vnicId")
                 .build()))
         .dbNodeStorageSizeInGBs(123)
         .dbServers(List.of("dbServers"))
         .displayName("displayName")
         .giVersion("giVersion")
         .hostname("hostname")
         .isLocalBackupEnabled(false)
         .isSparseDiskgroupEnabled(false)
         .licenseModel("licenseModel")
         .memorySizeInGBs(123)
         .odbNetworkId("odbNetworkId")
         .scanListenerPortTcp(123)
         .sshPublicKeys(List.of("sshPublicKeys"))
         .systemVersion("systemVersion")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .timeZone("timeZone")
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnCloudVmCluster

      protected CfnCloudVmCluster(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnCloudVmCluster

      protected CfnCloudVmCluster(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnCloudVmCluster

      @Stability(Stable) public CfnCloudVmCluster(@NotNull software.constructs.Construct scope, @NotNull String id, @Nullable CfnCloudVmClusterProps props)
      Create a new AWS::ODB::CloudVmCluster.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties.

    • CfnCloudVmCluster

      @Stability(Stable) public CfnCloudVmCluster(@NotNull software.constructs.Construct scope, @NotNull String id)
      Create a new AWS::ODB::CloudVmCluster.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.

  • Method Details

    • arnForCloudVmCluster

      @Stability(Stable) @NotNull public static String arnForCloudVmCluster(@NotNull ICloudVmClusterRef resource)
      Parameters:
      resource - This parameter is required.

    • isCfnCloudVmCluster

      @Stability(Stable) @NotNull public static Boolean isCfnCloudVmCluster(@NotNull Object x)
      Checks whether the given object is a CfnCloudVmCluster.

      Parameters:
      x - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrCloudVmClusterArn

      @Stability(Stable) @NotNull public String getAttrCloudVmClusterArn()
      The Amazon Resource Name (ARN) of the VM cluster.

    • getAttrCloudVmClusterId

      @Stability(Stable) @NotNull public String getAttrCloudVmClusterId()
      The unique identifier of the VM cluster.

    • getAttrComputeModel

      @Stability(Stable) @NotNull public String getAttrComputeModel()
      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.

    • getAttrDiskRedundancy

      @Stability(Stable) @NotNull public String getAttrDiskRedundancy()
      The type of redundancy configured for the VM cluster.

      NORMAL is 2-way redundancy. HIGH is 3-way redundancy.

    • getAttrDomain

      @Stability(Stable) @NotNull public String getAttrDomain()
      The domain of the VM cluster.

    • getAttrListenerPort

      @Stability(Stable) @NotNull public Number getAttrListenerPort()
      The port number configured for the listener on the VM cluster.

    • getAttrNodeCount

      @Stability(Stable) @NotNull public Number getAttrNodeCount()
      The number of nodes in the VM cluster.

    • getAttrOcid

      @Stability(Stable) @NotNull public String getAttrOcid()
      The OCID of the VM cluster.

    • getAttrOciResourceAnchorName

      @Stability(Stable) @NotNull public String getAttrOciResourceAnchorName()
      The name of the OCI resource anchor for the VM cluster.

    • getAttrOciUrl

      @Stability(Stable) @NotNull public String getAttrOciUrl()
      The HTTPS link to the VM cluster in OCI.

    • getAttrScanDnsName

      @Stability(Stable) @NotNull public String getAttrScanDnsName()
      The FQDN of the DNS record for the Single Client Access Name (SCAN) IP addresses that are associated with the VM cluster.

    • getAttrScanIpIds

      @Stability(Stable) @NotNull public List<String> getAttrScanIpIds()
      The OCID of the SCAN IP addresses that are associated with the VM cluster.

    • getAttrShape

      @Stability(Stable) @NotNull public String getAttrShape()
      The hardware model name of the Exadata infrastructure that's running the VM cluster.

    • getAttrStorageSizeInGBs

      @Stability(Stable) @NotNull public Number getAttrStorageSizeInGBs()
      The amount of local node storage, in gigabytes (GB), that's allocated to the VM cluster.

    • getAttrVipIds

      @Stability(Stable) @NotNull public List<String> getAttrVipIds()
      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.

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getCloudVmClusterRef

      @Stability(Stable) @NotNull public CloudVmClusterReference getCloudVmClusterRef()
      A reference to a CloudVmCluster resource.
      Specified by:
      getCloudVmClusterRef in interface ICloudVmClusterRef

    • getCloudExadataInfrastructureId

      @Stability(Stable) @Nullable public String getCloudExadataInfrastructureId()
      The unique identifier of the Exadata infrastructure that this VM cluster belongs to.

    • setCloudExadataInfrastructureId

      @Stability(Stable) public void setCloudExadataInfrastructureId(@Nullable String value)
      The unique identifier of the Exadata infrastructure that this VM cluster belongs to.

    • getClusterName

      @Stability(Stable) @Nullable public String getClusterName()
      The name of the Grid Infrastructure (GI) cluster.

    • setClusterName

      @Stability(Stable) public void setClusterName(@Nullable String value)
      The name of the Grid Infrastructure (GI) cluster.

    • getCpuCoreCount

      @Stability(Stable) @Nullable public Number getCpuCoreCount()
      The number of CPU cores enabled on the VM cluster.

    • setCpuCoreCount

      @Stability(Stable) public void setCpuCoreCount(@Nullable Number value)
      The number of CPU cores enabled on the VM cluster.

    • getDataCollectionOptions

      @Stability(Stable) @Nullable public Object getDataCollectionOptions()
      The set of diagnostic collection options enabled for the VM cluster.

      Returns union: either IResolvable or CfnCloudVmCluster.DataCollectionOptionsProperty

    • setDataCollectionOptions

      @Stability(Stable) public void setDataCollectionOptions(@Nullable IResolvable value)
      The set of diagnostic collection options enabled for the VM cluster.

    • setDataCollectionOptions

      @Stability(Stable) public void setDataCollectionOptions(@Nullable CfnCloudVmCluster.DataCollectionOptionsProperty value)
      The set of diagnostic collection options enabled for the VM cluster.

    • getDataStorageSizeInTBs

      @Stability(Stable) @Nullable public Number getDataStorageSizeInTBs()
      The size of the data disk group, in terabytes (TB), that's allocated for the VM cluster.

    • setDataStorageSizeInTBs

      @Stability(Stable) public void setDataStorageSizeInTBs(@Nullable Number value)
      The size of the data disk group, in terabytes (TB), that's allocated for the VM cluster.

    • getDbNodes

      @Stability(Stable) @Nullable public Object getDbNodes()
      The DB nodes that are implicitly created and managed as part of this VM Cluster.

      Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnCloudVmCluster.DbNodeProperty>

    • setDbNodes

      @Stability(Stable) public void setDbNodes(@Nullable IResolvable value)
      The DB nodes that are implicitly created and managed as part of this VM Cluster.

    • setDbNodes

      @Stability(Stable) public void setDbNodes(@Nullable List<Object> value)
      The DB nodes that are implicitly created and managed as part of this VM Cluster.

    • getDbNodeStorageSizeInGBs

      @Stability(Stable) @Nullable public Number getDbNodeStorageSizeInGBs()
      The amount of local node storage, in gigabytes (GB), that's allocated for the VM cluster.

    • setDbNodeStorageSizeInGBs

      @Stability(Stable) public void setDbNodeStorageSizeInGBs(@Nullable Number value)
      The amount of local node storage, in gigabytes (GB), that's allocated for the VM cluster.

    • getDbServers

      @Stability(Stable) @Nullable public List<String> getDbServers()
      The list of database servers for the VM cluster.

    • setDbServers

      @Stability(Stable) public void setDbServers(@Nullable List<String> value)
      The list of database servers for the VM cluster.

    • getDisplayName

      @Stability(Stable) @Nullable public String getDisplayName()
      The user-friendly name for the VM cluster.

    • setDisplayName

      @Stability(Stable) public void setDisplayName(@Nullable String value)
      The user-friendly name for the VM cluster.

    • getGiVersion

      @Stability(Stable) @Nullable public String getGiVersion()
      The software version of the Oracle Grid Infrastructure (GI) for the VM cluster.

    • setGiVersion

      @Stability(Stable) public void setGiVersion(@Nullable String value)
      The software version of the Oracle Grid Infrastructure (GI) for the VM cluster.

    • getHostname

      @Stability(Stable) @Nullable public String getHostname()
      The host name for the VM cluster.

    • setHostname

      @Stability(Stable) public void setHostname(@Nullable String value)
      The host name for the VM cluster.

    • getIsLocalBackupEnabled

      @Stability(Stable) @Nullable public Object getIsLocalBackupEnabled()
      Specifies whether database backups to local Exadata storage are enabled for the VM cluster.

      Returns union: either Boolean or IResolvable

    • setIsLocalBackupEnabled

      @Stability(Stable) public void setIsLocalBackupEnabled(@Nullable Boolean value)
      Specifies whether database backups to local Exadata storage are enabled for the VM cluster.

    • setIsLocalBackupEnabled

      @Stability(Stable) public void setIsLocalBackupEnabled(@Nullable IResolvable value)
      Specifies whether database backups to local Exadata storage are enabled for the VM cluster.

    • getIsSparseDiskgroupEnabled

      @Stability(Stable) @Nullable public Object getIsSparseDiskgroupEnabled()
      Specifies whether the VM cluster is configured with a sparse disk group.

      Returns union: either Boolean or IResolvable

    • setIsSparseDiskgroupEnabled

      @Stability(Stable) public void setIsSparseDiskgroupEnabled(@Nullable Boolean value)
      Specifies whether the VM cluster is configured with a sparse disk group.

    • setIsSparseDiskgroupEnabled

      @Stability(Stable) public void setIsSparseDiskgroupEnabled(@Nullable IResolvable value)
      Specifies whether the VM cluster is configured with a sparse disk group.

    • getLicenseModel

      @Stability(Stable) @Nullable public String getLicenseModel()
      The Oracle license model applied to the VM cluster.

    • setLicenseModel

      @Stability(Stable) public void setLicenseModel(@Nullable String value)
      The Oracle license model applied to the VM cluster.

    • getMemorySizeInGBs

      @Stability(Stable) @Nullable public Number getMemorySizeInGBs()
      The amount of memory, in gigabytes (GB), that's allocated for the VM cluster.

    • setMemorySizeInGBs

      @Stability(Stable) public void setMemorySizeInGBs(@Nullable Number value)
      The amount of memory, in gigabytes (GB), that's allocated for the VM cluster.

    • getOdbNetworkId

      @Stability(Stable) @Nullable public String getOdbNetworkId()
      The unique identifier of the ODB network for the VM cluster.

    • setOdbNetworkId

      @Stability(Stable) public void setOdbNetworkId(@Nullable String value)
      The unique identifier of the ODB network for the VM cluster.

    • getScanListenerPortTcp

      @Stability(Stable) @Nullable public Number getScanListenerPortTcp()
      The port number for TCP connections to the single client access name (SCAN) listener.

    • setScanListenerPortTcp

      @Stability(Stable) public void setScanListenerPortTcp(@Nullable Number value)
      The port number for TCP connections to the single client access name (SCAN) listener.

    • getSshPublicKeys

      @Stability(Stable) @Nullable public List<String> getSshPublicKeys()
      The public key portion of one or more key pairs used for SSH access to the VM cluster.

    • setSshPublicKeys

      @Stability(Stable) public void setSshPublicKeys(@Nullable List<String> value)
      The public key portion of one or more key pairs used for SSH access to the VM cluster.

    • getSystemVersion

      @Stability(Stable) @Nullable public String getSystemVersion()
      The operating system version of the image chosen for the VM cluster.

    • setSystemVersion

      @Stability(Stable) public void setSystemVersion(@Nullable String value)
      The operating system version of the image chosen for the VM cluster.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      Tags to assign to the Vm Cluster.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      Tags to assign to the Vm Cluster.

    • getTimeZone

      @Stability(Stable) @Nullable public String getTimeZone()
      The time zone of the VM cluster.

    • setTimeZone

      @Stability(Stable) public void setTimeZone(@Nullable String value)
      The time zone of the VM cluster.