create-autonomous-database¶

Description¶

Creates a new Autonomous Database.

Synopsis¶

  create-autonomous-database
[--odb-network-id <value>]
[--display-name <value>]
[--db-name <value>]
[--admin-password <value>]
[--compute-count <value>]
[--data-storage-size-in-tbs <value>]
[--data-storage-size-in-gbs <value>]
[--db-workload <value>]
[--is-auto-scaling-enabled | --no-is-auto-scaling-enabled]
[--is-auto-scaling-for-storage-enabled | --no-is-auto-scaling-for-storage-enabled]
[--license-model <value>]
[--character-set <value>]
[--ncharacter-set <value>]
[--db-version <value>]
[--database-edition <value>]
[--standby-allowlisted-ips-source <value>]
[--autonomous-maintenance-schedule-type <value>]
[--backup-retention-period-in-days <value>]
[--byol-compute-count-limit <value>]
[--cpu-core-count <value>]
[--customer-contacts-to-send-to-oci <value>]
[--private-endpoint-ip <value>]
[--private-endpoint-label <value>]
[--resource-pool-leader-id <value>]
[--resource-pool-summary <value>]
[--scheduled-operations <value>]
[--standby-allowlisted-ips <value>]
[--allowlisted-ips <value>]
[--transportable-tablespace <value>]
[--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]
[--db-tools-details <value>]
[--source <value>]
[--source-configuration <value>]
[--encryption-key-provider <value>]
[--encryption-key-configuration <value>]
[--client-token <value>]
[--tags <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]
[--cli-error-format <value>]

Options¶

--odb-network-id (string)

The unique identifier of the ODB network to be used for the Autonomous Database.

Constraints:

min: 6

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

--display-name (string)

The user-friendly name for the Autonomous Database. The name does not have to be unique.

Constraints:

min: 1

max: 255

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

--db-name (string)

The name of the Autonomous Database. The name must begin with an alphabetic character and can contain a maximum of 30 alphanumeric characters. Special characters are not permitted. The name must be unique in the Amazon Web Services account.

Constraints:

min: 1

max: 30

--admin-password (string)

The password for the ADMIN user of the Autonomous Database.

Constraints:

min: 12

max: 30

--compute-count (double)

The compute capacity, in number of Elastic CPUs (ECPUs) or Oracle CPUs (OCPUs), to assign to the Autonomous Database.

Constraints:

min: 0.1

max: 512

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

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

Constraints:

min: 1

max: 384

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

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

Constraints:

min: 20

max: 393216

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

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

--license-model (string)

The Oracle license model to apply to the Autonomous Database.

Possible values:

BRING_YOUR_OWN_LICENSE

LICENSE_INCLUDED

--character-set (string)

The character set to use for the Autonomous Database.

Constraints:

min: 1

max: 255

--ncharacter-set (string)

The national character set to use for the Autonomous Database.

Constraints:

min: 1

max: 255

--db-version (string)

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

Constraints:

min: 1

max: 255

--database-edition (string)

The Oracle Database edition to apply to the Autonomous Database.

Possible values:

STANDARD_EDITION

ENTERPRISE_EDITION

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

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

Possible values:

PRIMARY

SEPARATE

NOT_APPLICABLE

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

The maintenance schedule type for the Autonomous Database.

Possible values:

EARLY

REGULAR

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

Constraints:

min: 2

--cpu-core-count (integer)

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

Constraints:

min: 1

max: 128

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

The list of customer contacts to receive operational notifications from Oracle Cloud Infrastructure (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.

Constraints:

min: 1

max: 320

Shorthand Syntax:

email=string ...

JSON Syntax:

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

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

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

The unique identifier of the resource pool leader Autonomous Database.

Constraints:

min: 6

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

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

--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) [required]

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

name -> (string)

The name of the day of the week.

Possible values:

MONDAY

TUESDAY

WEDNESDAY

THURSDAY

FRIDAY

SATURDAY

SUNDAY

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"
  }
  ...
]

--standby-allowlisted-ips (list)

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

Constraints:

min: 1

max: 1024

(string)

Syntax:

"string" "string" ...

--allowlisted-ips (list)

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

Constraints:

min: 1

max: 1024

(string)

Syntax:

"string" "string" ...

--transportable-tablespace (structure)

The transportable tablespace configuration to use when creating the Autonomous Database.

ttsBundleUrl -> (string)

The URL of the transportable tablespace bundle to use when creating the Autonomous Database.

Shorthand Syntax:

ttsBundleUrl=string

JSON Syntax:

{
  "ttsBundleUrl": "string"
}

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

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

--source (string)

The source from which to create the Autonomous Database, such as a clone, backup, or cross-Region copy.

Possible values:

NONE

DATABASE

BACKUP_FROM_ID

BACKUP_FROM_TIMESTAMP

CROSS_REGION_DATAGUARD

CROSS_REGION_DISASTER_RECOVERY

CLONE_TO_REFRESHABLE

--source-configuration (tagged union structure)

The configuration details for the source used to create the Autonomous Database.

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: databaseClone, restoreFromBackup, pointInTimeRestore, crossRegionDataGuard, crossRegionDisasterRecovery, cloneToRefreshable.

databaseClone -> (structure)

The configuration for creating the Autonomous Database as a clone of an existing database.

sourceAutonomousDatabaseId -> (string) [required]

The unique identifier of the source Autonomous Database to clone.

Constraints:

min: 6

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

cloneType -> (string) [required]

The type of clone to create, either a full clone, a metadata clone, or a partial clone.

Possible values:

FULL

METADATA

PARTIAL

restoreFromBackup -> (structure)

The configuration for creating the Autonomous Database by restoring from a backup.

autonomousDatabaseBackupId -> (string) [required]

The unique identifier of the Autonomous Database backup to restore from.

Constraints:

min: 6

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

cloneType -> (string) [required]

The type of clone to create from the backup.

Possible values:

FULL

METADATA

PARTIAL

cloneTableSpaceList -> (list)

The list of tablespace identifiers to clone from the backup.

(integer)

pointInTimeRestore -> (structure)

The configuration for creating the Autonomous Database by restoring to a point in time.

sourceAutonomousDatabaseId -> (string) [required]

The unique identifier of the source Autonomous Database to restore from.

Constraints:

min: 6

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

cloneType -> (string) [required]

The type of clone to create from the point-in-time restore.

Possible values:

FULL

METADATA

PARTIAL

timestamp -> (timestamp)

The date and time to which to restore the Autonomous Database.

useLatestAvailableBackupTimestamp -> (boolean)

Indicates whether to use the latest available backup timestamp for the restore.

cloneTableSpaceList -> (list)

The list of tablespace identifiers to clone from the point-in-time restore.

(integer)

crossRegionDataGuard -> (structure)

The configuration for creating the Autonomous Database as a cross-Region Oracle Data Guard peer.

sourceAutonomousDatabaseArn -> (string) [required]

The Amazon Resource Name (ARN) of the source Autonomous Database for the cross-Region Oracle Data Guard configuration.

Constraints:

min: 20

max: 2048

crossRegionDisasterRecovery -> (structure)

The configuration for creating the Autonomous Database as a cross-Region disaster recovery peer.

sourceAutonomousDatabaseArn -> (string) [required]

The Amazon Resource Name (ARN) of the source Autonomous Database for the cross-Region disaster recovery configuration.

Constraints:

min: 20

max: 2048

remoteDisasterRecoveryType -> (string) [required]

The type of remote disaster recovery to configure, either Autonomous Data Guard or backup-based.

Possible values:

ADG

BACKUP_BASED

isReplicateAutomaticBackups -> (boolean)

Indicates whether automatic backups are replicated to the disaster recovery database.

cloneToRefreshable -> (structure)

The configuration for creating the Autonomous Database as a refreshable clone.

sourceAutonomousDatabaseId -> (string) [required]

The unique identifier of the source Autonomous Database to create the refreshable clone from.

Constraints:

min: 6

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

refreshableMode -> (string)

The refresh mode of the refreshable clone, either automatic or manual.

Possible values:

AUTOMATIC

MANUAL

autoRefreshFrequencyInSeconds -> (integer)

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

Constraints:

min: 3600

max: 604800

autoRefreshPointLagInSeconds -> (integer)

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

Constraints:

min: 0

max: 604800

timeOfAutoRefreshStart -> (timestamp)

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

openMode -> (string)

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

Possible values:

READ_ONLY

READ_WRITE

cloneType -> (string)

The type of clone to create.

Possible values:

FULL

METADATA

PARTIAL

Shorthand Syntax:

databaseClone={sourceAutonomousDatabaseId=string,cloneType=string},restoreFromBackup={autonomousDatabaseBackupId=string,cloneType=string,cloneTableSpaceList=[integer,integer]},pointInTimeRestore={sourceAutonomousDatabaseId=string,cloneType=string,timestamp=timestamp,useLatestAvailableBackupTimestamp=boolean,cloneTableSpaceList=[integer,integer]},crossRegionDataGuard={sourceAutonomousDatabaseArn=string},crossRegionDisasterRecovery={sourceAutonomousDatabaseArn=string,remoteDisasterRecoveryType=string,isReplicateAutomaticBackups=boolean},cloneToRefreshable={sourceAutonomousDatabaseId=string,refreshableMode=string,autoRefreshFrequencyInSeconds=integer,autoRefreshPointLagInSeconds=integer,timeOfAutoRefreshStart=timestamp,openMode=string,cloneType=string}

JSON Syntax:

{
  "databaseClone": {
    "sourceAutonomousDatabaseId": "string",
    "cloneType": "FULL"|"METADATA"|"PARTIAL"
  },
  "restoreFromBackup": {
    "autonomousDatabaseBackupId": "string",
    "cloneType": "FULL"|"METADATA"|"PARTIAL",
    "cloneTableSpaceList": [integer, ...]
  },
  "pointInTimeRestore": {
    "sourceAutonomousDatabaseId": "string",
    "cloneType": "FULL"|"METADATA"|"PARTIAL",
    "timestamp": timestamp,
    "useLatestAvailableBackupTimestamp": true|false,
    "cloneTableSpaceList": [integer, ...]
  },
  "crossRegionDataGuard": {
    "sourceAutonomousDatabaseArn": "string"
  },
  "crossRegionDisasterRecovery": {
    "sourceAutonomousDatabaseArn": "string",
    "remoteDisasterRecoveryType": "ADG"|"BACKUP_BASED",
    "isReplicateAutomaticBackups": true|false
  },
  "cloneToRefreshable": {
    "sourceAutonomousDatabaseId": "string",
    "refreshableMode": "AUTOMATIC"|"MANUAL",
    "autoRefreshFrequencyInSeconds": integer,
    "autoRefreshPointLagInSeconds": integer,
    "timeOfAutoRefreshStart": timestamp,
    "openMode": "READ_ONLY"|"READ_WRITE",
    "cloneType": "FULL"|"METADATA"|"PARTIAL"
  }
}

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

Constraints:

min: 20

max: 2048

pattern: arn:(?:aws|aws-cn|aws-us-gov|aws-iso-{0,1}[a-z]{0,1}):iam::[0-9]{12}:role/.+

externalIdType -> (string)

The type of external identifier associated with the encryption key.

Possible values:

database_ocid

compartment_ocid

tenant_ocid

kmsKeyId -> (string)

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

Constraints:

min: 1

max: 2048

pattern: [a-zA-Z0-9_:./-]+

Shorthand Syntax:

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

JSON Syntax:

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

--client-token (string)

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

Constraints:

min: 8

max: 64

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

--tags (map)

The list of resource tags to apply to the Autonomous Database. Each tag is a key-value pair with no predefined name, type, or namespace.

Constraints:

min: 1

max: 200

key -> (string)

Constraints:

min: 1

max: 128

value -> (string)

Constraints:

min: 0

max: 256

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

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

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

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

--cli-error-format (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

legacy
json
yaml
text
table
enhanced

Output¶

autonomousDatabaseId -> (string)

The unique identifier of the Autonomous Database that was created.

displayName -> (string)

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

status -> (string)

The current status of the Autonomous Database.

Possible values:

AVAILABLE

FAILED

PROVISIONING

TERMINATED

TERMINATING

UPDATING

MAINTENANCE_IN_PROGRESS

STOPPING

STOPPED

STARTING

UNAVAILABLE

RESTORE_IN_PROGRESS

RESTORE_FAILED

BACKUP_IN_PROGRESS

SCALE_IN_PROGRESS

AVAILABLE_NEEDS_ATTENTION

RESTARTING

RECREATING

ROLE_CHANGE_IN_PROGRESS

UPGRADING

INACCESSIBLE

STANDBY

statusReason -> (string)

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

Table of Contents

Feedback

User Guide

create-autonomous-database¶

Description¶

Synopsis¶

Options¶

Note

Note

Global Options¶

Output¶