AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . odb ]

get-db-server

Description

Returns information about the specified database server.

See also: AWS API Documentation

Synopsis

  get-db-server
--cloud-exadata-infrastructure-id <value>
--db-server-id <value>
[--cli-input-json <value>]
[--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>]

Options

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

The unique identifier of the Oracle Exadata infrastructure that contains the database server.

--db-server-id (string)

The unique identifier of the database server to retrieve information about.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

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

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

Output

dbServer -> (structure)

The details of the requested database server.

dbServerId -> (string)

The unique identifier for the database server.

status -> (string)

The current status of the database server.

statusReason -> (string)

Additional information about the current status of the database server.

cpuCoreCount -> (integer)

The number of CPU cores enabled on the database server.

dbNodeStorageSizeInGBs -> (integer)

The allocated local node storage in GBs on the database server.

dbServerPatchingDetails -> (structure)

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

estimatedPatchDuration -> (integer)

Estimated time, in minutes, to patch one database server.

patchingStatus -> (string)

The status of the patching operation. Possible values are SCHEDULED , MAINTENANCE_IN_PROGRESS , FAILED , and COMPLETE .

timePatchingEnded -> (string)

The time when the patching operation ended.

timePatchingStarted -> (string)

The time when the patching operation started.

displayName -> (string)

The user-friendly name of the database server.

exadataInfrastructureId -> (string)

The ID of the Exadata infrastructure the database server belongs to.

ocid -> (string)

The OCID of the database server.

ociResourceAnchorName -> (string)

The name of the OCI resource anchor for the database server.

maxCpuCount -> (integer)

The total number of CPU cores available.

maxDbNodeStorageInGBs -> (integer)

The total local node storage available in GBs.

maxMemoryInGBs -> (integer)

The total memory available in GBs.

memorySizeInGBs -> (integer)

The allocated memory in GBs on the database server.

shape -> (string)

The shape of the database server. The shape determines the amount of CPU, storage, and memory resources available.

createdAt -> (timestamp)

The date and time when the database server was created.

vmClusterIds -> (list)

The OCID of the VM clusters that are associated with the database server.

(string)

computeModel -> (string)

The compute model of the database server (ECPU or OCPU).

autonomousVmClusterIds -> (list)

The list of identifiers for the Autonomous VM clusters associated with this database server.

(string)

autonomousVirtualMachineIds -> (list)

The list of unique identifiers for the Autonomous VMs associated with this database server.

(string)