CreateCloudAutonomousVmCluster - Oracle Database@AWS

CreateCloudAutonomousVmCluster

Creates a new Autonomous VM cluster in the specified Exadata infrastructure.

Request Syntax

{ "autonomousDataStorageSizeInTBs": number, "clientToken": "string", "cloudExadataInfrastructureId": "string", "cpuCoreCountPerNode": number, "dbServers": [ "string" ], "description": "string", "displayName": "string", "isMtlsEnabledVmCluster": boolean, "licenseModel": "string", "maintenanceWindow": { "customActionTimeoutInMins": number, "daysOfWeek": [ { "name": "string" } ], "hoursOfDay": [ number ], "isCustomActionTimeoutEnabled": boolean, "leadTimeInWeeks": number, "months": [ { "name": "string" } ], "patchingMode": "string", "preference": "string", "skipRu": boolean, "weeksOfMonth": [ number ] }, "memoryPerOracleComputeUnitInGBs": number, "odbNetworkId": "string", "scanListenerPortNonTls": number, "scanListenerPortTls": number, "tags": { "string" : "string" }, "timeZone": "string", "totalContainerDatabases": number }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

autonomousDataStorageSizeInTBs

The data disk group size to be allocated for Autonomous Databases, in terabytes (TB).

Type: Double

Valid Range: Minimum value of 0.

Required: Yes

clientToken

A client-provided token to ensure idempotency of the request.

Type: String

Length Constraints: Minimum length of 8. Maximum length of 64.

Pattern: [a-zA-Z0-9_\/.=-]+

Required: No

cloudExadataInfrastructureId

The unique identifier of the Exadata infrastructure where the VM cluster will be created.

Type: String

Length Constraints: Minimum length of 6. Maximum length of 2048.

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})

Required: Yes

cpuCoreCountPerNode

The number of CPU cores to be enabled per VM cluster node.

Type: Integer

Valid Range: Minimum value of 0.

Required: Yes

dbServers

The list of database servers to be used for the Autonomous VM cluster.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 1024 items.

Required: No

description

A user-provided description of the Autonomous VM cluster.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 400.

Required: No

displayName

The display name for the Autonomous VM cluster. The name does not need to be unique.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

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

Required: Yes

isMtlsEnabledVmCluster

Specifies whether to enable mutual TLS (mTLS) authentication for the Autonomous VM cluster.

Type: Boolean

Required: No

licenseModel

The Oracle license model to apply to the Autonomous VM cluster.

Type: String

Valid Values: BRING_YOUR_OWN_LICENSE | LICENSE_INCLUDED

Required: No

maintenanceWindow

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

Type: MaintenanceWindow object

Required: No

memoryPerOracleComputeUnitInGBs

The amount of memory to be allocated per OCPU, in GB.

Type: Integer

Valid Range: Minimum value of 0.

Required: Yes

odbNetworkId

The unique identifier of the ODB network to be used for the VM cluster.

Type: String

Length Constraints: Minimum length of 6. Maximum length of 2048.

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})

Required: Yes

scanListenerPortNonTls

The SCAN listener port for non-TLS (TCP) protocol.

Type: Integer

Valid Range: Minimum value of 1024. Maximum value of 8999.

Required: No

scanListenerPortTls

The SCAN listener port for TLS (TCP) protocol.

Type: Integer

Valid Range: Minimum value of 1024. Maximum value of 8999.

Required: No

tags

Free-form tags for this resource. Each tag is a key-value pair with no predefined name, type, or namespace.

Type: String to string map

Map Entries: Maximum number of 200 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Value Length Constraints: Minimum length of 0. Maximum length of 256.

Required: No

timeZone

The time zone to use for the Autonomous VM cluster.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Required: No

totalContainerDatabases

The total number of Autonomous CDBs that you can create in the Autonomous VM cluster.

Type: Integer

Valid Range: Minimum value of 0.

Required: Yes

Response Syntax

{ "cloudAutonomousVmClusterId": "string", "displayName": "string", "status": "string", "statusReason": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

cloudAutonomousVmClusterId

The unique identifier of the created Autonomous VM cluster.

Type: String

displayName

The display name of the created Autonomous VM cluster.

Type: String

status

The current status of the Autonomous VM cluster creation process.

Type: String

Valid Values: AVAILABLE | FAILED | PROVISIONING | TERMINATED | TERMINATING | UPDATING | MAINTENANCE_IN_PROGRESS

statusReason

Additional information about the current status of the Autonomous VM cluster creation process, if applicable.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You don't have sufficient access to perform this action. Make sure you have the required permissions and try again.

HTTP Status Code: 400

ConflictException

Occurs when a conflict with the current status of your resource. Fix any inconsistencies with your resource and try again.

HTTP Status Code: 400

InternalServerException

Occurs when there is an internal failure in the Oracle Database@AWS service. Wait and try again.

HTTP Status Code: 500

ResourceNotFoundException

The operation tried to access a resource that doesn't exist. Make sure you provided the correct resource and try again.

HTTP Status Code: 400

ServiceQuotaExceededException

You have exceeded the service quota.

HTTP Status Code: 400

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 400

ValidationException

The request has failed validation because it is missing required fields or has invalid inputs.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: