AWS::ODB::CloudVmCluster

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.

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON


{
  "Type" : "AWS::ODB::CloudVmCluster",
  "Properties" : {
      "CloudExadataInfrastructureId" : String,
      "ClusterName" : String,
      "CpuCoreCount" : Integer,
      "DataCollectionOptions" : DataCollectionOptions,
      "DataStorageSizeInTBs" : Number,
      "DbNodeStorageSizeInGBs" : Integer,
      "DbServers" : [ String, ... ],
      "DisplayName" : String,
      "GiVersion" : String,
      "Hostname" : String,
      "IsLocalBackupEnabled" : Boolean,
      "IsSparseDiskgroupEnabled" : Boolean,
      "LicenseModel" : String,
      "MemorySizeInGBs" : Integer,
      "OdbNetworkId" : String,
      "ScanListenerPortTcp" : Integer,
      "SshPublicKeys" : [ String, ... ],
      "SystemVersion" : String,
      "Tags" : [ Tag, ... ],
      "TimeZone" : String
    }
}

YAML


Type: AWS::ODB::CloudVmCluster
Properties:
  CloudExadataInfrastructureId: String
  ClusterName: String
  CpuCoreCount: Integer
  DataCollectionOptions: 
    DataCollectionOptions
  DataStorageSizeInTBs: Number
  DbNodeStorageSizeInGBs: Integer
  DbServers: 
    - String
  DisplayName: String
  GiVersion: String
  Hostname: String
  IsLocalBackupEnabled: Boolean
  IsSparseDiskgroupEnabled: Boolean
  LicenseModel: String
  MemorySizeInGBs: Integer
  OdbNetworkId: String
  ScanListenerPortTcp: Integer
  SshPublicKeys: 
    - String
  SystemVersion: String
  Tags: 
    - Tag
  TimeZone: String

Properties

CloudExadataInfrastructureId

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

Required when creating a VM cluster.

Required: Conditional

Type: String

Update requires: Replacement

ClusterName

The name of the Grid Infrastructure (GI) cluster.

Required: No

Type: String

Pattern: ^[a-zA-Z][a-zA-Z0-9-]*$

Minimum: 1

Maximum: 11

Update requires: Replacement

CpuCoreCount

The number of CPU cores enabled on the VM cluster.

Required when creating a VM cluster.

Required: Conditional

Type: Integer

Minimum: 0

Maximum: 368

Update requires: Replacement

DataCollectionOptions

The set of diagnostic collection options enabled for the VM cluster.

Required: No

Type: DataCollectionOptions

Update requires: Replacement

DataStorageSizeInTBs

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

Required: No

Type: Number

Update requires: Replacement

DbNodeStorageSizeInGBs

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

Required: No

Type: Integer

Update requires: Replacement

DbServers

The list of database servers for the VM cluster.

Required: No

Type: Array of String

Minimum: 1

Maximum: 1024

Update requires: Replacement

DisplayName

The user-friendly name for the VM cluster.

Required when creating a VM cluster.

Required: Conditional

Type: String

Pattern: ^[a-zA-Z_](?!.*--)[a-zA-Z0-9_-]*$

Minimum: 1

Maximum: 255

Update requires: Replacement

GiVersion

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

Required when creating a VM cluster.

Required: Conditional

Type: String

Minimum: 1

Maximum: 255

Update requires: Replacement

Hostname

The host name for the VM cluster.

Required when creating a VM cluster.

Required: Conditional

Type: String

Pattern: ^[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]$

Minimum: 1

Maximum: 12

Update requires: Replacement

IsLocalBackupEnabled

Specifies whether database backups to local Exadata storage are enabled for the VM cluster.

Required: No

Type: Boolean

Update requires: Replacement

IsSparseDiskgroupEnabled

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

Required: No

Type: Boolean

Update requires: Replacement

LicenseModel

The Oracle license model applied to the VM cluster.

Required: No

Type: String

Allowed values: BRING_YOUR_OWN_LICENSE | LICENSE_INCLUDED

Update requires: Replacement

MemorySizeInGBs

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

Required: No

Type: Integer

Update requires: Replacement

OdbNetworkId

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

Required when creating a VM cluster.

Required: Conditional

Type: String

Pattern: (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_~.-]{6,64}|[a-zA-Z0-9_~.-]{6,64})

Minimum: 6

Maximum: 2048

Update requires: Replacement

ScanListenerPortTcp

The port number for TCP connections to the single client access name (SCAN) listener.

Valid values: 1024–8999 with the following exceptions: 2484, 6100, 6200, 7060, 7070, 7085, and 7879

Default: 1521

Required: No

Type: Integer

Minimum: 1024

Maximum: 8999

Update requires: Replacement

SshPublicKeys

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

Required when creating a VM cluster.

Required: Conditional

Type: Array of String

Update requires: Replacement

SystemVersion

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

Required: No

Type: String

Minimum: 1

Maximum: 255

Update requires: Replacement

Tags

Tags to assign to the Vm Cluster.

Required: No

Type: Array of Tag

Update requires: No interruption

TimeZone

The time zone of the VM cluster.

Required: No

Type: String

Minimum: 1

Maximum: 255

Update requires: Replacement

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the unique identifier of the VM cluster. For example:

{ "Ref": "myVmCluster" }

For the VM cluster myVmCluster, Ref returns the unique identifier of the VM cluster.

For more information about using the Ref function, see Ref.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

CloudVmClusterArn: The Amazon Resource Name (ARN) of the VM cluster.
CloudVmClusterId: The unique identifier of the VM cluster.
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.
DiskRedundancy: The type of redundancy configured for the VM cluster. NORMAL is 2-way redundancy. HIGH is 3-way redundancy.
Domain: The domain of the VM cluster.
ListenerPort: The port number configured for the listener on the VM cluster.
NodeCount: The number of nodes in the VM cluster.
Ocid: The OCID of the VM cluster.
OciResourceAnchorName: The name of the OCI resource anchor for the VM cluster.
OciUrl: The HTTPS link to the VM cluster in OCI.
ScanDnsName: The FQDN of the DNS record for the Single Client Access Name (SCAN) IP addresses that are associated with the VM cluster.
ScanIpIds: The OCID of the SCAN IP addresses that are associated with the VM cluster.
Shape: The hardware model name of the Exadata infrastructure that's running the VM cluster.
StorageSizeInGBs: The amount of local node storage, in gigabytes (GB), that's allocated to the VM cluster.
VipIds: 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.

Javascript is disabled or is unavailable in your browser.

To use the Amazon Web Services Documentation, Javascript must be enabled. Please refer to your browser's Help pages for instructions.

Tag

DataCollectionOptions