View a markdown version of this page

AutonomousDatabaseSummary - Oracle Database@AWS

AutonomousDatabaseSummary

A summary of an Autonomous Database.

Contents

actualUsedDataStorageSizeInTBs

The actual amount of data storage currently in use by the Autonomous Database, in TB.

Type: Double

Required: No

allocatedStorageSizeInTBs

The amount of storage currently allocated to the Autonomous Database, in TB.

Type: Double

Required: No

allowlistedIps

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

Type: Array of strings

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

Required: No

apexDetails

The Oracle Application Express (APEX) details for the Autonomous Database.

Type: AutonomousDatabaseApex object

Required: No

autonomousDatabaseArn

The Amazon Resource Name (ARN) of the Autonomous Database.

Type: String

Length Constraints: Minimum length of 20. 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-z0-9-_]{6,64}

Required: No

autonomousDatabaseId

The unique identifier of the Autonomous Database.

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

autonomousMaintenanceScheduleType

The maintenance schedule type for the Autonomous Database.

Type: String

Valid Values: EARLY | REGULAR

Required: No

autoRefreshFrequencyInSeconds

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

Type: Integer

Required: No

autoRefreshPointLagInSeconds

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

Type: Integer

Required: No

availabilityZone

The Availability Zone where the Autonomous Database is located.

Type: String

Required: No

availabilityZoneId

The unique identifier of the Availability Zone where the Autonomous Database is located.

Type: String

Required: No

availableUpgradeVersions

The list of Oracle Database software versions to which the Autonomous Database can be upgraded.

Type: Array of strings

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

Required: No

backupRetentionPeriodInDays

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

Type: Integer

Required: No

byolComputeCountLimit

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

Type: Integer

Required: No

characterSet

The character set of the Autonomous Database.

Type: String

Required: No

cloneTableSpaceList

The list of tablespace identifiers to clone for the Autonomous Database.

Type: Array of integers

Required: No

computeCount

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

Type: Float

Required: No

computeModel

The compute model of the Autonomous Database, either ECPU or OCPU.

Type: String

Valid Values: ECPU | OCPU

Required: No

connectionStringDetails

The connection string details for the Autonomous Database.

Type: AutonomousDatabaseConnectionStrings object

Required: No

connectionUrls

The connection URLs for accessing tools and services for the Autonomous Database.

Type: AutonomousDatabaseConnectionUrls object

Required: No

cpuCoreCount

The number of CPU cores allocated to the Autonomous Database.

Type: Integer

Required: No

createdAt

The date and time when the Autonomous Database was created.

Type: Timestamp

Required: No

customerContacts

The list of customer contacts that receive operational notifications from Oracle for the Autonomous Database.

Type: Array of CustomerContact objects

Required: No

databaseEdition

The Oracle Database edition of the Autonomous Database.

Type: String

Valid Values: STANDARD_EDITION | ENTERPRISE_EDITION

Required: No

databaseManagementStatus

The status of Oracle Database Management for the Autonomous Database.

Type: String

Valid Values: ENABLING | ENABLED | DISABLING | NOT_ENABLED | FAILED_ENABLING | FAILED_DISABLING

Required: No

databaseType

The type of the Autonomous Database, either a regular database or a clone.

Type: String

Valid Values: REGULAR | CLONE

Required: No

dataSafeStatus

The status of the Oracle Data Safe registration for the Autonomous Database.

Type: String

Valid Values: REGISTERING | REGISTERED | DEREGISTERING | NOT_REGISTERED | FAILED

Required: No

dataStorageSizeInGBs

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

Type: Integer

Required: No

dataStorageSizeInTBs

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

Type: Double

Required: No

dbName

The name of the Autonomous Database.

Type: String

Required: No

dbToolsDetails

The list of database management tools enabled for the Autonomous Database.

Type: Array of DatabaseTool objects

Required: No

dbVersion

The Oracle Database software version of the Autonomous Database.

Type: String

Required: No

dbWorkload

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

Type: String

Valid Values: OLTP | AJD | APEX | LH

Required: No

displayName

The user-friendly name of the Autonomous Database.

Type: String

Required: No

encryptionSummary

The encryption configuration for the Autonomous Database.

Type: EncryptionSummary object

Required: No

failedDataRecoveryInSeconds

The amount of time, in seconds, that the data in the Autonomous Database is behind the data in the primary database.

Type: Integer

Required: No

inMemoryAreaInGBs

The size of the in-memory area of the Autonomous Database, in GB.

Type: Integer

Required: No

isAutoScalingEnabled

Indicates whether automatic scaling of the compute resources is enabled for the Autonomous Database.

Type: Boolean

Required: No

isAutoScalingForStorageEnabled

Indicates whether automatic scaling of the storage is enabled for the Autonomous Database.

Type: Boolean

Required: No

isBackupRetentionLocked

Indicates whether the backup retention period of the Autonomous Database is locked.

Type: Boolean

Required: No

isLocalDataGuardEnabled

Indicates whether local Oracle Data Guard is enabled for the Autonomous Database.

Type: Boolean

Required: No

isMtlsConnectionRequired

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

Type: Boolean

Required: No

isReconnectCloneEnabled

Indicates whether reconnecting the refreshable clone to its source Autonomous Database is enabled.

Type: Boolean

Required: No

isRefreshableClone

Indicates whether the Autonomous Database is a refreshable clone.

Type: Boolean

Required: No

isRemoteDataGuardEnabled

Indicates whether remote Oracle Data Guard is enabled for the Autonomous Database.

Type: Boolean

Required: No

licenseModel

The Oracle license model that applies to the Autonomous Database.

Type: String

Valid Values: BRING_YOUR_OWN_LICENSE | LICENSE_INCLUDED

Required: No

localAdgAutoFailoverMaxDataLossLimit

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

Type: Integer

Required: No

localDisasterRecoveryType

The type of local disaster recovery configured for the Autonomous Database.

Type: String

Valid Values: ADG | BACKUP_BASED

Required: No

localStandbyDb

The details of the local standby Autonomous Database in an Oracle Data Guard configuration.

Type: DatabaseStandbySummary object

Required: No

longTermBackupSchedule

The long-term backup schedule for the Autonomous Database.

Type: LongTermBackupSchedule object

Required: No

maintenanceTargetComponent

The component on the Autonomous Database that the current maintenance is being applied to.

Type: String

Required: No

memoryPerOracleComputeUnitInGBs

The amount of memory allocated per Oracle Compute Unit, in GB.

Type: Integer

Required: No

ncharacterSet

The national character set of the Autonomous Database.

Type: String

Required: No

netServicesArchitecture

The Oracle Net Services architecture of the Autonomous Database, either dedicated or shared.

Type: String

Valid Values: DEDICATED | SHARED

Required: No

nextLongTermBackupTimeStamp

The date and time of the next scheduled long-term backup of the Autonomous Database.

Type: Timestamp

Required: No

ocid

The Oracle Cloud Identifier (OCID) of the Autonomous Database.

Type: String

Required: No

ociResourceAnchorName

The name of the Oracle Cloud Infrastructure (OCI) resource anchor associated with the Autonomous Database.

Type: String

Required: No

ociUrl

The URL for accessing the OCI console page for the Autonomous Database.

Type: String

Required: No

odbNetworkArn

The Amazon Resource Name (ARN) of the ODB network associated with the Autonomous Database.

Type: String

Length Constraints: Minimum length of 20. 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-z0-9-_]{6,64}

Required: No

odbNetworkId

The unique identifier of the ODB network associated with the Autonomous Database.

Type: String

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

Pattern: [a-zA-Z0-9_~.-]+

Required: No

openMode

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

Type: String

Valid Values: READ_ONLY | READ_WRITE

Required: No

operationsInsightsStatus

The status of Oracle Operations Insights for the Autonomous Database.

Type: String

Valid Values: ENABLING | ENABLED | DISABLING | NOT_ENABLED | FAILED_ENABLING | FAILED_DISABLING

Required: No

peerDbIds

The list of unique identifiers of the peer Autonomous Databases.

Type: Array of strings

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

Required: No

percentProgress

The progress of the current operation on the Autonomous Database, as a percentage.

Type: Float

Required: No

permissionLevel

The permission level of the Autonomous Database.

Type: String

Valid Values: RESTRICTED | UNRESTRICTED

Required: No

privateEndpoint

The private endpoint for the Autonomous Database.

Type: String

Required: No

privateEndpointIp

The private endpoint IP address for the Autonomous Database.

Type: String

Required: No

privateEndpointLabel

The private endpoint label for the Autonomous Database.

Type: String

Required: No

provisionableCpus

The list of CPU core counts that you can provision for the Autonomous Database.

Type: Array of integers

Required: No

refreshableMode

The refresh mode of the refreshable clone Autonomous Database.

Type: String

Valid Values: AUTOMATIC | MANUAL

Required: No

refreshableStatus

The refresh status of the refreshable clone Autonomous Database.

Type: String

Valid Values: REFRESHING | NOT_REFRESHING

Required: No

remoteDisasterRecoveryConfiguration

The configuration of the remote disaster recovery for the Autonomous Database.

Type: DisasterRecoveryConfiguration object

Required: No

resourcePoolLeaderId

The unique identifier of the resource pool leader Autonomous Database.

Type: String

Required: No

resourcePoolSummary

The configuration of the resource pool for the Autonomous Database.

Type: ResourcePoolSummary object

Required: No

role

The Oracle Data Guard role of the Autonomous Database.

Type: String

Valid Values: PRIMARY | STANDBY | DISABLED_STANDBY | BACKUP_COPY | SNAPSHOT_STANDBY

Required: No

scheduledOperations

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

Type: Array of ScheduledOperationDetails objects

Required: No

serviceConsoleUrl

The URL for accessing the Oracle service console for the Autonomous Database.

Type: String

Required: No

sourceId

The unique identifier of the source from which the Autonomous Database was created.

Type: String

Required: No

sqlWebDeveloperUrl

The URL for accessing Oracle SQL Developer Web for the Autonomous Database.

Type: String

Required: No

standbyAllowlistedIps

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

Type: Array of strings

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

Required: No

standbyAllowlistedIpsSource

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

Type: String

Valid Values: PRIMARY | SEPARATE | NOT_APPLICABLE

Required: No

standbyDb

The details of the standby Autonomous Database in a cross-Region Oracle Data Guard configuration.

Type: DatabaseStandbySummary object

Required: No

status

The current status of the Autonomous Database.

Type: String

Valid 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

Required: No

statusReason

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

Type: String

Required: No

timeDataGuardRoleChanged

The date and time when the Oracle Data Guard role of the Autonomous Database last changed.

Type: Timestamp

Required: No

timeDeletionOfFreeAutonomousDatabase

The date and time when the inactive Always Free Autonomous Database is scheduled to be automatically deleted.

Type: Timestamp

Required: No

timeDisasterRecoveryRoleChanged

The date and time when the disaster recovery role of the Autonomous Database last changed.

Type: Timestamp

Required: No

timeLocalDataGuardEnabled

The date and time when local Oracle Data Guard was enabled for the Autonomous Database.

Type: Timestamp

Required: No

timeMaintenanceBegin

The date and time when the next maintenance of the Autonomous Database begins.

Type: Timestamp

Required: No

timeMaintenanceEnd

The date and time when the next maintenance of the Autonomous Database ends.

Type: Timestamp

Required: No

timeOfAutoRefreshStart

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

Type: Timestamp

Required: No

timeOfLastBackup

The date and time of the last backup of the Autonomous Database.

Type: Timestamp

Required: No

timeOfLastFailover

The date and time of the last failover operation for the Autonomous Database.

Type: Timestamp

Required: No

timeOfLastRefresh

The date and time of the last refresh of the refreshable clone Autonomous Database.

Type: Timestamp

Required: No

timeOfLastRefreshPoint

The date and time as of which the data in the refreshable clone Autonomous Database is current.

Type: Timestamp

Required: No

timeOfLastSwitchover

The date and time of the last switchover operation for the Autonomous Database.

Type: Timestamp

Required: No

timeOfNextRefresh

The date and time of the next scheduled refresh of the refreshable clone Autonomous Database.

Type: Timestamp

Required: No

timeReclamationOfFreeAutonomousDatabase

The date and time when the Always Free Autonomous Database is scheduled to be stopped because of inactivity.

Type: Timestamp

Required: No

timeUndeleted

The date and time when the Autonomous Database was restored after deletion.

Type: Timestamp

Required: No

timeUntilReconnectCloneEnabled

The date and time until which reconnecting the refreshable clone to its source Autonomous Database is allowed.

Type: Timestamp

Required: No

totalBackupStorageSizeInGBs

The total amount of backup storage used by the Autonomous Database, in GB.

Type: Double

Required: No

usedDataStorageSizeInGBs

The amount of data storage currently in use by the Autonomous Database, in GB.

Type: Integer

Required: No

usedDataStorageSizeInTBs

The amount of data storage currently in use by the Autonomous Database, in TB.

Type: Double

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: