AWS CLI Command Reference

[ aws . odb ]

create-cloud-vm-cluster

Description

Creates a VM cluster on the specified Exadata infrastructure.

See also: AWS API Documentation

Synopsis

  create-cloud-vm-cluster
--cloud-exadata-infrastructure-id <value>
--cpu-core-count <value>
--display-name <value>
--gi-version <value>
--hostname <value>
--ssh-public-keys <value>
--odb-network-id <value>
[--cluster-name <value>]
[--data-collection-options <value>]
[--data-storage-size-in-tbs <value>]
[--db-node-storage-size-in-gbs <value>]
[--db-servers <value>]
[--tags <value>]
[--is-local-backup-enabled | --no-is-local-backup-enabled]
[--is-sparse-diskgroup-enabled | --no-is-sparse-diskgroup-enabled]
[--license-model <value>]
[--memory-size-in-gbs <value>]
[--system-version <value>]
[--time-zone <value>]
[--client-token <value>]
[--scan-listener-port-tcp <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options

--cloud-exadata-infrastructure-id (string)

The unique identifier of the Exadata infrastructure for this VM cluster.

--cpu-core-count (integer)

The number of CPU cores to enable on the VM cluster.

--display-name (string)

A user-friendly name for the VM cluster.

--gi-version (string)

A valid software version of Oracle Grid Infrastructure (GI). To get the list of valid values, use the ListGiVersions operation and specify the shape of the Exadata infrastructure.

Example: 19.0.0.0

--hostname (string)

The host name for the VM cluster.

Constraints:

  • Can’t be “localhost” or “hostname”.
  • Can’t contain “-version”.
  • The maximum length of the combined hostname and domain is 63 characters.
  • The hostname must be unique within the subnet.

--ssh-public-keys (list)

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

(string)

Syntax:

"string" "string" ...

--odb-network-id (string)

The unique identifier of the ODB network for the VM cluster.

--cluster-name (string)

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

--data-collection-options (structure)

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

isDiagnosticsEventsEnabled -> (boolean)

Indicates whether diagnostic collection is enabled for the VM cluster.

isHealthMonitoringEnabled -> (boolean)

Indicates whether health monitoring is enabled for the VM cluster.

isIncidentLogsEnabled -> (boolean)

Indicates whether incident logs are enabled for the cloud VM cluster.

Shorthand Syntax:

isDiagnosticsEventsEnabled=boolean,isHealthMonitoringEnabled=boolean,isIncidentLogsEnabled=boolean

JSON Syntax:

{
  "isDiagnosticsEventsEnabled": true|false,
  "isHealthMonitoringEnabled": true|false,
  "isIncidentLogsEnabled": true|false
}

--data-storage-size-in-tbs (double)

The size of the data disk group, in terabytes (TBs), to allocate for the VM cluster.

--db-node-storage-size-in-gbs (integer)

The amount of local node storage, in gigabytes (GBs), to allocate for the VM cluster.

--db-servers (list)

The list of database servers for the VM cluster.

(string)

Syntax:

"string" "string" ...

--tags (map)

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

key -> (string)

value -> (string)

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

--is-local-backup-enabled | --no-is-local-backup-enabled (boolean)

Specifies whether to enable database backups to local Exadata storage for the VM cluster.

--is-sparse-diskgroup-enabled | --no-is-sparse-diskgroup-enabled (boolean)

Specifies whether to create a sparse disk group for the VM cluster.

--license-model (string)

The Oracle license model to apply to the VM cluster.

Default: LICENSE_INCLUDED

Possible values:

  • BRING_YOUR_OWN_LICENSE
  • LICENSE_INCLUDED

--memory-size-in-gbs (integer)

The amount of memory, in gigabytes (GBs), to allocate for the VM cluster.

--system-version (string)

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

--time-zone (string)

The time zone for the VM cluster. For a list of valid values for time zone, you can check the options in the console.

Default: UTC

--client-token (string)

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 a client token and uses it for the request to ensure idempotency. The client token is valid for up to 24 hours after it’s first used.

--scan-listener-port-tcp (integer)

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

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table
  • yaml
  • yaml-stream

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Output

displayName -> (string)

The user-friendly name for the VM cluster.

status -> (string)

The current status of the VM cluster.

statusReason -> (string)

Additional information about the status of the VM cluster.

cloudVmClusterId -> (string)

The unique identifier for the VM cluster.
© Copyright 2025, Amazon Web Services. Created using Sphinx.