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::CloudAutonomousVmCluster The `AWS::ODB::CloudAutonomousVmCluster` resource creates an Autonomous VM cluster. An Autonomous VM cluster provides the infrastructure for running Autonomous Databases. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "Type" : "AWS::ODB::CloudAutonomousVmCluster", "Properties" : { "[AutonomousDataStorageSizeInTBs](#cfn-odb-cloudautonomousvmcluster-autonomousdatastoragesizeintbs)" : Number, "[CloudExadataInfrastructureId](#cfn-odb-cloudautonomousvmcluster-cloudexadatainfrastructureid)" : String, "[CpuCoreCountPerNode](#cfn-odb-cloudautonomousvmcluster-cpucorecountpernode)" : Integer, "[DbServers](#cfn-odb-cloudautonomousvmcluster-dbservers)" : [ String, ... ], "[Description](#cfn-odb-cloudautonomousvmcluster-description)" : String, "[DisplayName](#cfn-odb-cloudautonomousvmcluster-displayname)" : String, "[IamRoles](#cfn-odb-cloudautonomousvmcluster-iamroles)" : [ IamRole, ... ], "[IsMtlsEnabledVmCluster](#cfn-odb-cloudautonomousvmcluster-ismtlsenabledvmcluster)" : Boolean, "[LicenseModel](#cfn-odb-cloudautonomousvmcluster-licensemodel)" : String, "[MaintenanceWindow](#cfn-odb-cloudautonomousvmcluster-maintenancewindow)" : MaintenanceWindow, "[MemoryPerOracleComputeUnitInGBs](#cfn-odb-cloudautonomousvmcluster-memoryperoraclecomputeunitingbs)" : Integer, "[OdbNetworkId](#cfn-odb-cloudautonomousvmcluster-odbnetworkid)" : String, "[ScanListenerPortNonTls](#cfn-odb-cloudautonomousvmcluster-scanlistenerportnontls)" : Integer, "[ScanListenerPortTls](#cfn-odb-cloudautonomousvmcluster-scanlistenerporttls)" : Integer, "[Tags](#cfn-odb-cloudautonomousvmcluster-tags)" : [ Tag, ... ], "[TimeZone](#cfn-odb-cloudautonomousvmcluster-timezone)" : String, "[TotalContainerDatabases](#cfn-odb-cloudautonomousvmcluster-totalcontainerdatabases)" : Integer } } ``` ### YAML ``` Type: AWS::ODB::CloudAutonomousVmCluster Properties: [AutonomousDataStorageSizeInTBs](#cfn-odb-cloudautonomousvmcluster-autonomousdatastoragesizeintbs): Number [CloudExadataInfrastructureId](#cfn-odb-cloudautonomousvmcluster-cloudexadatainfrastructureid): String [CpuCoreCountPerNode](#cfn-odb-cloudautonomousvmcluster-cpucorecountpernode): Integer [DbServers](#cfn-odb-cloudautonomousvmcluster-dbservers): - String [Description](#cfn-odb-cloudautonomousvmcluster-description): String [DisplayName](#cfn-odb-cloudautonomousvmcluster-displayname): String [IamRoles](#cfn-odb-cloudautonomousvmcluster-iamroles): - IamRole [IsMtlsEnabledVmCluster](#cfn-odb-cloudautonomousvmcluster-ismtlsenabledvmcluster): Boolean [LicenseModel](#cfn-odb-cloudautonomousvmcluster-licensemodel): String [MaintenanceWindow](#cfn-odb-cloudautonomousvmcluster-maintenancewindow): MaintenanceWindow [MemoryPerOracleComputeUnitInGBs](#cfn-odb-cloudautonomousvmcluster-memoryperoraclecomputeunitingbs): Integer [OdbNetworkId](#cfn-odb-cloudautonomousvmcluster-odbnetworkid): String [ScanListenerPortNonTls](#cfn-odb-cloudautonomousvmcluster-scanlistenerportnontls): Integer [ScanListenerPortTls](#cfn-odb-cloudautonomousvmcluster-scanlistenerporttls): Integer [Tags](#cfn-odb-cloudautonomousvmcluster-tags): - Tag [TimeZone](#cfn-odb-cloudautonomousvmcluster-timezone): String [TotalContainerDatabases](#cfn-odb-cloudautonomousvmcluster-totalcontainerdatabases): Integer ``` ## Properties `AutonomousDataStorageSizeInTBs` The data storage size allocated for Autonomous Databases in the Autonomous VM cluster, in TB. Required when creating an Autonomous VM cluster. *Required*: Conditional *Type*: Number *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `CloudExadataInfrastructureId` The unique identifier of the Cloud Exadata Infrastructure containing this Autonomous VM cluster. Required when creating an Autonomous 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) `CpuCoreCountPerNode` The number of CPU cores enabled per node in the Autonomous VM cluster. Required when creating an Autonomous VM cluster. *Required*: Conditional *Type*: Integer *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `DbServers` The list of database servers associated with the Autonomous 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) `Description` The user-provided description of the Autonomous VM cluster. *Required*: No *Type*: String *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `DisplayName` The display name of the Autonomous VM cluster. Required when creating an Autonomous 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) `IamRoles` The AWS Identity and Access Management (IAM) service roles associated with the Autonomous VM cluster. *Required*: No *Type*: Array of [IamRole](aws-properties-odb-cloudautonomousvmcluster-iamrole.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `IsMtlsEnabledVmCluster` Specifies whether mutual TLS (mTLS) authentication is enabled for the Autonomous 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) `LicenseModel` The Oracle license model that applies to the Autonomous VM cluster. Valid values are `LICENSE_INCLUDED` or `BRING_YOUR_OWN_LICENSE`. *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) `MaintenanceWindow` The scheduling details for the maintenance window. Patching and system updates take place during the maintenance window. *Required*: No *Type*: [MaintenanceWindow](aws-properties-odb-cloudautonomousvmcluster-maintenancewindow.md) *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `MemoryPerOracleComputeUnitInGBs` The amount of memory allocated per Oracle Compute Unit, in GB. Required when creating an Autonomous VM cluster. *Required*: Conditional *Type*: Integer *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `OdbNetworkId` The unique identifier of the ODB network associated with this Autonomous VM cluster. Required when creating an Autonomous 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) `ScanListenerPortNonTls` The SCAN listener port for non-TLS (TCP) protocol. The default is 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) `ScanListenerPortTls` The SCAN listener port for TLS (TCP) protocol. The default is 2484. *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) `Tags` Tags to assign to the Autonomous Vm Cluster. *Required*: No *Type*: Array of [Tag](aws-properties-odb-cloudautonomousvmcluster-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` The time zone of the Autonomous 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) `TotalContainerDatabases` The total number of Autonomous Container Databases that can be created with the allocated local storage. Required when creating an Autonomous VM cluster. *Required*: Conditional *Type*: Integer *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-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 Autonomous VM cluster. For example: `{ "Ref": "myAutonomousVmCluster" }` For the Autonomous VM cluster `myAutonomousVmCluster`, `Ref` returns the unique identifier of the Autonomous 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 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. #### `AutonomousDataStoragePercentage` The percentage of data storage currently in use for Autonomous Databases in the Autonomous VM cluster. `AvailableAutonomousDataStorageSizeInTBs` The available data storage space for Autonomous Databases in the Autonomous VM cluster, in TB. `AvailableContainerDatabases` The number of Autonomous CDBs that you can create with the currently available storage. `AvailableCpus` The number of CPU cores available for allocation to Autonomous Databases. `CloudAutonomousVmClusterArn` The Amazon Resource Name (ARN) for the Autonomous VM cluster. `CloudAutonomousVmClusterId` The unique identifier of the Autonomous VM cluster. `ComputeModel` The compute model of the Autonomous VM cluster: ECPU or OCPU. `CpuCoreCount` The total number of CPU cores in the Autonomous VM cluster. `CpuPercentage` The percentage of total CPU cores currently in use in the Autonomous VM cluster. `DataStorageSizeInGBs` The total data storage allocated to the Autonomous VM cluster, in GB. `DataStorageSizeInTBs` The total data storage allocated to the Autonomous VM cluster, in TB. `DbNodeStorageSizeInGBs` The local node storage allocated to the Autonomous VM cluster, in gigabytes (GB). `Domain` The domain name for the Autonomous VM cluster. `ExadataStorageInTBsLowestScaledValue` The minimum value to which you can scale down the Exadata storage, in TB. `Hostname` The hostname for the Autonomous VM cluster. `MaxAcdsLowestScaledValue` The minimum value to which you can scale down the maximum number of Autonomous CDBs. `MemorySizeInGBs` The total amount of memory allocated to the Autonomous VM cluster, in gigabytes (GB). `NodeCount` The number of database server nodes in the Autonomous VM cluster. `NonProvisionableAutonomousContainerDatabases` The number of Autonomous CDBs that can't be provisioned because of resource constraints. `Ocid` The Oracle Cloud Identifier (OCID) of the Autonomous VM cluster. `OciResourceAnchorName` The name of the OCI resource anchor associated with this Autonomous VM cluster. `OciUrl` The URL for accessing the OCI console page for this Autonomous VM cluster. `ProvisionableAutonomousContainerDatabases` The number of Autonomous CDBs that can be provisioned in the Autonomous VM cluster. `ProvisionedAutonomousContainerDatabases` The number of Autonomous CDBs currently provisioned in the Autonomous VM cluster. `ProvisionedCpus` The number of CPU cores currently provisioned in the Autonomous VM cluster. `ReclaimableCpus` The number of CPU cores that can be reclaimed from terminated or scaled-down Autonomous Databases. `ReservedCpus` The number of CPU cores reserved for system operations and redundancy. `Shape` The shape of the Exadata infrastructure for the Autonomous VM cluster. # AWS::ODB::CloudAutonomousVmCluster IamRole Information about an AWS Identity and Access Management (IAM) service role associated with a resource. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[AwsIntegration](#cfn-odb-cloudautonomousvmcluster-iamrole-awsintegration)" : String, "[IamRoleArn](#cfn-odb-cloudautonomousvmcluster-iamrole-iamrolearn)" : String, "[Status](#cfn-odb-cloudautonomousvmcluster-iamrole-status)" : String } ``` ### YAML ``` [AwsIntegration](#cfn-odb-cloudautonomousvmcluster-iamrole-awsintegration): String [IamRoleArn](#cfn-odb-cloudautonomousvmcluster-iamrole-iamrolearn): String [Status](#cfn-odb-cloudautonomousvmcluster-iamrole-status): String ``` ## Properties `AwsIntegration` 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` 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` 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::CloudAutonomousVmCluster MaintenanceWindow The scheduling details for the maintenance window. Patching and system updates take place during the maintenance window. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[DaysOfWeek](#cfn-odb-cloudautonomousvmcluster-maintenancewindow-daysofweek)" : [ String, ... ], "[HoursOfDay](#cfn-odb-cloudautonomousvmcluster-maintenancewindow-hoursofday)" : [ Integer, ... ], "[LeadTimeInWeeks](#cfn-odb-cloudautonomousvmcluster-maintenancewindow-leadtimeinweeks)" : Integer, "[Months](#cfn-odb-cloudautonomousvmcluster-maintenancewindow-months)" : [ String, ... ], "[Preference](#cfn-odb-cloudautonomousvmcluster-maintenancewindow-preference)" : String, "[WeeksOfMonth](#cfn-odb-cloudautonomousvmcluster-maintenancewindow-weeksofmonth)" : [ Integer, ... ] } ``` ### YAML ``` [DaysOfWeek](#cfn-odb-cloudautonomousvmcluster-maintenancewindow-daysofweek): - String [HoursOfDay](#cfn-odb-cloudautonomousvmcluster-maintenancewindow-hoursofday): - Integer [LeadTimeInWeeks](#cfn-odb-cloudautonomousvmcluster-maintenancewindow-leadtimeinweeks): Integer [Months](#cfn-odb-cloudautonomousvmcluster-maintenancewindow-months): - String [Preference](#cfn-odb-cloudautonomousvmcluster-maintenancewindow-preference): String [WeeksOfMonth](#cfn-odb-cloudautonomousvmcluster-maintenancewindow-weeksofmonth): - Integer ``` ## Properties `DaysOfWeek` The days of the week when maintenance can be performed. *Required*: No *Type*: Array of String *Allowed values*: `MONDAY | TUESDAY | WEDNESDAY | THURSDAY | FRIDAY | SATURDAY | SUNDAY` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `HoursOfDay` The hours of the day when maintenance can be performed. *Required*: No *Type*: Array of Integer *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `LeadTimeInWeeks` The lead time in weeks before the maintenance window. *Required*: No *Type*: Integer *Minimum*: `1` *Maximum*: `4` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `Months` The months when maintenance can be performed. *Required*: No *Type*: Array of String *Allowed values*: `JANUARY | FEBRUARY | MARCH | APRIL | MAY | JUNE | JULY | AUGUST | SEPTEMBER | OCTOBER | NOVEMBER | DECEMBER` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `Preference` The preference for the maintenance window scheduling. *Required*: No *Type*: String *Allowed values*: `NO_PREFERENCE | CUSTOM_PREFERENCE` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `WeeksOfMonth` The weeks of the month when maintenance can be performed. *Required*: No *Type*: Array of Integer *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) # AWS::ODB::CloudAutonomousVmCluster Tag A key-value pair to associate with a resource. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Key](#cfn-odb-cloudautonomousvmcluster-tag-key)" : String, "[Value](#cfn-odb-cloudautonomousvmcluster-tag-value)" : String } ``` ### YAML ``` [Key](#cfn-odb-cloudautonomousvmcluster-tag-key): String [Value](#cfn-odb-cloudautonomousvmcluster-tag-value): String ``` ## Properties `Key` 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*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Value` 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*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)