AWS::ODB::CloudAutonomousVmCluster - Amazon CloudFormation
SyntaxPropertiesReturn values
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

This is the new Amazon CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the Amazon CloudFormation User Guide.

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 Amazon CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::ODB::CloudAutonomousVmCluster",
  "Properties" : {
      "AutonomousDataStorageSizeInTBs" : Number,
      "CloudExadataInfrastructureId" : String,
      "CpuCoreCountPerNode" : Integer,
      "DbServers" : [ String, ... ],
      "Description" : String,
      "DisplayName" : String,
      "IsMtlsEnabledVmCluster" : Boolean,
      "LicenseModel" : String,
      "MaintenanceWindow" : MaintenanceWindow,
      "MemoryPerOracleComputeUnitInGBs" : Integer,
      "OdbNetworkId" : String,
      "ScanListenerPortNonTls" : Integer,
      "ScanListenerPortTls" : Integer,
      "Tags" : [ Tag, ... ],
      "TimeZone" : String,
      "TotalContainerDatabases" : Integer
    }
}

YAML

Type: AWS::ODB::CloudAutonomousVmCluster
Properties:
  AutonomousDataStorageSizeInTBs: Number
  CloudExadataInfrastructureId: String
  CpuCoreCountPerNode: Integer
  DbServers: 
    - String
  Description: String
  DisplayName: String
  IsMtlsEnabledVmCluster: Boolean
  LicenseModel: String
  MaintenanceWindow: 
    MaintenanceWindow
  MemoryPerOracleComputeUnitInGBs: Integer
  OdbNetworkId: String
  ScanListenerPortNonTls: Integer
  ScanListenerPortTls: Integer
  Tags: 
    - Tag
  TimeZone: String
  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

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

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

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

Description

The user-provided description of the Autonomous VM cluster.

Required: No

Type: String

Update requires: 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

IsMtlsEnabledVmCluster

Specifies whether mutual TLS (mTLS) authentication is enabled for the Autonomous VM cluster.

Required: No

Type: Boolean

Update requires: 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

MaintenanceWindow

The scheduling details for the maintenance window. Patching and system updates take place during the maintenance window.

Required: No

Type: MaintenanceWindow

Update requires: 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

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

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

ScanListenerPortTls

The SCAN listener port for TLS (TCP) protocol. The default is 2484.

Required: No

Type: Integer

Minimum: 1024

Maximum: 8999

Update requires: Replacement

Tags

Tags to assign to the Autonomous Vm Cluster.

Required: No

Type: Array of Tag

Update requires: No interruption

TimeZone

The time zone of the Autonomous VM cluster.

Required: No

Type: String

Minimum: 1

Maximum: 255

Update requires: 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

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 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.

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.