AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1). To view this page for the AWS CLI version 2, click here.

We announced the upcoming end-of-support for the AWS CLI v1. For dates, additional details, and information on how to migrate, please refer to the linked announcement. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . odb ]

update-autonomous-database

Description

Updates the properties of an Autonomous Database.

See also: AWS API Documentation

Synopsis

  update-autonomous-database
--autonomous-database-id <value>
[--admin-password <value>]
[--compute-count <value>]
[--cpu-core-count <value>]
[--data-storage-size-in-tbs <value>]
[--data-storage-size-in-gbs <value>]
[--display-name <value>]
[--db-name <value>]
[--db-version <value>]
[--db-workload <value>]
[--db-tools-details <value>]
[--database-edition <value>]
[--license-model <value>]
[--is-auto-scaling-enabled | --no-is-auto-scaling-enabled]
[--is-auto-scaling-for-storage-enabled | --no-is-auto-scaling-for-storage-enabled]
[--is-backup-retention-locked | --no-is-backup-retention-locked]
[--is-local-data-guard-enabled | --no-is-local-data-guard-enabled]
[--is-mtls-connection-required | --no-is-mtls-connection-required]
[--is-refreshable-clone | --no-is-refreshable-clone]
[--is-disconnect-peer | --no-is-disconnect-peer]
[--backup-retention-period-in-days <value>]
[--byol-compute-count-limit <value>]
[--local-adg-auto-failover-max-data-loss-limit <value>]
[--autonomous-maintenance-schedule-type <value>]
[--customer-contacts-to-send-to-oci <value>]
[--scheduled-operations <value>]
[--long-term-backup-schedule <value>]
[--open-mode <value>]
[--permission-level <value>]
[--refreshable-mode <value>]
[--private-endpoint-ip <value>]
[--private-endpoint-label <value>]
[--peer-db-id <value>]
[--resource-pool-leader-id <value>]
[--resource-pool-summary <value>]
[--standby-allowlisted-ips-source <value>]
[--standby-allowlisted-ips <value>]
[--allowlisted-ips <value>]
[--auto-refresh-frequency-in-seconds <value>]
[--auto-refresh-point-lag-in-seconds <value>]
[--time-of-auto-refresh-start <value>]
[--encryption-key-provider <value>]
[--encryption-key-configuration <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>]
[--v2-debug]

Options

--autonomous-database-id (string)

The unique identifier of the Autonomous Database to update.

--admin-password (string)

The new password for the ADMIN user of the Autonomous Database.

--compute-count (double)

The compute capacity, in number of ECPUs or OCPUs, to assign to the Autonomous Database.

--cpu-core-count (integer)

The number of CPU cores to allocate to the Autonomous Database.

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

The size, in terabytes (TB), of the data volume to allocate for the Autonomous Database.

--data-storage-size-in-gbs (integer)

The size, in gigabytes (GB), of the data volume to allocate for the Autonomous Database.

--display-name (string)

The new user-friendly name for the Autonomous Database.

--db-name (string)

The new name of the Autonomous Database.

--db-version (string)

The Oracle Database software version to use for the Autonomous Database.

--db-workload (string)

The intended use of the Autonomous Database, such as transaction processing, data warehouse, JSON database, or APEX.

Possible values:

  • OLTP
  • AJD
  • APEX
  • LH

--db-tools-details (list)

The list of database management tools to enable for the Autonomous Database.

(structure)

Information about a database management tool for an Autonomous Database.

isEnabled -> (boolean)

Indicates whether the database management tool is enabled.

name -> (string)

The name of the database management tool.

computeCount -> (double)

The compute capacity allocated to the database management tool.

maxIdleTimeInMinutes -> (integer)

The maximum amount of time, in minutes, that the database management tool can be idle before it is shut down.

Shorthand Syntax:

isEnabled=boolean,name=string,computeCount=double,maxIdleTimeInMinutes=integer ...

JSON Syntax:

[
  {
    "isEnabled": true|false,
    "name": "string",
    "computeCount": double,
    "maxIdleTimeInMinutes": integer
  }
  ...
]

--database-edition (string)

The Oracle Database edition to apply to the Autonomous Database.

Possible values:

  • STANDARD_EDITION
  • ENTERPRISE_EDITION

--license-model (string)

The Oracle license model to apply to the Autonomous Database.

Possible values:

  • BRING_YOUR_OWN_LICENSE
  • LICENSE_INCLUDED

--is-auto-scaling-enabled | --no-is-auto-scaling-enabled (boolean)

Specifies whether to enable automatic scaling of the compute resources for the Autonomous Database.

--is-auto-scaling-for-storage-enabled | --no-is-auto-scaling-for-storage-enabled (boolean)

Specifies whether to enable automatic scaling of the storage for the Autonomous Database.

--is-backup-retention-locked | --no-is-backup-retention-locked (boolean)

Specifies whether to lock the backup retention period of the Autonomous Database to prevent it from being shortened.

--is-local-data-guard-enabled | --no-is-local-data-guard-enabled (boolean)

Specifies whether to enable local Oracle Data Guard for the Autonomous Database.

--is-mtls-connection-required | --no-is-mtls-connection-required (boolean)

Specifies whether mutual TLS (mTLS) authentication is required to connect to the Autonomous Database.

--is-refreshable-clone | --no-is-refreshable-clone (boolean)

Specifies whether the Autonomous Database is a refreshable clone.

--is-disconnect-peer | --no-is-disconnect-peer (boolean)

Specifies whether to disconnect the Autonomous Database from its peer database.

--backup-retention-period-in-days (integer)

The retention period, in days, for automatic backups of the Autonomous Database.

--byol-compute-count-limit (double)

The maximum number of compute resources that you can allocate to the Autonomous Database under the bring-your-own-license (BYOL) model.

--local-adg-auto-failover-max-data-loss-limit (integer)

The maximum data loss limit, in seconds, for automatic failover to the local Oracle Data Guard standby database.

--autonomous-maintenance-schedule-type (string)

The maintenance schedule type for the Autonomous Database.

Possible values:

  • EARLY
  • REGULAR

--customer-contacts-to-send-to-oci (list)

The list of customer contacts to receive operational notifications from OCI for the Autonomous Database.

(structure)

A contact to receive notification from Oracle about maintenance updates for a specific Exadata infrastructure.

email -> (string)

The email address of the contact.

Shorthand Syntax:

email=string ...

JSON Syntax:

[
  {
    "email": "string"
  }
  ...
]

--scheduled-operations (list)

The list of scheduled start and stop times for the Autonomous Database.

(structure)

The scheduled start and stop times for an Autonomous Database on a specific day of the week.

dayOfWeek -> (structure)

The day of the week on which the scheduled operation occurs.

name -> (string)

The name of the day of the week.

scheduledStartTime -> (string)

The scheduled start time for the Autonomous Database, in UTC.

scheduledStopTime -> (string)

The scheduled stop time for the Autonomous Database, in UTC.

Shorthand Syntax:

dayOfWeek={name=string},scheduledStartTime=string,scheduledStopTime=string ...

JSON Syntax:

[
  {
    "dayOfWeek": {
      "name": "MONDAY"|"TUESDAY"|"WEDNESDAY"|"THURSDAY"|"FRIDAY"|"SATURDAY"|"SUNDAY"
    },
    "scheduledStartTime": "string",
    "scheduledStopTime": "string"
  }
  ...
]

--long-term-backup-schedule (structure)

The long-term backup schedule for the Autonomous Database.

isDisabled -> (boolean)

Indicates whether the long-term backup schedule is disabled.

repeatCadence -> (string)

The cadence at which long-term backups are taken.

retentionPeriodInDays -> (integer)

The retention period, in days, for long-term backups.

timeOfBackup -> (timestamp)

The date and time at which the long-term backup is taken.

Shorthand Syntax:

isDisabled=boolean,repeatCadence=string,retentionPeriodInDays=integer,timeOfBackup=timestamp

JSON Syntax:

{
  "isDisabled": true|false,
  "repeatCadence": "ONE_TIME"|"WEEKLY"|"MONTHLY"|"YEARLY",
  "retentionPeriodInDays": integer,
  "timeOfBackup": timestamp
}

--open-mode (string)

The mode in which to open the Autonomous Database, either read-only or read/write.

Possible values:

  • READ_ONLY
  • READ_WRITE

--permission-level (string)

The permission level of the Autonomous Database.

Possible values:

  • RESTRICTED
  • UNRESTRICTED

--refreshable-mode (string)

The refresh mode of the refreshable clone Autonomous Database.

Possible values:

  • AUTOMATIC
  • MANUAL

--private-endpoint-ip (string)

The private endpoint IP address for the Autonomous Database.

--private-endpoint-label (string)

The private endpoint label for the Autonomous Database.

--peer-db-id (string)

The unique identifier of the peer Autonomous Database.

--resource-pool-leader-id (string)

The unique identifier of the resource pool leader Autonomous Database.

--resource-pool-summary (structure)

The configuration of the resource pool for the Autonomous Database.

isDisabled -> (boolean)

Indicates whether the resource pool is disabled.

poolSize -> (integer)

The number of Autonomous Databases that the resource pool can contain.

poolStorageSizeInTBs -> (integer)

The total storage size of the resource pool, in terabytes (TB).

availableStorageCapacityInTBs -> (double)

The available storage capacity in the resource pool, in TB.

totalComputeCapacity -> (integer)

The total compute capacity of the resource pool.

availableComputeCapacity -> (integer)

The available compute capacity in the resource pool.

Shorthand Syntax:

isDisabled=boolean,poolSize=integer,poolStorageSizeInTBs=integer,availableStorageCapacityInTBs=double,totalComputeCapacity=integer,availableComputeCapacity=integer

JSON Syntax:

{
  "isDisabled": true|false,
  "poolSize": integer,
  "poolStorageSizeInTBs": integer,
  "availableStorageCapacityInTBs": double,
  "totalComputeCapacity": integer,
  "availableComputeCapacity": integer
}

--standby-allowlisted-ips-source (string)

The source of the allowlisted IP addresses for the standby Autonomous Database.

Possible values:

  • PRIMARY
  • SEPARATE
  • NOT_APPLICABLE

--standby-allowlisted-ips (list)

The list of IP addresses that are allowed to access the standby Autonomous Database.

(string)

Syntax:

"string" "string" ...

--allowlisted-ips (list)

The list of IP addresses that are allowed to access the Autonomous Database.

(string)

Syntax:

"string" "string" ...

--auto-refresh-frequency-in-seconds (integer)

The frequency, in seconds, at which the refreshable clone Autonomous Database is automatically refreshed.

--auto-refresh-point-lag-in-seconds (integer)

The time lag, in seconds, between the refreshable clone and its source Autonomous Database.

--time-of-auto-refresh-start (timestamp)

The date and time at which the automatic refresh of the refreshable clone Autonomous Database starts.

--encryption-key-provider (string)

The provider of the encryption key to use for the Autonomous Database.

Possible values:

  • ORACLE_MANAGED
  • AWS_KMS

--encryption-key-configuration (tagged union structure)

The configuration of the encryption key to use for the Autonomous Database.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: awsEncryptionKey.

awsEncryptionKey -> (structure)

The configuration of the Amazon Web Services Key Management Service (KMS) encryption key to use.

iamRoleArn -> (string)

The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that grants access to the KMS key.

externalIdType -> (string)

The type of external identifier associated with the encryption key.

kmsKeyId -> (string)

The identifier or ARN of the Amazon Web Services KMS key to use for encryption.

Shorthand Syntax:

awsEncryptionKey={iamRoleArn=string,externalIdType=string,kmsKeyId=string}

JSON Syntax:

{
  "awsEncryptionKey": {
    "iamRoleArn": "string",
    "externalIdType": "database_ocid"|"compartment_ocid"|"tenant_ocid",
    "kmsKeyId": "string"
  }
}

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

--v2-debug (boolean)

Enable AWS CLI v2 migration assistance. Prints warnings if the command would face a breaking change after swapping AWS CLI v1 for AWS CLI v2 in the current environment. Prints one warning for each breaking change detected.

Output

autonomousDatabaseId -> (string)

The unique identifier of the Autonomous Database that was updated.

displayName -> (string)

The user-friendly name of the Autonomous Database that was updated.

status -> (string)

The current status of the Autonomous Database.

statusReason -> (string)

Additional information about the current status of the Autonomous Database, if applicable.