Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

CreateExadbVmCluster

Creates an Exascale VM cluster.

Request Syntax


{
   "clientToken": "string",
   "clusterName": "string",
   "dataCollectionOptions": { 
      "isDiagnosticsEventsEnabled": boolean,
      "isHealthMonitoringEnabled": boolean,
      "isIncidentLogsEnabled": boolean
   },
   "displayName": "string",
   "enabledEcpuCount": number,
   "exascaleDbStorageVaultId": "string",
   "gridImageId": "string",
   "hostname": "string",
   "licenseModel": "string",
   "nodeCount": number,
   "odbNetworkId": "string",
   "scanListenerPortTcp": number,
   "scanListenerPortTcpSsl": number,
   "shape": "string",
   "shapeAttribute": "string",
   "sshPublicKeys": [ "string" ],
   "systemVersion": "string",
   "tags": { 
      "string" : "string" 
   },
   "timeZone": "string",
   "totalEcpuCount": number,
   "vmFileSystemStorageTotalSizeInGBs": 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.

clientToken

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, the Amazon Web Services SDK automatically generates one and uses it for the request to ensure idempotency. The client token is valid for up to 24 hours after it's first used.

Type: String

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

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

Required: No

clusterName

A name for the Grid Infrastructure cluster. The name isn't case sensitive.

Type: String

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

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

Required: No

dataCollectionOptions

The set of preferences for the various diagnostic collection options for the Exascale VM cluster.

Type: DataCollectionOptions object

Required: No

displayName

A user-friendly name for the Exascale VM cluster.

Type: String

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

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

Required: Yes

enabledEcpuCount

The number of ECPUs to enable for the Exascale VM cluster.

Type: Integer

Valid Range: Minimum value of 0.

Required: Yes

exascaleDbStorageVaultId

The unique identifier of the Exascale storage vault for this Exascale 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

gridImageId

The Grid Infrastructure software image ID for the Exascale VM cluster.

Type: String

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

Required: Yes

hostname

The host name for the Exascale VM cluster.

Type: String

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

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

Required: Yes

licenseModel

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

Type: String

Valid Values: BRING_YOUR_OWN_LICENSE | LICENSE_INCLUDED

Required: No

nodeCount

The number of nodes in the Exascale VM cluster.

Type: Integer

Valid Range: Minimum value of 1.

Required: Yes

odbNetworkId

The unique identifier of the ODB network for the Exascale 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

scanListenerPortTcp

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

Type: Integer

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

Required: No

scanListenerPortTcpSsl

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

Type: Integer

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

Required: No

shape

The shape of the Exascale VM cluster.

Type: String

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

Required: Yes

shapeAttribute

The shape attribute for the Exascale VM cluster.

Type: String

Valid Values: SMART_STORAGE | BLOCK_STORAGE

Required: No

sshPublicKeys

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

Type: Array of strings

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

Required: Yes

systemVersion

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

Type: String

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

Required: No

tags

The list of resource tags to apply to the Exascale VM cluster.

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 for the Exascale VM cluster.

Type: String

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

Required: No

totalEcpuCount

The total number of ECPUs for the Exascale VM cluster.

Type: Integer

Valid Range: Minimum value of 2.

Required: Yes

vmFileSystemStorageTotalSizeInGBs

The total amount of file system storage, in gigabytes (GB), for the Exascale VM cluster.

Type: Integer

Valid Range: Minimum value of 0.

Required: Yes

Response Syntax


{
   "displayName": "string",
   "exadbVmClusterId": "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.

displayName

The user-friendly name for the Exascale VM cluster.

Type: String

exadbVmClusterId

The unique identifier of the Exascale VM cluster.

Type: String

status

The current status of the Exascale VM cluster.

Type: String

statusReason

Additional information about the status of the Exascale VM cluster.

Type: String

Errors

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

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.

resourceId: The identifier of the resource that caused the conflict.
resourceType: The type of resource that caused the conflict.

HTTP Status Code: 400

InternalServerException

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

retryAfterSeconds: The number of seconds to wait before retrying the request after an internal server error.

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.

resourceId: The identifier of the resource that was not found.
resourceType: The type of resource that was not found.

HTTP Status Code: 400

ServiceQuotaExceededException

You have exceeded the service quota.

quotaCode: The unqiue identifier of the service quota that was exceeded.
resourceId: The identifier of the resource that exceeded the service quota.
resourceType: The type of resource that exceeded the service quota.

HTTP Status Code: 400

ThrottlingException

The request was denied due to request throttling.

retryAfterSeconds: The number of seconds to wait before retrying the request after being throttled.

HTTP Status Code: 400

ValidationException

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

fieldList: A list of fields that failed validation.
reason: The reason why the validation failed.

HTTP Status Code: 400