

This is the new *CloudFormation Template Reference Guide*. Please update your bookmarks and links. For help getting started with CloudFormation, see the [AWS CloudFormation User Guide](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html).

# AWS::ODB::CloudVmCluster
<a name="aws-resource-odb-cloudvmcluster"></a>

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
<a name="aws-resource-odb-cloudvmcluster-syntax"></a>

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

### JSON
<a name="aws-resource-odb-cloudvmcluster-syntax.json"></a>

```
{
  "Type" : "AWS::ODB::CloudVmCluster",
  "Properties" : {
      "[CloudExadataInfrastructureId](#cfn-odb-cloudvmcluster-cloudexadatainfrastructureid)" : String,
      "[ClusterName](#cfn-odb-cloudvmcluster-clustername)" : String,
      "[CpuCoreCount](#cfn-odb-cloudvmcluster-cpucorecount)" : Integer,
      "[DataCollectionOptions](#cfn-odb-cloudvmcluster-datacollectionoptions)" : DataCollectionOptions,
      "[DataStorageSizeInTBs](#cfn-odb-cloudvmcluster-datastoragesizeintbs)" : Number,
      "[DbNodes](#cfn-odb-cloudvmcluster-dbnodes)" : [ DbNode, ... ],
      "[DbNodeStorageSizeInGBs](#cfn-odb-cloudvmcluster-dbnodestoragesizeingbs)" : Integer,
      "[DbServers](#cfn-odb-cloudvmcluster-dbservers)" : [ String, ... ],
      "[DisplayName](#cfn-odb-cloudvmcluster-displayname)" : String,
      "[GiVersion](#cfn-odb-cloudvmcluster-giversion)" : String,
      "[Hostname](#cfn-odb-cloudvmcluster-hostname)" : String,
      "[IamRoles](#cfn-odb-cloudvmcluster-iamroles)" : [ IamRole, ... ],
      "[IsLocalBackupEnabled](#cfn-odb-cloudvmcluster-islocalbackupenabled)" : Boolean,
      "[IsSparseDiskgroupEnabled](#cfn-odb-cloudvmcluster-issparsediskgroupenabled)" : Boolean,
      "[LicenseModel](#cfn-odb-cloudvmcluster-licensemodel)" : String,
      "[MemorySizeInGBs](#cfn-odb-cloudvmcluster-memorysizeingbs)" : Integer,
      "[OdbNetworkId](#cfn-odb-cloudvmcluster-odbnetworkid)" : String,
      "[ScanListenerPortTcp](#cfn-odb-cloudvmcluster-scanlistenerporttcp)" : Integer,
      "[SshPublicKeys](#cfn-odb-cloudvmcluster-sshpublickeys)" : [ String, ... ],
      "[SystemVersion](#cfn-odb-cloudvmcluster-systemversion)" : String,
      "[Tags](#cfn-odb-cloudvmcluster-tags)" : [ Tag, ... ],
      "[TimeZone](#cfn-odb-cloudvmcluster-timezone)" : String
    }
}
```

### YAML
<a name="aws-resource-odb-cloudvmcluster-syntax.yaml"></a>

```
Type: AWS::ODB::CloudVmCluster
Properties:
  [CloudExadataInfrastructureId](#cfn-odb-cloudvmcluster-cloudexadatainfrastructureid): String
  [ClusterName](#cfn-odb-cloudvmcluster-clustername): String
  [CpuCoreCount](#cfn-odb-cloudvmcluster-cpucorecount): Integer
  [DataCollectionOptions](#cfn-odb-cloudvmcluster-datacollectionoptions): 
    DataCollectionOptions
  [DataStorageSizeInTBs](#cfn-odb-cloudvmcluster-datastoragesizeintbs): Number
  [DbNodes](#cfn-odb-cloudvmcluster-dbnodes): 
    - DbNode
  [DbNodeStorageSizeInGBs](#cfn-odb-cloudvmcluster-dbnodestoragesizeingbs): Integer
  [DbServers](#cfn-odb-cloudvmcluster-dbservers): 
    - String
  [DisplayName](#cfn-odb-cloudvmcluster-displayname): String
  [GiVersion](#cfn-odb-cloudvmcluster-giversion): String
  [Hostname](#cfn-odb-cloudvmcluster-hostname): String
  [IamRoles](#cfn-odb-cloudvmcluster-iamroles): 
    - IamRole
  [IsLocalBackupEnabled](#cfn-odb-cloudvmcluster-islocalbackupenabled): Boolean
  [IsSparseDiskgroupEnabled](#cfn-odb-cloudvmcluster-issparsediskgroupenabled): Boolean
  [LicenseModel](#cfn-odb-cloudvmcluster-licensemodel): String
  [MemorySizeInGBs](#cfn-odb-cloudvmcluster-memorysizeingbs): Integer
  [OdbNetworkId](#cfn-odb-cloudvmcluster-odbnetworkid): String
  [ScanListenerPortTcp](#cfn-odb-cloudvmcluster-scanlistenerporttcp): Integer
  [SshPublicKeys](#cfn-odb-cloudvmcluster-sshpublickeys): 
    - String
  [SystemVersion](#cfn-odb-cloudvmcluster-systemversion): String
  [Tags](#cfn-odb-cloudvmcluster-tags): 
    - Tag
  [TimeZone](#cfn-odb-cloudvmcluster-timezone): String
```

## Properties
<a name="aws-resource-odb-cloudvmcluster-properties"></a>

`CloudExadataInfrastructureId`  <a name="cfn-odb-cloudvmcluster-cloudexadatainfrastructureid"></a>
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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`ClusterName`  <a name="cfn-odb-cloudvmcluster-clustername"></a>
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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`CpuCoreCount`  <a name="cfn-odb-cloudvmcluster-cpucorecount"></a>
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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`DataCollectionOptions`  <a name="cfn-odb-cloudvmcluster-datacollectionoptions"></a>
The set of diagnostic collection options enabled for the VM cluster.  
*Required*: No  
*Type*: [DataCollectionOptions](aws-properties-odb-cloudvmcluster-datacollectionoptions.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`DataStorageSizeInTBs`  <a name="cfn-odb-cloudvmcluster-datastoragesizeintbs"></a>
The size of the data disk group, in terabytes (TB), that's allocated for the VM cluster.  
*Required*: No  
*Type*: Number  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`DbNodes`  <a name="cfn-odb-cloudvmcluster-dbnodes"></a>
Property description not available.  
*Required*: No  
*Type*: Array of [DbNode](aws-properties-odb-cloudvmcluster-dbnode.md)  
*Minimum*: `1`  
*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)

`DbNodeStorageSizeInGBs`  <a name="cfn-odb-cloudvmcluster-dbnodestoragesizeingbs"></a>
The amount of local node storage, in gigabytes (GB), that's allocated for the VM cluster.  
*Required*: No  
*Type*: Integer  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`DbServers`  <a name="cfn-odb-cloudvmcluster-dbservers"></a>
The list of database servers for the VM cluster.  
*Required*: No  
*Type*: Array of String  
*Minimum*: `1`  
*Maximum*: `1024`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`DisplayName`  <a name="cfn-odb-cloudvmcluster-displayname"></a>
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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`GiVersion`  <a name="cfn-odb-cloudvmcluster-giversion"></a>
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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Hostname`  <a name="cfn-odb-cloudvmcluster-hostname"></a>
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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`IamRoles`  <a name="cfn-odb-cloudvmcluster-iamroles"></a>
The AWS Identity and Access Management (IAM) service roles associated with the VM cluster.  
*Required*: No  
*Type*: Array of [IamRole](aws-properties-odb-cloudvmcluster-iamrole.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`IsLocalBackupEnabled`  <a name="cfn-odb-cloudvmcluster-islocalbackupenabled"></a>
Specifies whether database backups to local Exadata storage are enabled for the VM cluster.  
*Required*: No  
*Type*: Boolean  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`IsSparseDiskgroupEnabled`  <a name="cfn-odb-cloudvmcluster-issparsediskgroupenabled"></a>
Specifies whether the VM cluster is configured with a sparse disk group.  
*Required*: No  
*Type*: Boolean  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`LicenseModel`  <a name="cfn-odb-cloudvmcluster-licensemodel"></a>
The Oracle license model applied to the VM cluster.  
*Required*: No  
*Type*: String  
*Allowed values*: `BRING_YOUR_OWN_LICENSE | LICENSE_INCLUDED`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`MemorySizeInGBs`  <a name="cfn-odb-cloudvmcluster-memorysizeingbs"></a>
The amount of memory, in gigabytes (GB), that's allocated for the VM cluster.  
*Required*: No  
*Type*: Integer  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`OdbNetworkId`  <a name="cfn-odb-cloudvmcluster-odbnetworkid"></a>
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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`ScanListenerPortTcp`  <a name="cfn-odb-cloudvmcluster-scanlistenerporttcp"></a>
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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`SshPublicKeys`  <a name="cfn-odb-cloudvmcluster-sshpublickeys"></a>
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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`SystemVersion`  <a name="cfn-odb-cloudvmcluster-systemversion"></a>
The operating system version of the image chosen for the VM cluster.  
*Required*: No  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `255`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Tags`  <a name="cfn-odb-cloudvmcluster-tags"></a>
Tags to assign to the Vm Cluster.  
*Required*: No  
*Type*: Array of [Tag](aws-properties-odb-cloudvmcluster-tag.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`TimeZone`  <a name="cfn-odb-cloudvmcluster-timezone"></a>
The time zone of the VM cluster.  
*Required*: No  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `255`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

## Return values
<a name="aws-resource-odb-cloudvmcluster-return-values"></a>

### Ref
<a name="aws-resource-odb-cloudvmcluster-return-values-ref"></a>

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 [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).

### Fn::GetAtt
<a name="aws-resource-odb-cloudvmcluster-return-values-fn--getatt"></a>

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.

#### 
<a name="aws-resource-odb-cloudvmcluster-return-values-fn--getatt-fn--getatt"></a>

`CloudVmClusterArn`  <a name="CloudVmClusterArn-fn::getatt"></a>
The Amazon Resource Name (ARN) of the VM cluster.

`CloudVmClusterId`  <a name="CloudVmClusterId-fn::getatt"></a>
The unique identifier of the VM cluster.

`ComputeModel`  <a name="ComputeModel-fn::getatt"></a>
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`  <a name="DiskRedundancy-fn::getatt"></a>
The type of redundancy configured for the VM cluster. `NORMAL` is 2-way redundancy. `HIGH` is 3-way redundancy.

`Domain`  <a name="Domain-fn::getatt"></a>
The domain of the VM cluster.

`ListenerPort`  <a name="ListenerPort-fn::getatt"></a>
The port number configured for the listener on the VM cluster.

`NodeCount`  <a name="NodeCount-fn::getatt"></a>
The number of nodes in the VM cluster.

`Ocid`  <a name="Ocid-fn::getatt"></a>
The OCID of the VM cluster.

`OciResourceAnchorName`  <a name="OciResourceAnchorName-fn::getatt"></a>
The name of the OCI resource anchor for the VM cluster.

`OciUrl`  <a name="OciUrl-fn::getatt"></a>
The HTTPS link to the VM cluster in OCI.

`ScanDnsName`  <a name="ScanDnsName-fn::getatt"></a>
The FQDN of the DNS record for the Single Client Access Name (SCAN) IP addresses that are associated with the VM cluster.

`ScanIpIds`  <a name="ScanIpIds-fn::getatt"></a>
The OCID of the SCAN IP addresses that are associated with the VM cluster.

`Shape`  <a name="Shape-fn::getatt"></a>
The hardware model name of the Exadata infrastructure that's running the VM cluster.

`StorageSizeInGBs`  <a name="StorageSizeInGBs-fn::getatt"></a>
The amount of local node storage, in gigabytes (GB), that's allocated to the VM cluster.

`VipIds`  <a name="VipIds-fn::getatt"></a>
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.

# AWS::ODB::CloudVmCluster DataCollectionOptions
<a name="aws-properties-odb-cloudvmcluster-datacollectionoptions"></a>

Information about the data collection options enabled for a VM cluster.

## Syntax
<a name="aws-properties-odb-cloudvmcluster-datacollectionoptions-syntax"></a>

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

### JSON
<a name="aws-properties-odb-cloudvmcluster-datacollectionoptions-syntax.json"></a>

```
{
  "[IsDiagnosticsEventsEnabled](#cfn-odb-cloudvmcluster-datacollectionoptions-isdiagnosticseventsenabled)" : Boolean,
  "[IsHealthMonitoringEnabled](#cfn-odb-cloudvmcluster-datacollectionoptions-ishealthmonitoringenabled)" : Boolean,
  "[IsIncidentLogsEnabled](#cfn-odb-cloudvmcluster-datacollectionoptions-isincidentlogsenabled)" : Boolean
}
```

### YAML
<a name="aws-properties-odb-cloudvmcluster-datacollectionoptions-syntax.yaml"></a>

```
  [IsDiagnosticsEventsEnabled](#cfn-odb-cloudvmcluster-datacollectionoptions-isdiagnosticseventsenabled): Boolean
  [IsHealthMonitoringEnabled](#cfn-odb-cloudvmcluster-datacollectionoptions-ishealthmonitoringenabled): Boolean
  [IsIncidentLogsEnabled](#cfn-odb-cloudvmcluster-datacollectionoptions-isincidentlogsenabled): Boolean
```

## Properties
<a name="aws-properties-odb-cloudvmcluster-datacollectionoptions-properties"></a>

`IsDiagnosticsEventsEnabled`  <a name="cfn-odb-cloudvmcluster-datacollectionoptions-isdiagnosticseventsenabled"></a>
Specifies whether diagnostic collection is enabled for the VM cluster.  
*Required*: No  
*Type*: Boolean  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`IsHealthMonitoringEnabled`  <a name="cfn-odb-cloudvmcluster-datacollectionoptions-ishealthmonitoringenabled"></a>
Specifies whether health monitoring is enabled for the VM cluster.  
*Required*: No  
*Type*: Boolean  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`IsIncidentLogsEnabled`  <a name="cfn-odb-cloudvmcluster-datacollectionoptions-isincidentlogsenabled"></a>
Specifies whether incident logs are enabled for the VM cluster.  
*Required*: No  
*Type*: Boolean  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

# AWS::ODB::CloudVmCluster DbNode
<a name="aws-properties-odb-cloudvmcluster-dbnode"></a>

Information about a DB node.

## Syntax
<a name="aws-properties-odb-cloudvmcluster-dbnode-syntax"></a>

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

### JSON
<a name="aws-properties-odb-cloudvmcluster-dbnode-syntax.json"></a>

```
{
  "[BackupIpId](#cfn-odb-cloudvmcluster-dbnode-backupipid)" : String,
  "[BackupVnic2Id](#cfn-odb-cloudvmcluster-dbnode-backupvnic2id)" : String,
  "[CpuCoreCount](#cfn-odb-cloudvmcluster-dbnode-cpucorecount)" : Integer,
  "[DbNodeArn](#cfn-odb-cloudvmcluster-dbnode-dbnodearn)" : String,
  "[DbNodeId](#cfn-odb-cloudvmcluster-dbnode-dbnodeid)" : String,
  "[DbNodeStorageSizeInGBs](#cfn-odb-cloudvmcluster-dbnode-dbnodestoragesizeingbs)" : Integer,
  "[DbServerId](#cfn-odb-cloudvmcluster-dbnode-dbserverid)" : String,
  "[DbSystemId](#cfn-odb-cloudvmcluster-dbnode-dbsystemid)" : String,
  "[HostIpId](#cfn-odb-cloudvmcluster-dbnode-hostipid)" : String,
  "[Hostname](#cfn-odb-cloudvmcluster-dbnode-hostname)" : String,
  "[MemorySizeInGBs](#cfn-odb-cloudvmcluster-dbnode-memorysizeingbs)" : Integer,
  "[Ocid](#cfn-odb-cloudvmcluster-dbnode-ocid)" : String,
  "[Status](#cfn-odb-cloudvmcluster-dbnode-status)" : String,
  "[Tags](#cfn-odb-cloudvmcluster-dbnode-tags)" : [ Tag, ... ],
  "[Vnic2Id](#cfn-odb-cloudvmcluster-dbnode-vnic2id)" : String,
  "[VnicId](#cfn-odb-cloudvmcluster-dbnode-vnicid)" : String
}
```

### YAML
<a name="aws-properties-odb-cloudvmcluster-dbnode-syntax.yaml"></a>

```
  [BackupIpId](#cfn-odb-cloudvmcluster-dbnode-backupipid): String
  [BackupVnic2Id](#cfn-odb-cloudvmcluster-dbnode-backupvnic2id): String
  [CpuCoreCount](#cfn-odb-cloudvmcluster-dbnode-cpucorecount): Integer
  [DbNodeArn](#cfn-odb-cloudvmcluster-dbnode-dbnodearn): String
  [DbNodeId](#cfn-odb-cloudvmcluster-dbnode-dbnodeid): String
  [DbNodeStorageSizeInGBs](#cfn-odb-cloudvmcluster-dbnode-dbnodestoragesizeingbs): Integer
  [DbServerId](#cfn-odb-cloudvmcluster-dbnode-dbserverid): String
  [DbSystemId](#cfn-odb-cloudvmcluster-dbnode-dbsystemid): String
  [HostIpId](#cfn-odb-cloudvmcluster-dbnode-hostipid): String
  [Hostname](#cfn-odb-cloudvmcluster-dbnode-hostname): String
  [MemorySizeInGBs](#cfn-odb-cloudvmcluster-dbnode-memorysizeingbs): Integer
  [Ocid](#cfn-odb-cloudvmcluster-dbnode-ocid): String
  [Status](#cfn-odb-cloudvmcluster-dbnode-status): String
  [Tags](#cfn-odb-cloudvmcluster-dbnode-tags): 
    - Tag
  [Vnic2Id](#cfn-odb-cloudvmcluster-dbnode-vnic2id): String
  [VnicId](#cfn-odb-cloudvmcluster-dbnode-vnicid): String
```

## Properties
<a name="aws-properties-odb-cloudvmcluster-dbnode-properties"></a>

`BackupIpId`  <a name="cfn-odb-cloudvmcluster-dbnode-backupipid"></a>
The Oracle Cloud ID (OCID) of the backup IP address that's associated with the DB node.  
*Required*: No  
*Type*: String  
*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)

`BackupVnic2Id`  <a name="cfn-odb-cloudvmcluster-dbnode-backupvnic2id"></a>
The OCID of the second backup VNIC.  
*Required*: No  
*Type*: String  
*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)

`CpuCoreCount`  <a name="cfn-odb-cloudvmcluster-dbnode-cpucorecount"></a>
Number of CPU cores enabled on the DB node.  
*Required*: No  
*Type*: Integer  
*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)

`DbNodeArn`  <a name="cfn-odb-cloudvmcluster-dbnode-dbnodearn"></a>
The Amazon Resource Name (ARN) of the DB node.  
*Required*: No  
*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-z0-9-_]{6,64}`  
*Minimum*: `20`  
*Maximum*: `2048`  
*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)

`DbNodeId`  <a name="cfn-odb-cloudvmcluster-dbnode-dbnodeid"></a>
The unique identifier of the DB node.  
*Required*: No  
*Type*: String  
*Pattern*: `[a-zA-Z0-9_~.-]+`  
*Minimum*: `6`  
*Maximum*: `64`  
*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)

`DbNodeStorageSizeInGBs`  <a name="cfn-odb-cloudvmcluster-dbnode-dbnodestoragesizeingbs"></a>
The amount of local node storage, in gigabytes (GBs), that's allocated on the DB node.  
*Required*: No  
*Type*: Integer  
*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)

`DbServerId`  <a name="cfn-odb-cloudvmcluster-dbnode-dbserverid"></a>
The unique identifier of the Db server that is associated with the DB node.  
*Required*: Yes  
*Type*: String  
*Pattern*: `[a-zA-Z0-9_~.-]+`  
*Minimum*: `6`  
*Maximum*: `64`  


`DbSystemId`  <a name="cfn-odb-cloudvmcluster-dbnode-dbsystemid"></a>
The OCID of the DB system.  
*Required*: No  
*Type*: String  
*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)

`HostIpId`  <a name="cfn-odb-cloudvmcluster-dbnode-hostipid"></a>
The OCID of the host IP address that's associated with the DB node.  
*Required*: No  
*Type*: String  
*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)

`Hostname`  <a name="cfn-odb-cloudvmcluster-dbnode-hostname"></a>
The host name for the DB node.  
*Required*: No  
*Type*: String  
*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)

`MemorySizeInGBs`  <a name="cfn-odb-cloudvmcluster-dbnode-memorysizeingbs"></a>
The allocated memory in GBs on the DB node.  
*Required*: No  
*Type*: Integer  
*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)

`Ocid`  <a name="cfn-odb-cloudvmcluster-dbnode-ocid"></a>
The OCID of the DB node.  
*Required*: No  
*Type*: String  
*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)

`Status`  <a name="cfn-odb-cloudvmcluster-dbnode-status"></a>
The current status of the DB node.  
*Required*: No  
*Type*: String  
*Allowed values*: `AVAILABLE | FAILED | PROVISIONING | TERMINATED | TERMINATING | UPDATING | STOPPING | STOPPED | STARTING`  
*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)

`Tags`  <a name="cfn-odb-cloudvmcluster-dbnode-tags"></a>
Property description not available.  
*Required*: No  
*Type*: Array of [Tag](aws-properties-odb-cloudvmcluster-tag.md)  
*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)

`Vnic2Id`  <a name="cfn-odb-cloudvmcluster-dbnode-vnic2id"></a>
The OCID of the second VNIC.  
*Required*: No  
*Type*: String  
*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)

`VnicId`  <a name="cfn-odb-cloudvmcluster-dbnode-vnicid"></a>
The OCID of the VNIC.  
*Required*: No  
*Type*: String  
*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)

# AWS::ODB::CloudVmCluster IamRole
<a name="aws-properties-odb-cloudvmcluster-iamrole"></a>

Information about an AWS Identity and Access Management (IAM) service role associated with a resource.

## Syntax
<a name="aws-properties-odb-cloudvmcluster-iamrole-syntax"></a>

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

### JSON
<a name="aws-properties-odb-cloudvmcluster-iamrole-syntax.json"></a>

```
{
  "[AwsIntegration](#cfn-odb-cloudvmcluster-iamrole-awsintegration)" : String,
  "[IamRoleArn](#cfn-odb-cloudvmcluster-iamrole-iamrolearn)" : String,
  "[Status](#cfn-odb-cloudvmcluster-iamrole-status)" : String
}
```

### YAML
<a name="aws-properties-odb-cloudvmcluster-iamrole-syntax.yaml"></a>

```
  [AwsIntegration](#cfn-odb-cloudvmcluster-iamrole-awsintegration): String
  [IamRoleArn](#cfn-odb-cloudvmcluster-iamrole-iamrolearn): String
  [Status](#cfn-odb-cloudvmcluster-iamrole-status): String
```

## Properties
<a name="aws-properties-odb-cloudvmcluster-iamrole-properties"></a>

`AwsIntegration`  <a name="cfn-odb-cloudvmcluster-iamrole-awsintegration"></a>
The AWS integration configuration settings for the AWS Identity and Access Management (IAM) service role.  
*Required*: No  
*Type*: String  
*Allowed values*: `KmsTde`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`IamRoleArn`  <a name="cfn-odb-cloudvmcluster-iamrole-iamrolearn"></a>
The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) service role.  
*Required*: No  
*Type*: String  
*Pattern*: `arn:(?:aws|aws-cn|aws-us-gov|aws-iso-{0,1}[a-z]{0,1}):iam::[0-9]{12}:role/.+`  
*Minimum*: `20`  
*Maximum*: `2048`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Status`  <a name="cfn-odb-cloudvmcluster-iamrole-status"></a>
The current status of the AWS Identity and Access Management (IAM) service role.  
*Required*: No  
*Type*: String  
*Allowed values*: `ASSOCIATING | DISASSOCIATING | FAILED | CONNECTED | DISCONNECTED | PARTIALLY_CONNECTED | UNKNOWN`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::ODB::CloudVmCluster Tag
<a name="aws-properties-odb-cloudvmcluster-tag"></a>

A key-value pair to associate with a resource.

## Syntax
<a name="aws-properties-odb-cloudvmcluster-tag-syntax"></a>

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

### JSON
<a name="aws-properties-odb-cloudvmcluster-tag-syntax.json"></a>

```
{
  "[Key](#cfn-odb-cloudvmcluster-tag-key)" : String,
  "[Value](#cfn-odb-cloudvmcluster-tag-value)" : String
}
```

### YAML
<a name="aws-properties-odb-cloudvmcluster-tag-syntax.yaml"></a>

```
  [Key](#cfn-odb-cloudvmcluster-tag-key): String
  [Value](#cfn-odb-cloudvmcluster-tag-value): String
```

## Properties
<a name="aws-properties-odb-cloudvmcluster-tag-properties"></a>

`Key`  <a name="cfn-odb-cloudvmcluster-tag-key"></a>
The key name of the tag. You can specify a value that's 1 to 128 Unicode characters in length and can't be prefixed with `aws:`. You can use any of the following characters: the set of Unicode letters, digits, whitespace, `_`, `.`, `:`, `/`, `=`, `+`, `@`, `-`, and `"`.  
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `128`  
*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)

`Value`  <a name="cfn-odb-cloudvmcluster-tag-value"></a>
The value for the tag. You can specify a value that's 1 to 256 characters in length. You can use any of the following characters: the set of Unicode letters, digits, whitespace, `_`, `.`, `/`, `=`, `+`, and `-`.  
*Required*: No  
*Type*: String  
*Minimum*: `0`  
*Maximum*: `256`  
*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)