oci.Database.AutonomousDatabase
Explore with Pulumi AI
This resource provides the Autonomous Database resource in Oracle Cloud Infrastructure Database service.
Creates a new Autonomous Database.
This API must be called on the remote region where the peer needs to be created.
Create AutonomousDatabase Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new AutonomousDatabase(name: string, args: AutonomousDatabaseArgs, opts?: CustomResourceOptions);
@overload
def AutonomousDatabase(resource_name: str,
args: AutonomousDatabaseArgs,
opts: Optional[ResourceOptions] = None)
@overload
def AutonomousDatabase(resource_name: str,
opts: Optional[ResourceOptions] = None,
compartment_id: Optional[str] = None,
db_name: Optional[str] = None,
admin_password: Optional[str] = None,
are_primary_whitelisted_ips_used: Optional[bool] = None,
auto_refresh_frequency_in_seconds: Optional[int] = None,
auto_refresh_point_lag_in_seconds: Optional[int] = None,
autonomous_container_database_id: Optional[str] = None,
autonomous_database_backup_id: Optional[str] = None,
autonomous_database_id: Optional[str] = None,
autonomous_maintenance_schedule_type: Optional[str] = None,
backup_retention_period_in_days: Optional[int] = None,
byol_compute_count_limit: Optional[float] = None,
character_set: Optional[str] = None,
clone_type: Optional[str] = None,
compute_count: Optional[float] = None,
compute_model: Optional[str] = None,
cpu_core_count: Optional[int] = None,
customer_contacts: Optional[Sequence[_database.AutonomousDatabaseCustomerContactArgs]] = None,
data_safe_status: Optional[str] = None,
data_storage_size_in_gb: Optional[int] = None,
data_storage_size_in_tbs: Optional[int] = None,
database_edition: Optional[str] = None,
database_management_status: Optional[str] = None,
db_tools_details: Optional[Sequence[_database.AutonomousDatabaseDbToolsDetailArgs]] = None,
db_version: Optional[str] = None,
db_workload: Optional[str] = None,
defined_tags: Optional[Mapping[str, str]] = None,
disaster_recovery_type: Optional[str] = None,
display_name: Optional[str] = None,
encryption_key: Optional[_database.AutonomousDatabaseEncryptionKeyArgs] = None,
freeform_tags: Optional[Mapping[str, str]] = None,
in_memory_percentage: Optional[int] = None,
is_access_control_enabled: Optional[bool] = None,
is_auto_scaling_enabled: Optional[bool] = None,
is_auto_scaling_for_storage_enabled: Optional[bool] = None,
is_data_guard_enabled: Optional[bool] = None,
is_dedicated: Optional[bool] = None,
is_dev_tier: Optional[bool] = None,
is_free_tier: Optional[bool] = None,
is_local_data_guard_enabled: Optional[bool] = None,
is_mtls_connection_required: Optional[bool] = None,
is_preview_version_with_service_terms_accepted: Optional[bool] = None,
is_refreshable_clone: Optional[bool] = None,
is_replicate_automatic_backups: Optional[bool] = None,
is_shrink_only: Optional[bool] = None,
key_version_id: Optional[str] = None,
kms_key_id: Optional[str] = None,
license_model: Optional[str] = None,
local_adg_auto_failover_max_data_loss_limit: Optional[int] = None,
long_term_backup_schedules: Optional[Sequence[_database.AutonomousDatabaseLongTermBackupScheduleArgs]] = None,
max_cpu_core_count: Optional[int] = None,
ncharacter_set: Optional[str] = None,
nsg_ids: Optional[Sequence[str]] = None,
ocpu_count: Optional[float] = None,
open_mode: Optional[str] = None,
operations_insights_status: Optional[str] = None,
permission_level: Optional[str] = None,
private_endpoint_ip: Optional[str] = None,
private_endpoint_label: Optional[str] = None,
refreshable_mode: Optional[str] = None,
remote_disaster_recovery_type: Optional[str] = None,
resource_pool_leader_id: Optional[str] = None,
resource_pool_summary: Optional[_database.AutonomousDatabaseResourcePoolSummaryArgs] = None,
rotate_key_trigger: Optional[bool] = None,
scheduled_operations: Optional[Sequence[_database.AutonomousDatabaseScheduledOperationArgs]] = None,
secret_id: Optional[str] = None,
secret_version_number: Optional[int] = None,
security_attributes: Optional[Mapping[str, str]] = None,
shrink_adb_trigger: Optional[int] = None,
source: Optional[str] = None,
source_id: Optional[str] = None,
standby_whitelisted_ips: Optional[Sequence[str]] = None,
state: Optional[str] = None,
subnet_id: Optional[str] = None,
subscription_id: Optional[str] = None,
switchover_to: Optional[str] = None,
switchover_to_remote_peer_id: Optional[str] = None,
time_of_auto_refresh_start: Optional[str] = None,
timestamp: Optional[str] = None,
use_latest_available_backup_time_stamp: Optional[bool] = None,
vault_id: Optional[str] = None,
whitelisted_ips: Optional[Sequence[str]] = None)
func NewAutonomousDatabase(ctx *Context, name string, args AutonomousDatabaseArgs, opts ...ResourceOption) (*AutonomousDatabase, error)
public AutonomousDatabase(string name, AutonomousDatabaseArgs args, CustomResourceOptions? opts = null)
public AutonomousDatabase(String name, AutonomousDatabaseArgs args)
public AutonomousDatabase(String name, AutonomousDatabaseArgs args, CustomResourceOptions options)
type: oci:Database:AutonomousDatabase
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args AutonomousDatabaseArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args AutonomousDatabaseArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args AutonomousDatabaseArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args AutonomousDatabaseArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args AutonomousDatabaseArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var autonomousDatabaseResource = new Oci.Database.AutonomousDatabase("autonomousDatabaseResource", new()
{
CompartmentId = "string",
DbName = "string",
AdminPassword = "string",
ArePrimaryWhitelistedIpsUsed = false,
AutoRefreshFrequencyInSeconds = 0,
AutoRefreshPointLagInSeconds = 0,
AutonomousContainerDatabaseId = "string",
AutonomousDatabaseBackupId = "string",
AutonomousDatabaseId = "string",
AutonomousMaintenanceScheduleType = "string",
BackupRetentionPeriodInDays = 0,
ByolComputeCountLimit = 0,
CharacterSet = "string",
CloneType = "string",
ComputeCount = 0,
ComputeModel = "string",
CpuCoreCount = 0,
CustomerContacts = new[]
{
new Oci.Database.Inputs.AutonomousDatabaseCustomerContactArgs
{
Email = "string",
},
},
DataSafeStatus = "string",
DataStorageSizeInGb = 0,
DataStorageSizeInTbs = 0,
DatabaseEdition = "string",
DatabaseManagementStatus = "string",
DbToolsDetails = new[]
{
new Oci.Database.Inputs.AutonomousDatabaseDbToolsDetailArgs
{
Name = "string",
ComputeCount = 0,
IsEnabled = false,
MaxIdleTimeInMinutes = 0,
},
},
DbVersion = "string",
DbWorkload = "string",
DefinedTags =
{
{ "string", "string" },
},
DisasterRecoveryType = "string",
DisplayName = "string",
EncryptionKey = new Oci.Database.Inputs.AutonomousDatabaseEncryptionKeyArgs
{
ArnRole = "string",
AutonomousDatabaseProvider = "string",
CertificateDirectoryName = "string",
CertificateId = "string",
DirectoryName = "string",
ExternalId = "string",
KeyArn = "string",
KeyName = "string",
KmsKeyId = "string",
OkvKmsKey = "string",
OkvUri = "string",
ServiceEndpointUri = "string",
VaultId = "string",
VaultUri = "string",
},
FreeformTags =
{
{ "string", "string" },
},
InMemoryPercentage = 0,
IsAccessControlEnabled = false,
IsAutoScalingEnabled = false,
IsAutoScalingForStorageEnabled = false,
IsDataGuardEnabled = false,
IsDedicated = false,
IsDevTier = false,
IsFreeTier = false,
IsLocalDataGuardEnabled = false,
IsMtlsConnectionRequired = false,
IsPreviewVersionWithServiceTermsAccepted = false,
IsRefreshableClone = false,
IsReplicateAutomaticBackups = false,
KeyVersionId = "string",
KmsKeyId = "string",
LicenseModel = "string",
LocalAdgAutoFailoverMaxDataLossLimit = 0,
LongTermBackupSchedules = new[]
{
new Oci.Database.Inputs.AutonomousDatabaseLongTermBackupScheduleArgs
{
IsDisabled = false,
RepeatCadence = "string",
RetentionPeriodInDays = 0,
TimeOfBackup = "string",
},
},
MaxCpuCoreCount = 0,
NcharacterSet = "string",
NsgIds = new[]
{
"string",
},
OcpuCount = 0,
OpenMode = "string",
OperationsInsightsStatus = "string",
PermissionLevel = "string",
PrivateEndpointIp = "string",
PrivateEndpointLabel = "string",
RefreshableMode = "string",
RemoteDisasterRecoveryType = "string",
ResourcePoolLeaderId = "string",
ResourcePoolSummary = new Oci.Database.Inputs.AutonomousDatabaseResourcePoolSummaryArgs
{
IsDisabled = false,
PoolSize = 0,
},
RotateKeyTrigger = false,
ScheduledOperations = new[]
{
new Oci.Database.Inputs.AutonomousDatabaseScheduledOperationArgs
{
DayOfWeek = new Oci.Database.Inputs.AutonomousDatabaseScheduledOperationDayOfWeekArgs
{
Name = "string",
},
ScheduledStartTime = "string",
ScheduledStopTime = "string",
},
},
SecretId = "string",
SecretVersionNumber = 0,
SecurityAttributes =
{
{ "string", "string" },
},
ShrinkAdbTrigger = 0,
Source = "string",
SourceId = "string",
StandbyWhitelistedIps = new[]
{
"string",
},
State = "string",
SubnetId = "string",
SubscriptionId = "string",
SwitchoverTo = "string",
SwitchoverToRemotePeerId = "string",
TimeOfAutoRefreshStart = "string",
Timestamp = "string",
UseLatestAvailableBackupTimeStamp = false,
VaultId = "string",
WhitelistedIps = new[]
{
"string",
},
});
example, err := Database.NewAutonomousDatabase(ctx, "autonomousDatabaseResource", &Database.AutonomousDatabaseArgs{
CompartmentId: pulumi.String("string"),
DbName: pulumi.String("string"),
AdminPassword: pulumi.String("string"),
ArePrimaryWhitelistedIpsUsed: pulumi.Bool(false),
AutoRefreshFrequencyInSeconds: pulumi.Int(0),
AutoRefreshPointLagInSeconds: pulumi.Int(0),
AutonomousContainerDatabaseId: pulumi.String("string"),
AutonomousDatabaseBackupId: pulumi.String("string"),
AutonomousDatabaseId: pulumi.String("string"),
AutonomousMaintenanceScheduleType: pulumi.String("string"),
BackupRetentionPeriodInDays: pulumi.Int(0),
ByolComputeCountLimit: pulumi.Float64(0),
CharacterSet: pulumi.String("string"),
CloneType: pulumi.String("string"),
ComputeCount: pulumi.Float64(0),
ComputeModel: pulumi.String("string"),
CpuCoreCount: pulumi.Int(0),
CustomerContacts: database.AutonomousDatabaseCustomerContactArray{
&database.AutonomousDatabaseCustomerContactArgs{
Email: pulumi.String("string"),
},
},
DataSafeStatus: pulumi.String("string"),
DataStorageSizeInGb: pulumi.Int(0),
DataStorageSizeInTbs: pulumi.Int(0),
DatabaseEdition: pulumi.String("string"),
DatabaseManagementStatus: pulumi.String("string"),
DbToolsDetails: database.AutonomousDatabaseDbToolsDetailArray{
&database.AutonomousDatabaseDbToolsDetailArgs{
Name: pulumi.String("string"),
ComputeCount: pulumi.Float64(0),
IsEnabled: pulumi.Bool(false),
MaxIdleTimeInMinutes: pulumi.Int(0),
},
},
DbVersion: pulumi.String("string"),
DbWorkload: pulumi.String("string"),
DefinedTags: pulumi.StringMap{
"string": pulumi.String("string"),
},
DisasterRecoveryType: pulumi.String("string"),
DisplayName: pulumi.String("string"),
EncryptionKey: &database.AutonomousDatabaseEncryptionKeyArgs{
ArnRole: pulumi.String("string"),
AutonomousDatabaseProvider: pulumi.String("string"),
CertificateDirectoryName: pulumi.String("string"),
CertificateId: pulumi.String("string"),
DirectoryName: pulumi.String("string"),
ExternalId: pulumi.String("string"),
KeyArn: pulumi.String("string"),
KeyName: pulumi.String("string"),
KmsKeyId: pulumi.String("string"),
OkvKmsKey: pulumi.String("string"),
OkvUri: pulumi.String("string"),
ServiceEndpointUri: pulumi.String("string"),
VaultId: pulumi.String("string"),
VaultUri: pulumi.String("string"),
},
FreeformTags: pulumi.StringMap{
"string": pulumi.String("string"),
},
InMemoryPercentage: pulumi.Int(0),
IsAccessControlEnabled: pulumi.Bool(false),
IsAutoScalingEnabled: pulumi.Bool(false),
IsAutoScalingForStorageEnabled: pulumi.Bool(false),
IsDataGuardEnabled: pulumi.Bool(false),
IsDedicated: pulumi.Bool(false),
IsDevTier: pulumi.Bool(false),
IsFreeTier: pulumi.Bool(false),
IsLocalDataGuardEnabled: pulumi.Bool(false),
IsMtlsConnectionRequired: pulumi.Bool(false),
IsPreviewVersionWithServiceTermsAccepted: pulumi.Bool(false),
IsRefreshableClone: pulumi.Bool(false),
IsReplicateAutomaticBackups: pulumi.Bool(false),
KeyVersionId: pulumi.String("string"),
KmsKeyId: pulumi.String("string"),
LicenseModel: pulumi.String("string"),
LocalAdgAutoFailoverMaxDataLossLimit: pulumi.Int(0),
LongTermBackupSchedules: database.AutonomousDatabaseLongTermBackupScheduleArray{
&database.AutonomousDatabaseLongTermBackupScheduleArgs{
IsDisabled: pulumi.Bool(false),
RepeatCadence: pulumi.String("string"),
RetentionPeriodInDays: pulumi.Int(0),
TimeOfBackup: pulumi.String("string"),
},
},
MaxCpuCoreCount: pulumi.Int(0),
NcharacterSet: pulumi.String("string"),
NsgIds: pulumi.StringArray{
pulumi.String("string"),
},
OcpuCount: pulumi.Float64(0),
OpenMode: pulumi.String("string"),
OperationsInsightsStatus: pulumi.String("string"),
PermissionLevel: pulumi.String("string"),
PrivateEndpointIp: pulumi.String("string"),
PrivateEndpointLabel: pulumi.String("string"),
RefreshableMode: pulumi.String("string"),
RemoteDisasterRecoveryType: pulumi.String("string"),
ResourcePoolLeaderId: pulumi.String("string"),
ResourcePoolSummary: &database.AutonomousDatabaseResourcePoolSummaryArgs{
IsDisabled: pulumi.Bool(false),
PoolSize: pulumi.Int(0),
},
RotateKeyTrigger: pulumi.Bool(false),
ScheduledOperations: database.AutonomousDatabaseScheduledOperationArray{
&database.AutonomousDatabaseScheduledOperationArgs{
DayOfWeek: &database.AutonomousDatabaseScheduledOperationDayOfWeekArgs{
Name: pulumi.String("string"),
},
ScheduledStartTime: pulumi.String("string"),
ScheduledStopTime: pulumi.String("string"),
},
},
SecretId: pulumi.String("string"),
SecretVersionNumber: pulumi.Int(0),
SecurityAttributes: pulumi.StringMap{
"string": pulumi.String("string"),
},
ShrinkAdbTrigger: pulumi.Int(0),
Source: pulumi.String("string"),
SourceId: pulumi.String("string"),
StandbyWhitelistedIps: pulumi.StringArray{
pulumi.String("string"),
},
State: pulumi.String("string"),
SubnetId: pulumi.String("string"),
SubscriptionId: pulumi.String("string"),
SwitchoverTo: pulumi.String("string"),
SwitchoverToRemotePeerId: pulumi.String("string"),
TimeOfAutoRefreshStart: pulumi.String("string"),
Timestamp: pulumi.String("string"),
UseLatestAvailableBackupTimeStamp: pulumi.Bool(false),
VaultId: pulumi.String("string"),
WhitelistedIps: pulumi.StringArray{
pulumi.String("string"),
},
})
var autonomousDatabaseResource = new AutonomousDatabase("autonomousDatabaseResource", AutonomousDatabaseArgs.builder()
.compartmentId("string")
.dbName("string")
.adminPassword("string")
.arePrimaryWhitelistedIpsUsed(false)
.autoRefreshFrequencyInSeconds(0)
.autoRefreshPointLagInSeconds(0)
.autonomousContainerDatabaseId("string")
.autonomousDatabaseBackupId("string")
.autonomousDatabaseId("string")
.autonomousMaintenanceScheduleType("string")
.backupRetentionPeriodInDays(0)
.byolComputeCountLimit(0)
.characterSet("string")
.cloneType("string")
.computeCount(0)
.computeModel("string")
.cpuCoreCount(0)
.customerContacts(AutonomousDatabaseCustomerContactArgs.builder()
.email("string")
.build())
.dataSafeStatus("string")
.dataStorageSizeInGb(0)
.dataStorageSizeInTbs(0)
.databaseEdition("string")
.databaseManagementStatus("string")
.dbToolsDetails(AutonomousDatabaseDbToolsDetailArgs.builder()
.name("string")
.computeCount(0)
.isEnabled(false)
.maxIdleTimeInMinutes(0)
.build())
.dbVersion("string")
.dbWorkload("string")
.definedTags(Map.of("string", "string"))
.disasterRecoveryType("string")
.displayName("string")
.encryptionKey(AutonomousDatabaseEncryptionKeyArgs.builder()
.arnRole("string")
.autonomousDatabaseProvider("string")
.certificateDirectoryName("string")
.certificateId("string")
.directoryName("string")
.externalId("string")
.keyArn("string")
.keyName("string")
.kmsKeyId("string")
.okvKmsKey("string")
.okvUri("string")
.serviceEndpointUri("string")
.vaultId("string")
.vaultUri("string")
.build())
.freeformTags(Map.of("string", "string"))
.inMemoryPercentage(0)
.isAccessControlEnabled(false)
.isAutoScalingEnabled(false)
.isAutoScalingForStorageEnabled(false)
.isDataGuardEnabled(false)
.isDedicated(false)
.isDevTier(false)
.isFreeTier(false)
.isLocalDataGuardEnabled(false)
.isMtlsConnectionRequired(false)
.isPreviewVersionWithServiceTermsAccepted(false)
.isRefreshableClone(false)
.isReplicateAutomaticBackups(false)
.keyVersionId("string")
.kmsKeyId("string")
.licenseModel("string")
.localAdgAutoFailoverMaxDataLossLimit(0)
.longTermBackupSchedules(AutonomousDatabaseLongTermBackupScheduleArgs.builder()
.isDisabled(false)
.repeatCadence("string")
.retentionPeriodInDays(0)
.timeOfBackup("string")
.build())
.maxCpuCoreCount(0)
.ncharacterSet("string")
.nsgIds("string")
.ocpuCount(0)
.openMode("string")
.operationsInsightsStatus("string")
.permissionLevel("string")
.privateEndpointIp("string")
.privateEndpointLabel("string")
.refreshableMode("string")
.remoteDisasterRecoveryType("string")
.resourcePoolLeaderId("string")
.resourcePoolSummary(AutonomousDatabaseResourcePoolSummaryArgs.builder()
.isDisabled(false)
.poolSize(0)
.build())
.rotateKeyTrigger(false)
.scheduledOperations(AutonomousDatabaseScheduledOperationArgs.builder()
.dayOfWeek(AutonomousDatabaseScheduledOperationDayOfWeekArgs.builder()
.name("string")
.build())
.scheduledStartTime("string")
.scheduledStopTime("string")
.build())
.secretId("string")
.secretVersionNumber(0)
.securityAttributes(Map.of("string", "string"))
.shrinkAdbTrigger(0)
.source("string")
.sourceId("string")
.standbyWhitelistedIps("string")
.state("string")
.subnetId("string")
.subscriptionId("string")
.switchoverTo("string")
.switchoverToRemotePeerId("string")
.timeOfAutoRefreshStart("string")
.timestamp("string")
.useLatestAvailableBackupTimeStamp(false)
.vaultId("string")
.whitelistedIps("string")
.build());
autonomous_database_resource = oci.database.AutonomousDatabase("autonomousDatabaseResource",
compartment_id="string",
db_name="string",
admin_password="string",
are_primary_whitelisted_ips_used=False,
auto_refresh_frequency_in_seconds=0,
auto_refresh_point_lag_in_seconds=0,
autonomous_container_database_id="string",
autonomous_database_backup_id="string",
autonomous_database_id="string",
autonomous_maintenance_schedule_type="string",
backup_retention_period_in_days=0,
byol_compute_count_limit=0,
character_set="string",
clone_type="string",
compute_count=0,
compute_model="string",
cpu_core_count=0,
customer_contacts=[{
"email": "string",
}],
data_safe_status="string",
data_storage_size_in_gb=0,
data_storage_size_in_tbs=0,
database_edition="string",
database_management_status="string",
db_tools_details=[{
"name": "string",
"compute_count": 0,
"is_enabled": False,
"max_idle_time_in_minutes": 0,
}],
db_version="string",
db_workload="string",
defined_tags={
"string": "string",
},
disaster_recovery_type="string",
display_name="string",
encryption_key={
"arn_role": "string",
"autonomous_database_provider": "string",
"certificate_directory_name": "string",
"certificate_id": "string",
"directory_name": "string",
"external_id": "string",
"key_arn": "string",
"key_name": "string",
"kms_key_id": "string",
"okv_kms_key": "string",
"okv_uri": "string",
"service_endpoint_uri": "string",
"vault_id": "string",
"vault_uri": "string",
},
freeform_tags={
"string": "string",
},
in_memory_percentage=0,
is_access_control_enabled=False,
is_auto_scaling_enabled=False,
is_auto_scaling_for_storage_enabled=False,
is_data_guard_enabled=False,
is_dedicated=False,
is_dev_tier=False,
is_free_tier=False,
is_local_data_guard_enabled=False,
is_mtls_connection_required=False,
is_preview_version_with_service_terms_accepted=False,
is_refreshable_clone=False,
is_replicate_automatic_backups=False,
key_version_id="string",
kms_key_id="string",
license_model="string",
local_adg_auto_failover_max_data_loss_limit=0,
long_term_backup_schedules=[{
"is_disabled": False,
"repeat_cadence": "string",
"retention_period_in_days": 0,
"time_of_backup": "string",
}],
max_cpu_core_count=0,
ncharacter_set="string",
nsg_ids=["string"],
ocpu_count=0,
open_mode="string",
operations_insights_status="string",
permission_level="string",
private_endpoint_ip="string",
private_endpoint_label="string",
refreshable_mode="string",
remote_disaster_recovery_type="string",
resource_pool_leader_id="string",
resource_pool_summary={
"is_disabled": False,
"pool_size": 0,
},
rotate_key_trigger=False,
scheduled_operations=[{
"day_of_week": {
"name": "string",
},
"scheduled_start_time": "string",
"scheduled_stop_time": "string",
}],
secret_id="string",
secret_version_number=0,
security_attributes={
"string": "string",
},
shrink_adb_trigger=0,
source="string",
source_id="string",
standby_whitelisted_ips=["string"],
state="string",
subnet_id="string",
subscription_id="string",
switchover_to="string",
switchover_to_remote_peer_id="string",
time_of_auto_refresh_start="string",
timestamp="string",
use_latest_available_backup_time_stamp=False,
vault_id="string",
whitelisted_ips=["string"])
const autonomousDatabaseResource = new oci.database.AutonomousDatabase("autonomousDatabaseResource", {
compartmentId: "string",
dbName: "string",
adminPassword: "string",
arePrimaryWhitelistedIpsUsed: false,
autoRefreshFrequencyInSeconds: 0,
autoRefreshPointLagInSeconds: 0,
autonomousContainerDatabaseId: "string",
autonomousDatabaseBackupId: "string",
autonomousDatabaseId: "string",
autonomousMaintenanceScheduleType: "string",
backupRetentionPeriodInDays: 0,
byolComputeCountLimit: 0,
characterSet: "string",
cloneType: "string",
computeCount: 0,
computeModel: "string",
cpuCoreCount: 0,
customerContacts: [{
email: "string",
}],
dataSafeStatus: "string",
dataStorageSizeInGb: 0,
dataStorageSizeInTbs: 0,
databaseEdition: "string",
databaseManagementStatus: "string",
dbToolsDetails: [{
name: "string",
computeCount: 0,
isEnabled: false,
maxIdleTimeInMinutes: 0,
}],
dbVersion: "string",
dbWorkload: "string",
definedTags: {
string: "string",
},
disasterRecoveryType: "string",
displayName: "string",
encryptionKey: {
arnRole: "string",
autonomousDatabaseProvider: "string",
certificateDirectoryName: "string",
certificateId: "string",
directoryName: "string",
externalId: "string",
keyArn: "string",
keyName: "string",
kmsKeyId: "string",
okvKmsKey: "string",
okvUri: "string",
serviceEndpointUri: "string",
vaultId: "string",
vaultUri: "string",
},
freeformTags: {
string: "string",
},
inMemoryPercentage: 0,
isAccessControlEnabled: false,
isAutoScalingEnabled: false,
isAutoScalingForStorageEnabled: false,
isDataGuardEnabled: false,
isDedicated: false,
isDevTier: false,
isFreeTier: false,
isLocalDataGuardEnabled: false,
isMtlsConnectionRequired: false,
isPreviewVersionWithServiceTermsAccepted: false,
isRefreshableClone: false,
isReplicateAutomaticBackups: false,
keyVersionId: "string",
kmsKeyId: "string",
licenseModel: "string",
localAdgAutoFailoverMaxDataLossLimit: 0,
longTermBackupSchedules: [{
isDisabled: false,
repeatCadence: "string",
retentionPeriodInDays: 0,
timeOfBackup: "string",
}],
maxCpuCoreCount: 0,
ncharacterSet: "string",
nsgIds: ["string"],
ocpuCount: 0,
openMode: "string",
operationsInsightsStatus: "string",
permissionLevel: "string",
privateEndpointIp: "string",
privateEndpointLabel: "string",
refreshableMode: "string",
remoteDisasterRecoveryType: "string",
resourcePoolLeaderId: "string",
resourcePoolSummary: {
isDisabled: false,
poolSize: 0,
},
rotateKeyTrigger: false,
scheduledOperations: [{
dayOfWeek: {
name: "string",
},
scheduledStartTime: "string",
scheduledStopTime: "string",
}],
secretId: "string",
secretVersionNumber: 0,
securityAttributes: {
string: "string",
},
shrinkAdbTrigger: 0,
source: "string",
sourceId: "string",
standbyWhitelistedIps: ["string"],
state: "string",
subnetId: "string",
subscriptionId: "string",
switchoverTo: "string",
switchoverToRemotePeerId: "string",
timeOfAutoRefreshStart: "string",
timestamp: "string",
useLatestAvailableBackupTimeStamp: false,
vaultId: "string",
whitelistedIps: ["string"],
});
type: oci:Database:AutonomousDatabase
properties:
adminPassword: string
arePrimaryWhitelistedIpsUsed: false
autoRefreshFrequencyInSeconds: 0
autoRefreshPointLagInSeconds: 0
autonomousContainerDatabaseId: string
autonomousDatabaseBackupId: string
autonomousDatabaseId: string
autonomousMaintenanceScheduleType: string
backupRetentionPeriodInDays: 0
byolComputeCountLimit: 0
characterSet: string
cloneType: string
compartmentId: string
computeCount: 0
computeModel: string
cpuCoreCount: 0
customerContacts:
- email: string
dataSafeStatus: string
dataStorageSizeInGb: 0
dataStorageSizeInTbs: 0
databaseEdition: string
databaseManagementStatus: string
dbName: string
dbToolsDetails:
- computeCount: 0
isEnabled: false
maxIdleTimeInMinutes: 0
name: string
dbVersion: string
dbWorkload: string
definedTags:
string: string
disasterRecoveryType: string
displayName: string
encryptionKey:
arnRole: string
autonomousDatabaseProvider: string
certificateDirectoryName: string
certificateId: string
directoryName: string
externalId: string
keyArn: string
keyName: string
kmsKeyId: string
okvKmsKey: string
okvUri: string
serviceEndpointUri: string
vaultId: string
vaultUri: string
freeformTags:
string: string
inMemoryPercentage: 0
isAccessControlEnabled: false
isAutoScalingEnabled: false
isAutoScalingForStorageEnabled: false
isDataGuardEnabled: false
isDedicated: false
isDevTier: false
isFreeTier: false
isLocalDataGuardEnabled: false
isMtlsConnectionRequired: false
isPreviewVersionWithServiceTermsAccepted: false
isRefreshableClone: false
isReplicateAutomaticBackups: false
keyVersionId: string
kmsKeyId: string
licenseModel: string
localAdgAutoFailoverMaxDataLossLimit: 0
longTermBackupSchedules:
- isDisabled: false
repeatCadence: string
retentionPeriodInDays: 0
timeOfBackup: string
maxCpuCoreCount: 0
ncharacterSet: string
nsgIds:
- string
ocpuCount: 0
openMode: string
operationsInsightsStatus: string
permissionLevel: string
privateEndpointIp: string
privateEndpointLabel: string
refreshableMode: string
remoteDisasterRecoveryType: string
resourcePoolLeaderId: string
resourcePoolSummary:
isDisabled: false
poolSize: 0
rotateKeyTrigger: false
scheduledOperations:
- dayOfWeek:
name: string
scheduledStartTime: string
scheduledStopTime: string
secretId: string
secretVersionNumber: 0
securityAttributes:
string: string
shrinkAdbTrigger: 0
source: string
sourceId: string
standbyWhitelistedIps:
- string
state: string
subnetId: string
subscriptionId: string
switchoverTo: string
switchoverToRemotePeerId: string
timeOfAutoRefreshStart: string
timestamp: string
useLatestAvailableBackupTimeStamp: false
vaultId: string
whitelistedIps:
- string
AutonomousDatabase Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The AutonomousDatabase resource accepts the following input properties:
- Compartment
Id string - (Updatable) The OCID of the compartment of the Autonomous Database.
- Db
Name string - The database name. The name must begin with an alphabetic character and can contain a maximum of 14 alphanumeric characters. Special characters are not permitted. The database name must be unique in the tenancy. It is required in all cases except when creating a cross-region Autonomous Data Guard standby instance or a cross-region disaster recovery standby instance.
- Admin
Password string - (Updatable) The password must be between 12 and 30 characters long, and must contain at least 1 uppercase, 1 lowercase, and 1 numeric character. It cannot contain the double quote symbol (") or the username "admin", regardless of casing. The password is mandatory if source value is "BACKUP_FROM_ID", "BACKUP_FROM_TIMESTAMP", "DATABASE" or "NONE".
- Are
Primary boolWhitelisted Ips Used - (Updatable) This field will be null if the Autonomous Database is not Data Guard enabled or Access Control is disabled. It's value would be
TRUE
if Autonomous Database is Data Guard enabled and Access Control is enabled and if the Autonomous Database uses primary IP access control list (ACL) for standby. It's value would beFALSE
if Autonomous Database is Data Guard enabled and Access Control is enabled and if the Autonomous Database uses different IP access control list (ACL) for standby compared to primary. - Auto
Refresh intFrequency In Seconds - (Updatable) The frequency a refreshable clone is refreshed after auto-refresh is enabled. The minimum is 1 hour. The maximum is 7 days. The date and time that auto-refresh is enabled is controlled by the
timeOfAutoRefreshStart
parameter. - Auto
Refresh intPoint Lag In Seconds - (Updatable) The time, in seconds, the data of the refreshable clone lags the primary database at the point of refresh. The minimum is 0 minutes (0 mins means refresh to the latest available timestamp). The maximum is 7 days. The lag time increases after refreshing until the next data refresh happens.
- Autonomous
Container stringDatabase Id - The Autonomous Container Database OCID.
- Autonomous
Database stringBackup Id - The OCID of the source Autonomous Database Backup that you will clone to create a new Autonomous Database.
- Autonomous
Database stringId - The OCID of the source Autonomous Database that you will clone to create a new Autonomous Database.
- Autonomous
Maintenance stringSchedule Type - The maintenance schedule type of the Autonomous Database Serverless instances. The EARLY maintenance schedule of this Autonomous Database follows a schedule that applies patches prior to the REGULAR schedule.The REGULAR maintenance schedule of this Autonomous Database follows the normal cycle.
- Backup
Retention intPeriod In Days - (Updatable) Retention period, in days, for backups.
- Byol
Compute doubleCount Limit - Character
Set string The character set for the autonomous database. The default is AL32UTF8. Allowed values for an Autonomous Database on Serverless infrastructure as returned by List Autonomous Database Character Sets
For an Autonomous Database on dedicated infrastructure, the allowed values are:
AL32UTF8, AR8ADOS710, AR8ADOS720, AR8APTEC715, AR8ARABICMACS, AR8ASMO8X, AR8ISO8859P6, AR8MSWIN1256, AR8MUSSAD768, AR8NAFITHA711, AR8NAFITHA721, AR8SAKHR706, AR8SAKHR707, AZ8ISO8859P9E, BG8MSWIN, BG8PC437S, BLT8CP921, BLT8ISO8859P13, BLT8MSWIN1257, BLT8PC775, BN8BSCII, CDN8PC863, CEL8ISO8859P14, CL8ISO8859P5, CL8ISOIR111, CL8KOI8R, CL8KOI8U, CL8MACCYRILLICS, CL8MSWIN1251, EE8ISO8859P2, EE8MACCES, EE8MACCROATIANS, EE8MSWIN1250, EE8PC852, EL8DEC, EL8ISO8859P7, EL8MACGREEKS, EL8MSWIN1253, EL8PC437S, EL8PC851, EL8PC869, ET8MSWIN923, HU8ABMOD, HU8CWI2, IN8ISCII, IS8PC861, IW8ISO8859P8, IW8MACHEBREWS, IW8MSWIN1255, IW8PC1507, JA16EUC, JA16EUCTILDE, JA16SJIS, JA16SJISTILDE, JA16VMS, KO16KSC5601, KO16KSCCS, KO16MSWIN949, LA8ISO6937, LA8PASSPORT, LT8MSWIN921, LT8PC772, LT8PC774, LV8PC1117, LV8PC8LR, LV8RST104090, N8PC865, NE8ISO8859P10, NEE8ISO8859P4, RU8BESTA, RU8PC855, RU8PC866, SE8ISO8859P3, TH8MACTHAIS, TH8TISASCII, TR8DEC, TR8MACTURKISHS, TR8MSWIN1254, TR8PC857, US7ASCII, US8PC437, UTF8, VN8MSWIN1258, VN8VN3, WE8DEC, WE8DG, WE8ISO8859P1, WE8ISO8859P15, WE8ISO8859P9, WE8MACROMAN8S, WE8MSWIN1252, WE8NCR4970, WE8NEXTSTEP, WE8PC850, WE8PC858, WE8PC860, WE8ROMAN8, ZHS16CGB231280, ZHS16GBK, ZHT16BIG5, ZHT16CCDC, ZHT16DBT, ZHT16HKSCS, ZHT16MSWIN950, ZHT32EUC, ZHT32SOPS, ZHT32TRIS
- Clone
Type string - The Autonomous Database clone type. This parameter is not used to create a refreshable clone type, and for refreshable clones one must use the (source=CLONE_TO_REFRESHABLE) parameter.
FULL
- This option creates a new database that includes all source database data.METADATA
- This option creates a new database that includes the source database schema and select metadata, but not the source database data.
- Compute
Count double - (Updatable) The compute amount available to the database. Minimum and maximum values depend on the compute model and whether the database is an Autonomous Database Serverless instance or an Autonomous Database on Dedicated Exadata Infrastructure. For an Autonomous Database Serverless instance, the 'ECPU' compute model requires a minimum value of one, for databases in the elastic resource pool and minimum value of two, otherwise. Required when using the
computeModel
parameter. When usingcpuCoreCount
parameter, it is an error to specify computeCount to a non-null value. ProvidingcomputeModel
andcomputeCount
is the preferred method for both OCPU and ECPU. - Compute
Model string - (Updatable) The compute model of the Autonomous Database. This is required if using the
computeCount
parameter. If usingcpuCoreCount
then it is an error to specifycomputeModel
to a non-null value. ECPU compute model is the recommended model and OCPU compute model is legacy. - Cpu
Core intCount - (Updatable) The number of CPU cores to be made available to the database. For Autonomous Databases on dedicated Exadata infrastructure, the maximum number of cores is determined by the infrastructure shape. See Characteristics of Infrastructure Shapes for shape details.
Note: This parameter cannot be used with the
ocpuCount
parameter. This input is ignored for Always Free resources.- The data type must be an integer.
- The minimum number of cores for all types of autonomous database is 1
- The maximum number of cores is as follows:
- Autonomous Database Serverless instances: The maximum number of cores is 128.
- Autonomous Databases on dedicated Exadata infrastructure: The maximum number of cores is determined by the infrastructure shape. See Characteristics of Infrastructure Shapes for shape details.
- Providing
computeModel
andcomputeCount
is the preferred method for setting CPUs for both OCPU and ECPU.
- Customer
Contacts List<AutonomousDatabase Customer Contact> - (Updatable) Customer Contacts.
- Data
Safe stringStatus - (Updatable) Status of the Data Safe registration for this Autonomous Database. Could be REGISTERED or NOT_REGISTERED.
- Data
Storage intSize In Gb (Updatable) The size, in gigabytes, of the data volume that will be created and attached to the database. This storage can later be scaled up if needed. The maximum storage value is determined by the infrastructure shape. See Characteristics of Infrastructure Shapes for shape details.
Notes
- This parameter is only supported for dedicated Exadata infrastructure.
- This parameter cannot be used with the
dataStorageSizeInTBs
parameter.
- Data
Storage intSize In Tbs (Updatable) The size, in terabytes, of the data volume that will be created and attached to the database. This storage can later be scaled up if needed. For Autonomous Databases on dedicated Exadata infrastructure, the maximum storage value is determined by the infrastructure shape. See Characteristics of Infrastructure Shapes for shape details. A full Exadata service is allocated when the Autonomous Database size is set to the upper limit (384 TB).
Note: This parameter cannot be used with the
dataStorageSizeInGBs
parameter. This input is ignored for Always Free resources.- Database
Edition string - (Updatable) The Oracle Database Edition that applies to the Autonomous databases. It can be set to
ENTERPRISE_EDITION
orSTANDARD_EDITION
. - Database
Management stringStatus - Status of Database Management for this Autonomous Database.
- Db
Tools List<AutonomousDetails Database Db Tools Detail> (Updatable) The list of database tools details.
This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, whitelistedIps, isMTLSConnectionRequired, openMode, permissionLevel, dbWorkload, privateEndpointLabel, nsgIds, dbVersion, isRefreshable, dbName, scheduledOperations, isLocalDataGuardEnabled, or isFreeTier.
- Db
Version string - (Updatable) A valid Oracle Database version for Autonomous Database.
db_workload
AJD and APEX are only supported fordb_version
19c
and above. - Db
Workload string (Updatable) The Autonomous Database workload type. The following values are valid:
- OLTP - indicates an Autonomous Transaction Processing database
- DW - indicates an Autonomous Data Warehouse database
- AJD - indicates an Autonomous JSON Database
- APEX - indicates an Autonomous Database with the Oracle APEX Application Development workload type.
This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, isMTLSConnectionRequired, privateEndpointLabel, nsgIds, dbVersion, isRefreshable, dbName, scheduledOperations, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier. *Note:
db_workload
can only be updated from AJD to OLTP or from a free OLTP to AJD.- Dictionary<string, string>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- Disaster
Recovery stringType - Indicates the disaster recovery (DR) type of the standby Autonomous Database Serverless instance. Autonomous Data Guard (ADG) DR type provides business critical DR with a faster recovery time objective (RTO) during failover or switchover. Backup-based DR type provides lower cost DR with a slower RTO during failover or switchover.
- Display
Name string - (Updatable) The user-friendly name for the Autonomous Database. The name does not have to be unique.
- Encryption
Key AutonomousDatabase Encryption Key - (Updatable) Details of the Autonomous Database encryption key.
- Dictionary<string, string>
- (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example:
{"Department": "Finance"}
- In
Memory intPercentage - (Updatable) The percentage of the System Global Area(SGA) assigned to In-Memory tables in Autonomous Database. This property is applicable only to Autonomous Databases on the Exadata Cloud@Customer platform.
- Is
Access boolControl Enabled (Updatable) Indicates if the database-level access control is enabled. If disabled, database access is defined by the network security rules. If enabled, database access is restricted to the IP addresses defined by the rules specified with the
whitelistedIps
property. While specifyingwhitelistedIps
rules is optional, if database-level access control is enabled and no rules are specified, the database will become inaccessible. The rules can be added later using theUpdateAutonomousDatabase
API operation or edit option in console. When creating a database clone, the desired access control setting should be specified. By default, database-level access control will be disabled for the clone.This property is applicable only to Autonomous Databases on the Exadata Cloud@Customer platform. For Autonomous Database Serverless instances,
whitelistedIps
is used.- Is
Auto boolScaling Enabled - (Updatable) Indicates if auto scaling is enabled for the Autonomous Database CPU core count. The default value is
TRUE
. - Is
Auto boolScaling For Storage Enabled - (Updatable) Indicates if auto scaling is enabled for the Autonomous Database storage. The default value is
FALSE
. - Is
Data boolGuard Enabled - (Updatable) Deprecated. Indicates whether the Autonomous Database has local (in-region) Data Guard enabled. Not applicable to cross-region Autonomous Data Guard associations, or to Autonomous Databases using dedicated Exadata infrastructure or Exadata Cloud@Customer infrastructure.
- Is
Dedicated bool - True if the database is on dedicated Exadata infrastructure.
- Is
Dev boolTier - (Updatable) Autonomous Database for Developers are free Autonomous Databases that developers can use to build and test new applications.With Autonomous these database instancess instances, you can try new Autonomous Database features for free and apply them to ongoing or new development projects. Developer database comes with limited resources and is, therefore, not suitable for large-scale testing and production deployments. When you need more compute or storage resources, you can transition to a paid database licensing by cloning your developer database into a regular Autonomous Database. See Autonomous Database documentation for more details.
- Is
Free boolTier - (Updatable) Indicates if this is an Always Free resource. The default value is false. Note that Always Free Autonomous Databases have 1 CPU and 20GB of memory. For Always Free databases, memory and CPU cannot be scaled. When
db_workload
isAJD
orAPEX
it cannot betrue
. - Is
Local boolData Guard Enabled - (Updatable) Indicates whether the Autonomous Database has local (in-region) Data Guard enabled. It takes boolean values. Not applicable to cross-region Autonomous Data Guard associations, or to Autonomous Databases using dedicated Exadata infrastructure or Exadata Cloud@Customer infrastructure.
- Is
Mtls boolConnection Required - (Updatable) Indicates whether the Autonomous Database requires mTLS connections.
- Is
Preview boolVersion With Service Terms Accepted - If set to
TRUE
, indicates that an Autonomous Database preview version is being provisioned, and that the preview version's terms of service have been accepted. Note that preview version software is only available for databases on Autonomous Database Serverless. - Is
Refreshable boolClone - (Updatable) True for creating a refreshable clone and False for detaching the clone from source Autonomous Database. Detaching is one time operation and clone becomes a regular Autonomous Database.
- Is
Replicate boolAutomatic Backups - If true, 7 days worth of backups are replicated across regions for Cross-Region ADB or Backup-Based DR between Primary and Standby. If false, the backups taken on the Primary are not replicated to the Standby database.
- Is
Shrink boolOnly (Updatable) An optional property when enabled triggers the Shrinking of Autonomous Database once. To trigger Shrinking of ADB once again, this flag needs to be disabled and re-enabled again. It should not be passed during create database operation. It is only applicable on Serverless databases i.e. where
is_dedicated
is false.** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- Key
Version stringId - The OCID of the key version that is used in rotate key operations.
- Kms
Key stringId - The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
- License
Model string - (Updatable) The Oracle license model that applies to the Oracle Autonomous Database. Bring your own license (BYOL) allows you to apply your current on-premises Oracle software licenses to equivalent, highly automated Oracle PaaS and IaaS services in the cloud. License Included allows you to subscribe to new Oracle Database software licenses and the Database service. Note that when provisioning an Autonomous Database on dedicated Exadata infrastructure, this attribute must be null because the attribute is already set at the Autonomous Exadata Infrastructure level. When using shared Exadata infrastructure, if a value is not specified, the system will supply the value of
BRING_YOUR_OWN_LICENSE
. It is a required field whendb_workload
is AJD and needs to be set toLICENSE_INCLUDED
as AJD does not support defaultlicense_model
valueBRING_YOUR_OWN_LICENSE
. - Local
Adg intAuto Failover Max Data Loss Limit - Parameter that allows users to select an acceptable maximum data loss limit in seconds, up to which Automatic Failover will be triggered when necessary for a Local Autonomous Data Guard
- Long
Term List<AutonomousBackup Schedules Database Long Term Backup Schedule> - Details for the long-term backup schedule.
- Max
Cpu intCore Count - (Updatable) Deprecated. The number of Max OCPU cores to be made available to the autonomous database with auto scaling of cpu enabled.
- Ncharacter
Set string - The national character set for the autonomous database. The default is AL16UTF16. Allowed values are: AL16UTF16 or UTF8.
- Nsg
Ids List<string> - (Updatable) The list of OCIDs for the network security groups (NSGs) to which this resource belongs. Setting this to an empty list removes all resources from all NSGs. For more information about NSGs, see Security Rules. NsgIds restrictions:
- A network security group (NSG) is optional for Autonomous Databases with private access. The nsgIds list can be empty.
- Ocpu
Count double (Updatable) The number of OCPU cores to be made available to the database.
- Providing
computeModel
andcomputeCount
is the preferred method for setting CPUs for both OCPU and ECPU. The following points apply: - For Autonomous Databases on dedicated Exadata infrastructure, to provision less than 1 core, enter a fractional value in an increment of 0.1. For example, you can provision 0.3 or 0.4 cores, but not 0.35 cores. (Note that fractional OCPU values are not supported for Autonomous Databasese on shared Exadata infrastructure.)
- To provision 1 or more cores, you must enter an integer between 1 and the maximum number of cores available for the infrastructure shape. For example, you can provision 2 cores or 3 cores, but not 2.5 cores. This applies to Autonomous Databases on both shared and dedicated Exadata infrastructure.
For Autonomous Databases on dedicated Exadata infrastructure, the maximum number of cores is determined by the infrastructure shape. See Characteristics of Infrastructure Shapes for shape details.
Note: This parameter cannot be used with the
cpuCoreCount
parameter.- Providing
- Open
Mode string - Indicates the Autonomous Database mode. The database can be opened in
READ_ONLY
orREAD_WRITE
mode. - Operations
Insights stringStatus - (Updatable) Status of Operations Insights for this Autonomous Database. Values supported are
ENABLED
andNOT_ENABLED
- Permission
Level string - The Autonomous Database permission level. Restricted mode allows access only by admin users.
- Private
Endpoint stringIp - The private endpoint Ip address for the resource.
- Private
Endpoint stringLabel - (Updatable) (Optional) (Updatable) The resource's private endpoint label.
- Setting the endpoint label to a non-empty string creates a private endpoint database.
- Resetting the endpoint label to an empty string, after the creation of the private endpoint database, changes the private endpoint database to a public endpoint database.
- Setting the endpoint label to a non-empty string value, updates to a new private endpoint database, when the database is disabled and re-enabled.
- Refreshable
Mode string - (Updatable) The refresh mode of the clone. AUTOMATIC indicates that the clone is automatically being refreshed with data from the source Autonomous Database.
- Remote
Disaster stringRecovery Type - Indicates the cross-region disaster recovery (DR) type of the standby Autonomous Database Serverless instance. Autonomous Data Guard (ADG) DR type provides business critical DR with a faster recovery time objective (RTO) during failover or switchover. Backup-based DR type provides lower cost DR with a slower RTO during failover or switchover.
- Resource
Pool stringLeader Id - (Updatable) The unique identifier for leader autonomous database OCID OCID.
- Resource
Pool AutonomousSummary Database Resource Pool Summary - (Updatable) The configuration details for resource pool
- Rotate
Key boolTrigger - (Updatable) An optional property when flipped triggers rotation of KMS key. It is only applicable on dedicated databases i.e. where
is_dedicated
is true. - Scheduled
Operations List<AutonomousDatabase Scheduled Operation> (Updatable) The list of scheduled operations. Consists of values such as dayOfWeek, scheduledStartTime, scheduledStopTime.
This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, whitelistedIps, isMTLSConnectionRequired, openMode, permissionLevel, dbWorkload, privateEndpointLabel, nsgIds, dbVersion, isRefreshable, dbName, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier.
- Secret
Id string (Updatable) The Oracle Cloud Infrastructure vault secret [/Content/General/Concepts/identifiers.htm]OCID.
This cannot be used in conjunction with adminPassword.
- Secret
Version intNumber - (Updatable) The version of the vault secret. If no version is specified, the latest version will be used.
- Security
Attributes Dictionary<string, string> - (Updatable) Security Attributes for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "audit"}}}
- Shrink
Adb intTrigger - Source string
The source of the database:
- Use
NONE
for creating a new Autonomous Database. - Use
DATABASE
for creating a new Autonomous Database by cloning an existing running Autonomous Database from the latest timestamp, also provide the source database OCID in thesource_id
parameter. - Use
CROSS_REGION_DATAGUARD
to create a standby Data Guard database in another region, also provide the remote primary database OCID in thesource_id
parameter. - Use
CLONE_TO_REFRESHABLE
for creating a refreshable clone.
For Autonomous Database Serverless instances, the following cloning options are available:
- Use
BACKUP_FROM_ID
for creating a new Autonomous Database by cloning from a specified backup. Also provide the backup OCID in theautonomous_database_backup_id
parameter. - Use
BACKUP_FROM_TIMESTAMP
for creating a point-in-time Autonomous Database clone using backups. Also provide the backup timestamp in thetimestamp
parameter. For more information, see Cloning and Moving an Autonomous Database.
- Use
- Source
Id string - The OCID of the source Autonomous Database that will be used to create a new standby database for the Data Guard association.
- Standby
Whitelisted List<string>Ips (Updatable) The client IP access control list (ACL). This feature is available for [Autonomous Database Serverless] (https://docs.oracle.com/en/cloud/paas/autonomous-database/index.html) and on Exadata Cloud@Customer. Only clients connecting from an IP address included in the ACL may access the Autonomous Database instance. If
arePrimaryWhitelistedIpsUsed
is 'TRUE' then Autonomous Database uses this primary's IP access control list (ACL) for the disaster recovery peer calledstandbywhitelistedips
.For Autonomous Database Serverless instances, this is an array of CIDR (Classless Inter-Domain Routing) notations for a subnet or VCN OCID. Use a semicolon (;) as a deliminator between the VCN-specific subnets or IPs. Example:
["1.1.1.1","1.1.1.0/24","ocid1.vcn.oc1.sea.<unique_id>","ocid1.vcn.oc1.sea.<unique_id1>;1.1.1.1","ocid1.vcn.oc1.sea.<unique_id2>;1.1.0.0/16"]
For Exadata Cloud@Customer, this is an array of IP addresses or CIDR (Classless Inter-Domain Routing) notations. Example:["1.1.1.1","1.1.1.0/24","1.1.2.25"]
For an update operation, if you want to delete all the IPs in the ACL, use an array with a single empty string entry.
If
arePrimaryWhitelistedIpsUsed
is 'TRUE' then Autonomous Database useswhitelisted_ips
primary's IP access control list (ACL) asstandbywhitelistedips
for the disaster recovery peer.This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, isMTLSConnectionRequired, openMode, permissionLevel, dbWorkload, dbVersion, isRefreshable, dbName, scheduledOperations, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier.
- State string
- The current state of the Autonomous Database.
- Subnet
Id string (Updatable) The OCID of the subnet the resource is associated with. This the only parameter to configure private endpoint, VCN details are obtained from the
subnet_id
.Subnet Restrictions:
- For bare metal DB systems and for single node virtual machine DB systems, do not use a subnet that overlaps with 192.168.16.16/28.
- For Exadata and virtual machine 2-node RAC systems, do not use a subnet that overlaps with 192.168.128.0/20.
- For Autonomous Database, setting this will disable public secure access to the database.
- Subscription
Id string - The OCID of the subscription with which resource needs to be associated with. These subnets are used by the Oracle Clusterware private interconnect on the database instance. Specifying an overlapping subnet will cause the private interconnect to malfunction. This restriction applies to both the client subnet and the backup subnet.
- Switchover
To string - It is applicable only when
is_local_data_guard_enabled
is true. Could be set toPRIMARY
orSTANDBY
. Default value isPRIMARY
. - Switchover
To stringRemote Peer Id - (Updatable) It is applicable only when
dataguard_region_type
androle
are set, andis_dedicated
is false. For Autonomous Database Serverless instances, Data Guard associations have designated primary and standby regions, and these region types do not change when the database changes roles. It takes the OCID of the remote peer to switchover to and the API is called from the remote region. - Time
Of stringAuto Refresh Start - The the date and time that auto-refreshing will begin for an Autonomous Database refreshable clone. This value controls only the start time for the first refresh operation. Subsequent (ongoing) refresh operations have start times controlled by the value of the
autoRefreshFrequencyInSeconds
parameter. - Timestamp string
- The timestamp specified for the point-in-time clone of the source Autonomous Database. The timestamp must be in the past.
- Use
Latest boolAvailable Backup Time Stamp - Clone from latest available backup timestamp.
- Vault
Id string - The OCID of the Oracle Cloud Infrastructure vault.
- Whitelisted
Ips List<string> (Updatable) The client IP access control list (ACL). This feature is available for autonomous databases on shared Exadata infrastructure and on Exadata Cloud@Customer. Only clients connecting from an IP address included in the ACL may access the Autonomous Database instance.
For Autonomous Database Serverless instances, this is an array of CIDR (Classless Inter-Domain Routing) notations for a subnet or VCN OCID. Use a semicolon (;) as a deliminator between the VCN-specific subnets or IPs. Example:
["1.1.1.1","1.1.1.0/24","ocid1.vcn.oc1.sea.<unique_id>","ocid1.vcn.oc1.sea.<unique_id1>;1.1.1.1","ocid1.vcn.oc1.sea.<unique_id2>;1.1.0.0/16"]
For Exadata Cloud@Customer, this is an array of IP addresses or CIDR (Classless Inter-Domain Routing) notations. Example:["1.1.1.1","1.1.1.0/24","1.1.2.25"]
For an update operation, if you want to delete all the IPs in the ACL, use an array with a single empty string entry.
This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, isMTLSConnectionRequired, openMode, permissionLevel, dbWorkload, dbVersion, isRefreshable, dbName, scheduledOperations, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier. To remove all whitelisted IPs, set the field to a list with an empty string
[""]
.
- Compartment
Id string - (Updatable) The OCID of the compartment of the Autonomous Database.
- Db
Name string - The database name. The name must begin with an alphabetic character and can contain a maximum of 14 alphanumeric characters. Special characters are not permitted. The database name must be unique in the tenancy. It is required in all cases except when creating a cross-region Autonomous Data Guard standby instance or a cross-region disaster recovery standby instance.
- Admin
Password string - (Updatable) The password must be between 12 and 30 characters long, and must contain at least 1 uppercase, 1 lowercase, and 1 numeric character. It cannot contain the double quote symbol (") or the username "admin", regardless of casing. The password is mandatory if source value is "BACKUP_FROM_ID", "BACKUP_FROM_TIMESTAMP", "DATABASE" or "NONE".
- Are
Primary boolWhitelisted Ips Used - (Updatable) This field will be null if the Autonomous Database is not Data Guard enabled or Access Control is disabled. It's value would be
TRUE
if Autonomous Database is Data Guard enabled and Access Control is enabled and if the Autonomous Database uses primary IP access control list (ACL) for standby. It's value would beFALSE
if Autonomous Database is Data Guard enabled and Access Control is enabled and if the Autonomous Database uses different IP access control list (ACL) for standby compared to primary. - Auto
Refresh intFrequency In Seconds - (Updatable) The frequency a refreshable clone is refreshed after auto-refresh is enabled. The minimum is 1 hour. The maximum is 7 days. The date and time that auto-refresh is enabled is controlled by the
timeOfAutoRefreshStart
parameter. - Auto
Refresh intPoint Lag In Seconds - (Updatable) The time, in seconds, the data of the refreshable clone lags the primary database at the point of refresh. The minimum is 0 minutes (0 mins means refresh to the latest available timestamp). The maximum is 7 days. The lag time increases after refreshing until the next data refresh happens.
- Autonomous
Container stringDatabase Id - The Autonomous Container Database OCID.
- Autonomous
Database stringBackup Id - The OCID of the source Autonomous Database Backup that you will clone to create a new Autonomous Database.
- Autonomous
Database stringId - The OCID of the source Autonomous Database that you will clone to create a new Autonomous Database.
- Autonomous
Maintenance stringSchedule Type - The maintenance schedule type of the Autonomous Database Serverless instances. The EARLY maintenance schedule of this Autonomous Database follows a schedule that applies patches prior to the REGULAR schedule.The REGULAR maintenance schedule of this Autonomous Database follows the normal cycle.
- Backup
Retention intPeriod In Days - (Updatable) Retention period, in days, for backups.
- Byol
Compute float64Count Limit - Character
Set string The character set for the autonomous database. The default is AL32UTF8. Allowed values for an Autonomous Database on Serverless infrastructure as returned by List Autonomous Database Character Sets
For an Autonomous Database on dedicated infrastructure, the allowed values are:
AL32UTF8, AR8ADOS710, AR8ADOS720, AR8APTEC715, AR8ARABICMACS, AR8ASMO8X, AR8ISO8859P6, AR8MSWIN1256, AR8MUSSAD768, AR8NAFITHA711, AR8NAFITHA721, AR8SAKHR706, AR8SAKHR707, AZ8ISO8859P9E, BG8MSWIN, BG8PC437S, BLT8CP921, BLT8ISO8859P13, BLT8MSWIN1257, BLT8PC775, BN8BSCII, CDN8PC863, CEL8ISO8859P14, CL8ISO8859P5, CL8ISOIR111, CL8KOI8R, CL8KOI8U, CL8MACCYRILLICS, CL8MSWIN1251, EE8ISO8859P2, EE8MACCES, EE8MACCROATIANS, EE8MSWIN1250, EE8PC852, EL8DEC, EL8ISO8859P7, EL8MACGREEKS, EL8MSWIN1253, EL8PC437S, EL8PC851, EL8PC869, ET8MSWIN923, HU8ABMOD, HU8CWI2, IN8ISCII, IS8PC861, IW8ISO8859P8, IW8MACHEBREWS, IW8MSWIN1255, IW8PC1507, JA16EUC, JA16EUCTILDE, JA16SJIS, JA16SJISTILDE, JA16VMS, KO16KSC5601, KO16KSCCS, KO16MSWIN949, LA8ISO6937, LA8PASSPORT, LT8MSWIN921, LT8PC772, LT8PC774, LV8PC1117, LV8PC8LR, LV8RST104090, N8PC865, NE8ISO8859P10, NEE8ISO8859P4, RU8BESTA, RU8PC855, RU8PC866, SE8ISO8859P3, TH8MACTHAIS, TH8TISASCII, TR8DEC, TR8MACTURKISHS, TR8MSWIN1254, TR8PC857, US7ASCII, US8PC437, UTF8, VN8MSWIN1258, VN8VN3, WE8DEC, WE8DG, WE8ISO8859P1, WE8ISO8859P15, WE8ISO8859P9, WE8MACROMAN8S, WE8MSWIN1252, WE8NCR4970, WE8NEXTSTEP, WE8PC850, WE8PC858, WE8PC860, WE8ROMAN8, ZHS16CGB231280, ZHS16GBK, ZHT16BIG5, ZHT16CCDC, ZHT16DBT, ZHT16HKSCS, ZHT16MSWIN950, ZHT32EUC, ZHT32SOPS, ZHT32TRIS
- Clone
Type string - The Autonomous Database clone type. This parameter is not used to create a refreshable clone type, and for refreshable clones one must use the (source=CLONE_TO_REFRESHABLE) parameter.
FULL
- This option creates a new database that includes all source database data.METADATA
- This option creates a new database that includes the source database schema and select metadata, but not the source database data.
- Compute
Count float64 - (Updatable) The compute amount available to the database. Minimum and maximum values depend on the compute model and whether the database is an Autonomous Database Serverless instance or an Autonomous Database on Dedicated Exadata Infrastructure. For an Autonomous Database Serverless instance, the 'ECPU' compute model requires a minimum value of one, for databases in the elastic resource pool and minimum value of two, otherwise. Required when using the
computeModel
parameter. When usingcpuCoreCount
parameter, it is an error to specify computeCount to a non-null value. ProvidingcomputeModel
andcomputeCount
is the preferred method for both OCPU and ECPU. - Compute
Model string - (Updatable) The compute model of the Autonomous Database. This is required if using the
computeCount
parameter. If usingcpuCoreCount
then it is an error to specifycomputeModel
to a non-null value. ECPU compute model is the recommended model and OCPU compute model is legacy. - Cpu
Core intCount - (Updatable) The number of CPU cores to be made available to the database. For Autonomous Databases on dedicated Exadata infrastructure, the maximum number of cores is determined by the infrastructure shape. See Characteristics of Infrastructure Shapes for shape details.
Note: This parameter cannot be used with the
ocpuCount
parameter. This input is ignored for Always Free resources.- The data type must be an integer.
- The minimum number of cores for all types of autonomous database is 1
- The maximum number of cores is as follows:
- Autonomous Database Serverless instances: The maximum number of cores is 128.
- Autonomous Databases on dedicated Exadata infrastructure: The maximum number of cores is determined by the infrastructure shape. See Characteristics of Infrastructure Shapes for shape details.
- Providing
computeModel
andcomputeCount
is the preferred method for setting CPUs for both OCPU and ECPU.
- Customer
Contacts []AutonomousDatabase Customer Contact Args - (Updatable) Customer Contacts.
- Data
Safe stringStatus - (Updatable) Status of the Data Safe registration for this Autonomous Database. Could be REGISTERED or NOT_REGISTERED.
- Data
Storage intSize In Gb (Updatable) The size, in gigabytes, of the data volume that will be created and attached to the database. This storage can later be scaled up if needed. The maximum storage value is determined by the infrastructure shape. See Characteristics of Infrastructure Shapes for shape details.
Notes
- This parameter is only supported for dedicated Exadata infrastructure.
- This parameter cannot be used with the
dataStorageSizeInTBs
parameter.
- Data
Storage intSize In Tbs (Updatable) The size, in terabytes, of the data volume that will be created and attached to the database. This storage can later be scaled up if needed. For Autonomous Databases on dedicated Exadata infrastructure, the maximum storage value is determined by the infrastructure shape. See Characteristics of Infrastructure Shapes for shape details. A full Exadata service is allocated when the Autonomous Database size is set to the upper limit (384 TB).
Note: This parameter cannot be used with the
dataStorageSizeInGBs
parameter. This input is ignored for Always Free resources.- Database
Edition string - (Updatable) The Oracle Database Edition that applies to the Autonomous databases. It can be set to
ENTERPRISE_EDITION
orSTANDARD_EDITION
. - Database
Management stringStatus - Status of Database Management for this Autonomous Database.
- Db
Tools []AutonomousDetails Database Db Tools Detail Args (Updatable) The list of database tools details.
This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, whitelistedIps, isMTLSConnectionRequired, openMode, permissionLevel, dbWorkload, privateEndpointLabel, nsgIds, dbVersion, isRefreshable, dbName, scheduledOperations, isLocalDataGuardEnabled, or isFreeTier.
- Db
Version string - (Updatable) A valid Oracle Database version for Autonomous Database.
db_workload
AJD and APEX are only supported fordb_version
19c
and above. - Db
Workload string (Updatable) The Autonomous Database workload type. The following values are valid:
- OLTP - indicates an Autonomous Transaction Processing database
- DW - indicates an Autonomous Data Warehouse database
- AJD - indicates an Autonomous JSON Database
- APEX - indicates an Autonomous Database with the Oracle APEX Application Development workload type.
This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, isMTLSConnectionRequired, privateEndpointLabel, nsgIds, dbVersion, isRefreshable, dbName, scheduledOperations, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier. *Note:
db_workload
can only be updated from AJD to OLTP or from a free OLTP to AJD.- map[string]string
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- Disaster
Recovery stringType - Indicates the disaster recovery (DR) type of the standby Autonomous Database Serverless instance. Autonomous Data Guard (ADG) DR type provides business critical DR with a faster recovery time objective (RTO) during failover or switchover. Backup-based DR type provides lower cost DR with a slower RTO during failover or switchover.
- Display
Name string - (Updatable) The user-friendly name for the Autonomous Database. The name does not have to be unique.
- Encryption
Key AutonomousDatabase Encryption Key Args - (Updatable) Details of the Autonomous Database encryption key.
- map[string]string
- (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example:
{"Department": "Finance"}
- In
Memory intPercentage - (Updatable) The percentage of the System Global Area(SGA) assigned to In-Memory tables in Autonomous Database. This property is applicable only to Autonomous Databases on the Exadata Cloud@Customer platform.
- Is
Access boolControl Enabled (Updatable) Indicates if the database-level access control is enabled. If disabled, database access is defined by the network security rules. If enabled, database access is restricted to the IP addresses defined by the rules specified with the
whitelistedIps
property. While specifyingwhitelistedIps
rules is optional, if database-level access control is enabled and no rules are specified, the database will become inaccessible. The rules can be added later using theUpdateAutonomousDatabase
API operation or edit option in console. When creating a database clone, the desired access control setting should be specified. By default, database-level access control will be disabled for the clone.This property is applicable only to Autonomous Databases on the Exadata Cloud@Customer platform. For Autonomous Database Serverless instances,
whitelistedIps
is used.- Is
Auto boolScaling Enabled - (Updatable) Indicates if auto scaling is enabled for the Autonomous Database CPU core count. The default value is
TRUE
. - Is
Auto boolScaling For Storage Enabled - (Updatable) Indicates if auto scaling is enabled for the Autonomous Database storage. The default value is
FALSE
. - Is
Data boolGuard Enabled - (Updatable) Deprecated. Indicates whether the Autonomous Database has local (in-region) Data Guard enabled. Not applicable to cross-region Autonomous Data Guard associations, or to Autonomous Databases using dedicated Exadata infrastructure or Exadata Cloud@Customer infrastructure.
- Is
Dedicated bool - True if the database is on dedicated Exadata infrastructure.
- Is
Dev boolTier - (Updatable) Autonomous Database for Developers are free Autonomous Databases that developers can use to build and test new applications.With Autonomous these database instancess instances, you can try new Autonomous Database features for free and apply them to ongoing or new development projects. Developer database comes with limited resources and is, therefore, not suitable for large-scale testing and production deployments. When you need more compute or storage resources, you can transition to a paid database licensing by cloning your developer database into a regular Autonomous Database. See Autonomous Database documentation for more details.
- Is
Free boolTier - (Updatable) Indicates if this is an Always Free resource. The default value is false. Note that Always Free Autonomous Databases have 1 CPU and 20GB of memory. For Always Free databases, memory and CPU cannot be scaled. When
db_workload
isAJD
orAPEX
it cannot betrue
. - Is
Local boolData Guard Enabled - (Updatable) Indicates whether the Autonomous Database has local (in-region) Data Guard enabled. It takes boolean values. Not applicable to cross-region Autonomous Data Guard associations, or to Autonomous Databases using dedicated Exadata infrastructure or Exadata Cloud@Customer infrastructure.
- Is
Mtls boolConnection Required - (Updatable) Indicates whether the Autonomous Database requires mTLS connections.
- Is
Preview boolVersion With Service Terms Accepted - If set to
TRUE
, indicates that an Autonomous Database preview version is being provisioned, and that the preview version's terms of service have been accepted. Note that preview version software is only available for databases on Autonomous Database Serverless. - Is
Refreshable boolClone - (Updatable) True for creating a refreshable clone and False for detaching the clone from source Autonomous Database. Detaching is one time operation and clone becomes a regular Autonomous Database.
- Is
Replicate boolAutomatic Backups - If true, 7 days worth of backups are replicated across regions for Cross-Region ADB or Backup-Based DR between Primary and Standby. If false, the backups taken on the Primary are not replicated to the Standby database.
- Is
Shrink boolOnly (Updatable) An optional property when enabled triggers the Shrinking of Autonomous Database once. To trigger Shrinking of ADB once again, this flag needs to be disabled and re-enabled again. It should not be passed during create database operation. It is only applicable on Serverless databases i.e. where
is_dedicated
is false.** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- Key
Version stringId - The OCID of the key version that is used in rotate key operations.
- Kms
Key stringId - The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
- License
Model string - (Updatable) The Oracle license model that applies to the Oracle Autonomous Database. Bring your own license (BYOL) allows you to apply your current on-premises Oracle software licenses to equivalent, highly automated Oracle PaaS and IaaS services in the cloud. License Included allows you to subscribe to new Oracle Database software licenses and the Database service. Note that when provisioning an Autonomous Database on dedicated Exadata infrastructure, this attribute must be null because the attribute is already set at the Autonomous Exadata Infrastructure level. When using shared Exadata infrastructure, if a value is not specified, the system will supply the value of
BRING_YOUR_OWN_LICENSE
. It is a required field whendb_workload
is AJD and needs to be set toLICENSE_INCLUDED
as AJD does not support defaultlicense_model
valueBRING_YOUR_OWN_LICENSE
. - Local
Adg intAuto Failover Max Data Loss Limit - Parameter that allows users to select an acceptable maximum data loss limit in seconds, up to which Automatic Failover will be triggered when necessary for a Local Autonomous Data Guard
- Long
Term []AutonomousBackup Schedules Database Long Term Backup Schedule Args - Details for the long-term backup schedule.
- Max
Cpu intCore Count - (Updatable) Deprecated. The number of Max OCPU cores to be made available to the autonomous database with auto scaling of cpu enabled.
- Ncharacter
Set string - The national character set for the autonomous database. The default is AL16UTF16. Allowed values are: AL16UTF16 or UTF8.
- Nsg
Ids []string - (Updatable) The list of OCIDs for the network security groups (NSGs) to which this resource belongs. Setting this to an empty list removes all resources from all NSGs. For more information about NSGs, see Security Rules. NsgIds restrictions:
- A network security group (NSG) is optional for Autonomous Databases with private access. The nsgIds list can be empty.
- Ocpu
Count float64 (Updatable) The number of OCPU cores to be made available to the database.
- Providing
computeModel
andcomputeCount
is the preferred method for setting CPUs for both OCPU and ECPU. The following points apply: - For Autonomous Databases on dedicated Exadata infrastructure, to provision less than 1 core, enter a fractional value in an increment of 0.1. For example, you can provision 0.3 or 0.4 cores, but not 0.35 cores. (Note that fractional OCPU values are not supported for Autonomous Databasese on shared Exadata infrastructure.)
- To provision 1 or more cores, you must enter an integer between 1 and the maximum number of cores available for the infrastructure shape. For example, you can provision 2 cores or 3 cores, but not 2.5 cores. This applies to Autonomous Databases on both shared and dedicated Exadata infrastructure.
For Autonomous Databases on dedicated Exadata infrastructure, the maximum number of cores is determined by the infrastructure shape. See Characteristics of Infrastructure Shapes for shape details.
Note: This parameter cannot be used with the
cpuCoreCount
parameter.- Providing
- Open
Mode string - Indicates the Autonomous Database mode. The database can be opened in
READ_ONLY
orREAD_WRITE
mode. - Operations
Insights stringStatus - (Updatable) Status of Operations Insights for this Autonomous Database. Values supported are
ENABLED
andNOT_ENABLED
- Permission
Level string - The Autonomous Database permission level. Restricted mode allows access only by admin users.
- Private
Endpoint stringIp - The private endpoint Ip address for the resource.
- Private
Endpoint stringLabel - (Updatable) (Optional) (Updatable) The resource's private endpoint label.
- Setting the endpoint label to a non-empty string creates a private endpoint database.
- Resetting the endpoint label to an empty string, after the creation of the private endpoint database, changes the private endpoint database to a public endpoint database.
- Setting the endpoint label to a non-empty string value, updates to a new private endpoint database, when the database is disabled and re-enabled.
- Refreshable
Mode string - (Updatable) The refresh mode of the clone. AUTOMATIC indicates that the clone is automatically being refreshed with data from the source Autonomous Database.
- Remote
Disaster stringRecovery Type - Indicates the cross-region disaster recovery (DR) type of the standby Autonomous Database Serverless instance. Autonomous Data Guard (ADG) DR type provides business critical DR with a faster recovery time objective (RTO) during failover or switchover. Backup-based DR type provides lower cost DR with a slower RTO during failover or switchover.
- Resource
Pool stringLeader Id - (Updatable) The unique identifier for leader autonomous database OCID OCID.
- Resource
Pool AutonomousSummary Database Resource Pool Summary Args - (Updatable) The configuration details for resource pool
- Rotate
Key boolTrigger - (Updatable) An optional property when flipped triggers rotation of KMS key. It is only applicable on dedicated databases i.e. where
is_dedicated
is true. - Scheduled
Operations []AutonomousDatabase Scheduled Operation Args (Updatable) The list of scheduled operations. Consists of values such as dayOfWeek, scheduledStartTime, scheduledStopTime.
This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, whitelistedIps, isMTLSConnectionRequired, openMode, permissionLevel, dbWorkload, privateEndpointLabel, nsgIds, dbVersion, isRefreshable, dbName, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier.
- Secret
Id string (Updatable) The Oracle Cloud Infrastructure vault secret [/Content/General/Concepts/identifiers.htm]OCID.
This cannot be used in conjunction with adminPassword.
- Secret
Version intNumber - (Updatable) The version of the vault secret. If no version is specified, the latest version will be used.
- Security
Attributes map[string]string - (Updatable) Security Attributes for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "audit"}}}
- Shrink
Adb intTrigger - Source string
The source of the database:
- Use
NONE
for creating a new Autonomous Database. - Use
DATABASE
for creating a new Autonomous Database by cloning an existing running Autonomous Database from the latest timestamp, also provide the source database OCID in thesource_id
parameter. - Use
CROSS_REGION_DATAGUARD
to create a standby Data Guard database in another region, also provide the remote primary database OCID in thesource_id
parameter. - Use
CLONE_TO_REFRESHABLE
for creating a refreshable clone.
For Autonomous Database Serverless instances, the following cloning options are available:
- Use
BACKUP_FROM_ID
for creating a new Autonomous Database by cloning from a specified backup. Also provide the backup OCID in theautonomous_database_backup_id
parameter. - Use
BACKUP_FROM_TIMESTAMP
for creating a point-in-time Autonomous Database clone using backups. Also provide the backup timestamp in thetimestamp
parameter. For more information, see Cloning and Moving an Autonomous Database.
- Use
- Source
Id string - The OCID of the source Autonomous Database that will be used to create a new standby database for the Data Guard association.
- Standby
Whitelisted []stringIps (Updatable) The client IP access control list (ACL). This feature is available for [Autonomous Database Serverless] (https://docs.oracle.com/en/cloud/paas/autonomous-database/index.html) and on Exadata Cloud@Customer. Only clients connecting from an IP address included in the ACL may access the Autonomous Database instance. If
arePrimaryWhitelistedIpsUsed
is 'TRUE' then Autonomous Database uses this primary's IP access control list (ACL) for the disaster recovery peer calledstandbywhitelistedips
.For Autonomous Database Serverless instances, this is an array of CIDR (Classless Inter-Domain Routing) notations for a subnet or VCN OCID. Use a semicolon (;) as a deliminator between the VCN-specific subnets or IPs. Example:
["1.1.1.1","1.1.1.0/24","ocid1.vcn.oc1.sea.<unique_id>","ocid1.vcn.oc1.sea.<unique_id1>;1.1.1.1","ocid1.vcn.oc1.sea.<unique_id2>;1.1.0.0/16"]
For Exadata Cloud@Customer, this is an array of IP addresses or CIDR (Classless Inter-Domain Routing) notations. Example:["1.1.1.1","1.1.1.0/24","1.1.2.25"]
For an update operation, if you want to delete all the IPs in the ACL, use an array with a single empty string entry.
If
arePrimaryWhitelistedIpsUsed
is 'TRUE' then Autonomous Database useswhitelisted_ips
primary's IP access control list (ACL) asstandbywhitelistedips
for the disaster recovery peer.This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, isMTLSConnectionRequired, openMode, permissionLevel, dbWorkload, dbVersion, isRefreshable, dbName, scheduledOperations, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier.
- State string
- The current state of the Autonomous Database.
- Subnet
Id string (Updatable) The OCID of the subnet the resource is associated with. This the only parameter to configure private endpoint, VCN details are obtained from the
subnet_id
.Subnet Restrictions:
- For bare metal DB systems and for single node virtual machine DB systems, do not use a subnet that overlaps with 192.168.16.16/28.
- For Exadata and virtual machine 2-node RAC systems, do not use a subnet that overlaps with 192.168.128.0/20.
- For Autonomous Database, setting this will disable public secure access to the database.
- Subscription
Id string - The OCID of the subscription with which resource needs to be associated with. These subnets are used by the Oracle Clusterware private interconnect on the database instance. Specifying an overlapping subnet will cause the private interconnect to malfunction. This restriction applies to both the client subnet and the backup subnet.
- Switchover
To string - It is applicable only when
is_local_data_guard_enabled
is true. Could be set toPRIMARY
orSTANDBY
. Default value isPRIMARY
. - Switchover
To stringRemote Peer Id - (Updatable) It is applicable only when
dataguard_region_type
androle
are set, andis_dedicated
is false. For Autonomous Database Serverless instances, Data Guard associations have designated primary and standby regions, and these region types do not change when the database changes roles. It takes the OCID of the remote peer to switchover to and the API is called from the remote region. - Time
Of stringAuto Refresh Start - The the date and time that auto-refreshing will begin for an Autonomous Database refreshable clone. This value controls only the start time for the first refresh operation. Subsequent (ongoing) refresh operations have start times controlled by the value of the
autoRefreshFrequencyInSeconds
parameter. - Timestamp string
- The timestamp specified for the point-in-time clone of the source Autonomous Database. The timestamp must be in the past.
- Use
Latest boolAvailable Backup Time Stamp - Clone from latest available backup timestamp.
- Vault
Id string - The OCID of the Oracle Cloud Infrastructure vault.
- Whitelisted
Ips []string (Updatable) The client IP access control list (ACL). This feature is available for autonomous databases on shared Exadata infrastructure and on Exadata Cloud@Customer. Only clients connecting from an IP address included in the ACL may access the Autonomous Database instance.
For Autonomous Database Serverless instances, this is an array of CIDR (Classless Inter-Domain Routing) notations for a subnet or VCN OCID. Use a semicolon (;) as a deliminator between the VCN-specific subnets or IPs. Example:
["1.1.1.1","1.1.1.0/24","ocid1.vcn.oc1.sea.<unique_id>","ocid1.vcn.oc1.sea.<unique_id1>;1.1.1.1","ocid1.vcn.oc1.sea.<unique_id2>;1.1.0.0/16"]
For Exadata Cloud@Customer, this is an array of IP addresses or CIDR (Classless Inter-Domain Routing) notations. Example:["1.1.1.1","1.1.1.0/24","1.1.2.25"]
For an update operation, if you want to delete all the IPs in the ACL, use an array with a single empty string entry.
This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, isMTLSConnectionRequired, openMode, permissionLevel, dbWorkload, dbVersion, isRefreshable, dbName, scheduledOperations, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier. To remove all whitelisted IPs, set the field to a list with an empty string
[""]
.
- compartment
Id String - (Updatable) The OCID of the compartment of the Autonomous Database.
- db
Name String - The database name. The name must begin with an alphabetic character and can contain a maximum of 14 alphanumeric characters. Special characters are not permitted. The database name must be unique in the tenancy. It is required in all cases except when creating a cross-region Autonomous Data Guard standby instance or a cross-region disaster recovery standby instance.
- admin
Password String - (Updatable) The password must be between 12 and 30 characters long, and must contain at least 1 uppercase, 1 lowercase, and 1 numeric character. It cannot contain the double quote symbol (") or the username "admin", regardless of casing. The password is mandatory if source value is "BACKUP_FROM_ID", "BACKUP_FROM_TIMESTAMP", "DATABASE" or "NONE".
- are
Primary BooleanWhitelisted Ips Used - (Updatable) This field will be null if the Autonomous Database is not Data Guard enabled or Access Control is disabled. It's value would be
TRUE
if Autonomous Database is Data Guard enabled and Access Control is enabled and if the Autonomous Database uses primary IP access control list (ACL) for standby. It's value would beFALSE
if Autonomous Database is Data Guard enabled and Access Control is enabled and if the Autonomous Database uses different IP access control list (ACL) for standby compared to primary. - auto
Refresh IntegerFrequency In Seconds - (Updatable) The frequency a refreshable clone is refreshed after auto-refresh is enabled. The minimum is 1 hour. The maximum is 7 days. The date and time that auto-refresh is enabled is controlled by the
timeOfAutoRefreshStart
parameter. - auto
Refresh IntegerPoint Lag In Seconds - (Updatable) The time, in seconds, the data of the refreshable clone lags the primary database at the point of refresh. The minimum is 0 minutes (0 mins means refresh to the latest available timestamp). The maximum is 7 days. The lag time increases after refreshing until the next data refresh happens.
- autonomous
Container StringDatabase Id - The Autonomous Container Database OCID.
- autonomous
Database StringBackup Id - The OCID of the source Autonomous Database Backup that you will clone to create a new Autonomous Database.
- autonomous
Database StringId - The OCID of the source Autonomous Database that you will clone to create a new Autonomous Database.
- autonomous
Maintenance StringSchedule Type - The maintenance schedule type of the Autonomous Database Serverless instances. The EARLY maintenance schedule of this Autonomous Database follows a schedule that applies patches prior to the REGULAR schedule.The REGULAR maintenance schedule of this Autonomous Database follows the normal cycle.
- backup
Retention IntegerPeriod In Days - (Updatable) Retention period, in days, for backups.
- byol
Compute DoubleCount Limit - character
Set String The character set for the autonomous database. The default is AL32UTF8. Allowed values for an Autonomous Database on Serverless infrastructure as returned by List Autonomous Database Character Sets
For an Autonomous Database on dedicated infrastructure, the allowed values are:
AL32UTF8, AR8ADOS710, AR8ADOS720, AR8APTEC715, AR8ARABICMACS, AR8ASMO8X, AR8ISO8859P6, AR8MSWIN1256, AR8MUSSAD768, AR8NAFITHA711, AR8NAFITHA721, AR8SAKHR706, AR8SAKHR707, AZ8ISO8859P9E, BG8MSWIN, BG8PC437S, BLT8CP921, BLT8ISO8859P13, BLT8MSWIN1257, BLT8PC775, BN8BSCII, CDN8PC863, CEL8ISO8859P14, CL8ISO8859P5, CL8ISOIR111, CL8KOI8R, CL8KOI8U, CL8MACCYRILLICS, CL8MSWIN1251, EE8ISO8859P2, EE8MACCES, EE8MACCROATIANS, EE8MSWIN1250, EE8PC852, EL8DEC, EL8ISO8859P7, EL8MACGREEKS, EL8MSWIN1253, EL8PC437S, EL8PC851, EL8PC869, ET8MSWIN923, HU8ABMOD, HU8CWI2, IN8ISCII, IS8PC861, IW8ISO8859P8, IW8MACHEBREWS, IW8MSWIN1255, IW8PC1507, JA16EUC, JA16EUCTILDE, JA16SJIS, JA16SJISTILDE, JA16VMS, KO16KSC5601, KO16KSCCS, KO16MSWIN949, LA8ISO6937, LA8PASSPORT, LT8MSWIN921, LT8PC772, LT8PC774, LV8PC1117, LV8PC8LR, LV8RST104090, N8PC865, NE8ISO8859P10, NEE8ISO8859P4, RU8BESTA, RU8PC855, RU8PC866, SE8ISO8859P3, TH8MACTHAIS, TH8TISASCII, TR8DEC, TR8MACTURKISHS, TR8MSWIN1254, TR8PC857, US7ASCII, US8PC437, UTF8, VN8MSWIN1258, VN8VN3, WE8DEC, WE8DG, WE8ISO8859P1, WE8ISO8859P15, WE8ISO8859P9, WE8MACROMAN8S, WE8MSWIN1252, WE8NCR4970, WE8NEXTSTEP, WE8PC850, WE8PC858, WE8PC860, WE8ROMAN8, ZHS16CGB231280, ZHS16GBK, ZHT16BIG5, ZHT16CCDC, ZHT16DBT, ZHT16HKSCS, ZHT16MSWIN950, ZHT32EUC, ZHT32SOPS, ZHT32TRIS
- clone
Type String - The Autonomous Database clone type. This parameter is not used to create a refreshable clone type, and for refreshable clones one must use the (source=CLONE_TO_REFRESHABLE) parameter.
FULL
- This option creates a new database that includes all source database data.METADATA
- This option creates a new database that includes the source database schema and select metadata, but not the source database data.
- compute
Count Double - (Updatable) The compute amount available to the database. Minimum and maximum values depend on the compute model and whether the database is an Autonomous Database Serverless instance or an Autonomous Database on Dedicated Exadata Infrastructure. For an Autonomous Database Serverless instance, the 'ECPU' compute model requires a minimum value of one, for databases in the elastic resource pool and minimum value of two, otherwise. Required when using the
computeModel
parameter. When usingcpuCoreCount
parameter, it is an error to specify computeCount to a non-null value. ProvidingcomputeModel
andcomputeCount
is the preferred method for both OCPU and ECPU. - compute
Model String - (Updatable) The compute model of the Autonomous Database. This is required if using the
computeCount
parameter. If usingcpuCoreCount
then it is an error to specifycomputeModel
to a non-null value. ECPU compute model is the recommended model and OCPU compute model is legacy. - cpu
Core IntegerCount - (Updatable) The number of CPU cores to be made available to the database. For Autonomous Databases on dedicated Exadata infrastructure, the maximum number of cores is determined by the infrastructure shape. See Characteristics of Infrastructure Shapes for shape details.
Note: This parameter cannot be used with the
ocpuCount
parameter. This input is ignored for Always Free resources.- The data type must be an integer.
- The minimum number of cores for all types of autonomous database is 1
- The maximum number of cores is as follows:
- Autonomous Database Serverless instances: The maximum number of cores is 128.
- Autonomous Databases on dedicated Exadata infrastructure: The maximum number of cores is determined by the infrastructure shape. See Characteristics of Infrastructure Shapes for shape details.
- Providing
computeModel
andcomputeCount
is the preferred method for setting CPUs for both OCPU and ECPU.
- customer
Contacts List<AutonomousCustomer Contact> - (Updatable) Customer Contacts.
- data
Safe StringStatus - (Updatable) Status of the Data Safe registration for this Autonomous Database. Could be REGISTERED or NOT_REGISTERED.
- data
Storage IntegerSize In Gb (Updatable) The size, in gigabytes, of the data volume that will be created and attached to the database. This storage can later be scaled up if needed. The maximum storage value is determined by the infrastructure shape. See Characteristics of Infrastructure Shapes for shape details.
Notes
- This parameter is only supported for dedicated Exadata infrastructure.
- This parameter cannot be used with the
dataStorageSizeInTBs
parameter.
- data
Storage IntegerSize In Tbs (Updatable) The size, in terabytes, of the data volume that will be created and attached to the database. This storage can later be scaled up if needed. For Autonomous Databases on dedicated Exadata infrastructure, the maximum storage value is determined by the infrastructure shape. See Characteristics of Infrastructure Shapes for shape details. A full Exadata service is allocated when the Autonomous Database size is set to the upper limit (384 TB).
Note: This parameter cannot be used with the
dataStorageSizeInGBs
parameter. This input is ignored for Always Free resources.- database
Edition String - (Updatable) The Oracle Database Edition that applies to the Autonomous databases. It can be set to
ENTERPRISE_EDITION
orSTANDARD_EDITION
. - database
Management StringStatus - Status of Database Management for this Autonomous Database.
- db
Tools List<AutonomousDetails Db Tools Detail> (Updatable) The list of database tools details.
This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, whitelistedIps, isMTLSConnectionRequired, openMode, permissionLevel, dbWorkload, privateEndpointLabel, nsgIds, dbVersion, isRefreshable, dbName, scheduledOperations, isLocalDataGuardEnabled, or isFreeTier.
- db
Version String - (Updatable) A valid Oracle Database version for Autonomous Database.
db_workload
AJD and APEX are only supported fordb_version
19c
and above. - db
Workload String (Updatable) The Autonomous Database workload type. The following values are valid:
- OLTP - indicates an Autonomous Transaction Processing database
- DW - indicates an Autonomous Data Warehouse database
- AJD - indicates an Autonomous JSON Database
- APEX - indicates an Autonomous Database with the Oracle APEX Application Development workload type.
This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, isMTLSConnectionRequired, privateEndpointLabel, nsgIds, dbVersion, isRefreshable, dbName, scheduledOperations, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier. *Note:
db_workload
can only be updated from AJD to OLTP or from a free OLTP to AJD.- Map<String,String>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- disaster
Recovery StringType - Indicates the disaster recovery (DR) type of the standby Autonomous Database Serverless instance. Autonomous Data Guard (ADG) DR type provides business critical DR with a faster recovery time objective (RTO) during failover or switchover. Backup-based DR type provides lower cost DR with a slower RTO during failover or switchover.
- display
Name String - (Updatable) The user-friendly name for the Autonomous Database. The name does not have to be unique.
- encryption
Key AutonomousEncryption Key - (Updatable) Details of the Autonomous Database encryption key.
- Map<String,String>
- (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example:
{"Department": "Finance"}
- in
Memory IntegerPercentage - (Updatable) The percentage of the System Global Area(SGA) assigned to In-Memory tables in Autonomous Database. This property is applicable only to Autonomous Databases on the Exadata Cloud@Customer platform.
- is
Access BooleanControl Enabled (Updatable) Indicates if the database-level access control is enabled. If disabled, database access is defined by the network security rules. If enabled, database access is restricted to the IP addresses defined by the rules specified with the
whitelistedIps
property. While specifyingwhitelistedIps
rules is optional, if database-level access control is enabled and no rules are specified, the database will become inaccessible. The rules can be added later using theUpdateAutonomousDatabase
API operation or edit option in console. When creating a database clone, the desired access control setting should be specified. By default, database-level access control will be disabled for the clone.This property is applicable only to Autonomous Databases on the Exadata Cloud@Customer platform. For Autonomous Database Serverless instances,
whitelistedIps
is used.- is
Auto BooleanScaling Enabled - (Updatable) Indicates if auto scaling is enabled for the Autonomous Database CPU core count. The default value is
TRUE
. - is
Auto BooleanScaling For Storage Enabled - (Updatable) Indicates if auto scaling is enabled for the Autonomous Database storage. The default value is
FALSE
. - is
Data BooleanGuard Enabled - (Updatable) Deprecated. Indicates whether the Autonomous Database has local (in-region) Data Guard enabled. Not applicable to cross-region Autonomous Data Guard associations, or to Autonomous Databases using dedicated Exadata infrastructure or Exadata Cloud@Customer infrastructure.
- is
Dedicated Boolean - True if the database is on dedicated Exadata infrastructure.
- is
Dev BooleanTier - (Updatable) Autonomous Database for Developers are free Autonomous Databases that developers can use to build and test new applications.With Autonomous these database instancess instances, you can try new Autonomous Database features for free and apply them to ongoing or new development projects. Developer database comes with limited resources and is, therefore, not suitable for large-scale testing and production deployments. When you need more compute or storage resources, you can transition to a paid database licensing by cloning your developer database into a regular Autonomous Database. See Autonomous Database documentation for more details.
- is
Free BooleanTier - (Updatable) Indicates if this is an Always Free resource. The default value is false. Note that Always Free Autonomous Databases have 1 CPU and 20GB of memory. For Always Free databases, memory and CPU cannot be scaled. When
db_workload
isAJD
orAPEX
it cannot betrue
. - is
Local BooleanData Guard Enabled - (Updatable) Indicates whether the Autonomous Database has local (in-region) Data Guard enabled. It takes boolean values. Not applicable to cross-region Autonomous Data Guard associations, or to Autonomous Databases using dedicated Exadata infrastructure or Exadata Cloud@Customer infrastructure.
- is
Mtls BooleanConnection Required - (Updatable) Indicates whether the Autonomous Database requires mTLS connections.
- is
Preview BooleanVersion With Service Terms Accepted - If set to
TRUE
, indicates that an Autonomous Database preview version is being provisioned, and that the preview version's terms of service have been accepted. Note that preview version software is only available for databases on Autonomous Database Serverless. - is
Refreshable BooleanClone - (Updatable) True for creating a refreshable clone and False for detaching the clone from source Autonomous Database. Detaching is one time operation and clone becomes a regular Autonomous Database.
- is
Replicate BooleanAutomatic Backups - If true, 7 days worth of backups are replicated across regions for Cross-Region ADB or Backup-Based DR between Primary and Standby. If false, the backups taken on the Primary are not replicated to the Standby database.
- is
Shrink BooleanOnly (Updatable) An optional property when enabled triggers the Shrinking of Autonomous Database once. To trigger Shrinking of ADB once again, this flag needs to be disabled and re-enabled again. It should not be passed during create database operation. It is only applicable on Serverless databases i.e. where
is_dedicated
is false.** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- key
Version StringId - The OCID of the key version that is used in rotate key operations.
- kms
Key StringId - The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
- license
Model String - (Updatable) The Oracle license model that applies to the Oracle Autonomous Database. Bring your own license (BYOL) allows you to apply your current on-premises Oracle software licenses to equivalent, highly automated Oracle PaaS and IaaS services in the cloud. License Included allows you to subscribe to new Oracle Database software licenses and the Database service. Note that when provisioning an Autonomous Database on dedicated Exadata infrastructure, this attribute must be null because the attribute is already set at the Autonomous Exadata Infrastructure level. When using shared Exadata infrastructure, if a value is not specified, the system will supply the value of
BRING_YOUR_OWN_LICENSE
. It is a required field whendb_workload
is AJD and needs to be set toLICENSE_INCLUDED
as AJD does not support defaultlicense_model
valueBRING_YOUR_OWN_LICENSE
. - local
Adg IntegerAuto Failover Max Data Loss Limit - Parameter that allows users to select an acceptable maximum data loss limit in seconds, up to which Automatic Failover will be triggered when necessary for a Local Autonomous Data Guard
- long
Term List<AutonomousBackup Schedules Long Term Backup Schedule> - Details for the long-term backup schedule.
- max
Cpu IntegerCore Count - (Updatable) Deprecated. The number of Max OCPU cores to be made available to the autonomous database with auto scaling of cpu enabled.
- ncharacter
Set String - The national character set for the autonomous database. The default is AL16UTF16. Allowed values are: AL16UTF16 or UTF8.
- nsg
Ids List<String> - (Updatable) The list of OCIDs for the network security groups (NSGs) to which this resource belongs. Setting this to an empty list removes all resources from all NSGs. For more information about NSGs, see Security Rules. NsgIds restrictions:
- A network security group (NSG) is optional for Autonomous Databases with private access. The nsgIds list can be empty.
- ocpu
Count Double (Updatable) The number of OCPU cores to be made available to the database.
- Providing
computeModel
andcomputeCount
is the preferred method for setting CPUs for both OCPU and ECPU. The following points apply: - For Autonomous Databases on dedicated Exadata infrastructure, to provision less than 1 core, enter a fractional value in an increment of 0.1. For example, you can provision 0.3 or 0.4 cores, but not 0.35 cores. (Note that fractional OCPU values are not supported for Autonomous Databasese on shared Exadata infrastructure.)
- To provision 1 or more cores, you must enter an integer between 1 and the maximum number of cores available for the infrastructure shape. For example, you can provision 2 cores or 3 cores, but not 2.5 cores. This applies to Autonomous Databases on both shared and dedicated Exadata infrastructure.
For Autonomous Databases on dedicated Exadata infrastructure, the maximum number of cores is determined by the infrastructure shape. See Characteristics of Infrastructure Shapes for shape details.
Note: This parameter cannot be used with the
cpuCoreCount
parameter.- Providing
- open
Mode String - Indicates the Autonomous Database mode. The database can be opened in
READ_ONLY
orREAD_WRITE
mode. - operations
Insights StringStatus - (Updatable) Status of Operations Insights for this Autonomous Database. Values supported are
ENABLED
andNOT_ENABLED
- permission
Level String - The Autonomous Database permission level. Restricted mode allows access only by admin users.
- private
Endpoint StringIp - The private endpoint Ip address for the resource.
- private
Endpoint StringLabel - (Updatable) (Optional) (Updatable) The resource's private endpoint label.
- Setting the endpoint label to a non-empty string creates a private endpoint database.
- Resetting the endpoint label to an empty string, after the creation of the private endpoint database, changes the private endpoint database to a public endpoint database.
- Setting the endpoint label to a non-empty string value, updates to a new private endpoint database, when the database is disabled and re-enabled.
- refreshable
Mode String - (Updatable) The refresh mode of the clone. AUTOMATIC indicates that the clone is automatically being refreshed with data from the source Autonomous Database.
- remote
Disaster StringRecovery Type - Indicates the cross-region disaster recovery (DR) type of the standby Autonomous Database Serverless instance. Autonomous Data Guard (ADG) DR type provides business critical DR with a faster recovery time objective (RTO) during failover or switchover. Backup-based DR type provides lower cost DR with a slower RTO during failover or switchover.
- resource
Pool StringLeader Id - (Updatable) The unique identifier for leader autonomous database OCID OCID.
- resource
Pool AutonomousSummary Resource Pool Summary - (Updatable) The configuration details for resource pool
- rotate
Key BooleanTrigger - (Updatable) An optional property when flipped triggers rotation of KMS key. It is only applicable on dedicated databases i.e. where
is_dedicated
is true. - scheduled
Operations List<AutonomousScheduled Operation> (Updatable) The list of scheduled operations. Consists of values such as dayOfWeek, scheduledStartTime, scheduledStopTime.
This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, whitelistedIps, isMTLSConnectionRequired, openMode, permissionLevel, dbWorkload, privateEndpointLabel, nsgIds, dbVersion, isRefreshable, dbName, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier.
- secret
Id String (Updatable) The Oracle Cloud Infrastructure vault secret [/Content/General/Concepts/identifiers.htm]OCID.
This cannot be used in conjunction with adminPassword.
- secret
Version IntegerNumber - (Updatable) The version of the vault secret. If no version is specified, the latest version will be used.
- security
Attributes Map<String,String> - (Updatable) Security Attributes for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "audit"}}}
- shrink
Adb IntegerTrigger - source String
The source of the database:
- Use
NONE
for creating a new Autonomous Database. - Use
DATABASE
for creating a new Autonomous Database by cloning an existing running Autonomous Database from the latest timestamp, also provide the source database OCID in thesource_id
parameter. - Use
CROSS_REGION_DATAGUARD
to create a standby Data Guard database in another region, also provide the remote primary database OCID in thesource_id
parameter. - Use
CLONE_TO_REFRESHABLE
for creating a refreshable clone.
For Autonomous Database Serverless instances, the following cloning options are available:
- Use
BACKUP_FROM_ID
for creating a new Autonomous Database by cloning from a specified backup. Also provide the backup OCID in theautonomous_database_backup_id
parameter. - Use
BACKUP_FROM_TIMESTAMP
for creating a point-in-time Autonomous Database clone using backups. Also provide the backup timestamp in thetimestamp
parameter. For more information, see Cloning and Moving an Autonomous Database.
- Use
- source
Id String - The OCID of the source Autonomous Database that will be used to create a new standby database for the Data Guard association.
- standby
Whitelisted List<String>Ips (Updatable) The client IP access control list (ACL). This feature is available for [Autonomous Database Serverless] (https://docs.oracle.com/en/cloud/paas/autonomous-database/index.html) and on Exadata Cloud@Customer. Only clients connecting from an IP address included in the ACL may access the Autonomous Database instance. If
arePrimaryWhitelistedIpsUsed
is 'TRUE' then Autonomous Database uses this primary's IP access control list (ACL) for the disaster recovery peer calledstandbywhitelistedips
.For Autonomous Database Serverless instances, this is an array of CIDR (Classless Inter-Domain Routing) notations for a subnet or VCN OCID. Use a semicolon (;) as a deliminator between the VCN-specific subnets or IPs. Example:
["1.1.1.1","1.1.1.0/24","ocid1.vcn.oc1.sea.<unique_id>","ocid1.vcn.oc1.sea.<unique_id1>;1.1.1.1","ocid1.vcn.oc1.sea.<unique_id2>;1.1.0.0/16"]
For Exadata Cloud@Customer, this is an array of IP addresses or CIDR (Classless Inter-Domain Routing) notations. Example:["1.1.1.1","1.1.1.0/24","1.1.2.25"]
For an update operation, if you want to delete all the IPs in the ACL, use an array with a single empty string entry.
If
arePrimaryWhitelistedIpsUsed
is 'TRUE' then Autonomous Database useswhitelisted_ips
primary's IP access control list (ACL) asstandbywhitelistedips
for the disaster recovery peer.This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, isMTLSConnectionRequired, openMode, permissionLevel, dbWorkload, dbVersion, isRefreshable, dbName, scheduledOperations, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier.
- state String
- The current state of the Autonomous Database.
- subnet
Id String (Updatable) The OCID of the subnet the resource is associated with. This the only parameter to configure private endpoint, VCN details are obtained from the
subnet_id
.Subnet Restrictions:
- For bare metal DB systems and for single node virtual machine DB systems, do not use a subnet that overlaps with 192.168.16.16/28.
- For Exadata and virtual machine 2-node RAC systems, do not use a subnet that overlaps with 192.168.128.0/20.
- For Autonomous Database, setting this will disable public secure access to the database.
- subscription
Id String - The OCID of the subscription with which resource needs to be associated with. These subnets are used by the Oracle Clusterware private interconnect on the database instance. Specifying an overlapping subnet will cause the private interconnect to malfunction. This restriction applies to both the client subnet and the backup subnet.
- switchover
To String - It is applicable only when
is_local_data_guard_enabled
is true. Could be set toPRIMARY
orSTANDBY
. Default value isPRIMARY
. - switchover
To StringRemote Peer Id - (Updatable) It is applicable only when
dataguard_region_type
androle
are set, andis_dedicated
is false. For Autonomous Database Serverless instances, Data Guard associations have designated primary and standby regions, and these region types do not change when the database changes roles. It takes the OCID of the remote peer to switchover to and the API is called from the remote region. - time
Of StringAuto Refresh Start - The the date and time that auto-refreshing will begin for an Autonomous Database refreshable clone. This value controls only the start time for the first refresh operation. Subsequent (ongoing) refresh operations have start times controlled by the value of the
autoRefreshFrequencyInSeconds
parameter. - timestamp String
- The timestamp specified for the point-in-time clone of the source Autonomous Database. The timestamp must be in the past.
- use
Latest BooleanAvailable Backup Time Stamp - Clone from latest available backup timestamp.
- vault
Id String - The OCID of the Oracle Cloud Infrastructure vault.
- whitelisted
Ips List<String> (Updatable) The client IP access control list (ACL). This feature is available for autonomous databases on shared Exadata infrastructure and on Exadata Cloud@Customer. Only clients connecting from an IP address included in the ACL may access the Autonomous Database instance.
For Autonomous Database Serverless instances, this is an array of CIDR (Classless Inter-Domain Routing) notations for a subnet or VCN OCID. Use a semicolon (;) as a deliminator between the VCN-specific subnets or IPs. Example:
["1.1.1.1","1.1.1.0/24","ocid1.vcn.oc1.sea.<unique_id>","ocid1.vcn.oc1.sea.<unique_id1>;1.1.1.1","ocid1.vcn.oc1.sea.<unique_id2>;1.1.0.0/16"]
For Exadata Cloud@Customer, this is an array of IP addresses or CIDR (Classless Inter-Domain Routing) notations. Example:["1.1.1.1","1.1.1.0/24","1.1.2.25"]
For an update operation, if you want to delete all the IPs in the ACL, use an array with a single empty string entry.
This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, isMTLSConnectionRequired, openMode, permissionLevel, dbWorkload, dbVersion, isRefreshable, dbName, scheduledOperations, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier. To remove all whitelisted IPs, set the field to a list with an empty string
[""]
.
- compartment
Id string - (Updatable) The OCID of the compartment of the Autonomous Database.
- db
Name string - The database name. The name must begin with an alphabetic character and can contain a maximum of 14 alphanumeric characters. Special characters are not permitted. The database name must be unique in the tenancy. It is required in all cases except when creating a cross-region Autonomous Data Guard standby instance or a cross-region disaster recovery standby instance.
- admin
Password string - (Updatable) The password must be between 12 and 30 characters long, and must contain at least 1 uppercase, 1 lowercase, and 1 numeric character. It cannot contain the double quote symbol (") or the username "admin", regardless of casing. The password is mandatory if source value is "BACKUP_FROM_ID", "BACKUP_FROM_TIMESTAMP", "DATABASE" or "NONE".
- are
Primary booleanWhitelisted Ips Used - (Updatable) This field will be null if the Autonomous Database is not Data Guard enabled or Access Control is disabled. It's value would be
TRUE
if Autonomous Database is Data Guard enabled and Access Control is enabled and if the Autonomous Database uses primary IP access control list (ACL) for standby. It's value would beFALSE
if Autonomous Database is Data Guard enabled and Access Control is enabled and if the Autonomous Database uses different IP access control list (ACL) for standby compared to primary. - auto
Refresh numberFrequency In Seconds - (Updatable) The frequency a refreshable clone is refreshed after auto-refresh is enabled. The minimum is 1 hour. The maximum is 7 days. The date and time that auto-refresh is enabled is controlled by the
timeOfAutoRefreshStart
parameter. - auto
Refresh numberPoint Lag In Seconds - (Updatable) The time, in seconds, the data of the refreshable clone lags the primary database at the point of refresh. The minimum is 0 minutes (0 mins means refresh to the latest available timestamp). The maximum is 7 days. The lag time increases after refreshing until the next data refresh happens.
- autonomous
Container stringDatabase Id - The Autonomous Container Database OCID.
- autonomous
Database stringBackup Id - The OCID of the source Autonomous Database Backup that you will clone to create a new Autonomous Database.
- autonomous
Database stringId - The OCID of the source Autonomous Database that you will clone to create a new Autonomous Database.
- autonomous
Maintenance stringSchedule Type - The maintenance schedule type of the Autonomous Database Serverless instances. The EARLY maintenance schedule of this Autonomous Database follows a schedule that applies patches prior to the REGULAR schedule.The REGULAR maintenance schedule of this Autonomous Database follows the normal cycle.
- backup
Retention numberPeriod In Days - (Updatable) Retention period, in days, for backups.
- byol
Compute numberCount Limit - character
Set string The character set for the autonomous database. The default is AL32UTF8. Allowed values for an Autonomous Database on Serverless infrastructure as returned by List Autonomous Database Character Sets
For an Autonomous Database on dedicated infrastructure, the allowed values are:
AL32UTF8, AR8ADOS710, AR8ADOS720, AR8APTEC715, AR8ARABICMACS, AR8ASMO8X, AR8ISO8859P6, AR8MSWIN1256, AR8MUSSAD768, AR8NAFITHA711, AR8NAFITHA721, AR8SAKHR706, AR8SAKHR707, AZ8ISO8859P9E, BG8MSWIN, BG8PC437S, BLT8CP921, BLT8ISO8859P13, BLT8MSWIN1257, BLT8PC775, BN8BSCII, CDN8PC863, CEL8ISO8859P14, CL8ISO8859P5, CL8ISOIR111, CL8KOI8R, CL8KOI8U, CL8MACCYRILLICS, CL8MSWIN1251, EE8ISO8859P2, EE8MACCES, EE8MACCROATIANS, EE8MSWIN1250, EE8PC852, EL8DEC, EL8ISO8859P7, EL8MACGREEKS, EL8MSWIN1253, EL8PC437S, EL8PC851, EL8PC869, ET8MSWIN923, HU8ABMOD, HU8CWI2, IN8ISCII, IS8PC861, IW8ISO8859P8, IW8MACHEBREWS, IW8MSWIN1255, IW8PC1507, JA16EUC, JA16EUCTILDE, JA16SJIS, JA16SJISTILDE, JA16VMS, KO16KSC5601, KO16KSCCS, KO16MSWIN949, LA8ISO6937, LA8PASSPORT, LT8MSWIN921, LT8PC772, LT8PC774, LV8PC1117, LV8PC8LR, LV8RST104090, N8PC865, NE8ISO8859P10, NEE8ISO8859P4, RU8BESTA, RU8PC855, RU8PC866, SE8ISO8859P3, TH8MACTHAIS, TH8TISASCII, TR8DEC, TR8MACTURKISHS, TR8MSWIN1254, TR8PC857, US7ASCII, US8PC437, UTF8, VN8MSWIN1258, VN8VN3, WE8DEC, WE8DG, WE8ISO8859P1, WE8ISO8859P15, WE8ISO8859P9, WE8MACROMAN8S, WE8MSWIN1252, WE8NCR4970, WE8NEXTSTEP, WE8PC850, WE8PC858, WE8PC860, WE8ROMAN8, ZHS16CGB231280, ZHS16GBK, ZHT16BIG5, ZHT16CCDC, ZHT16DBT, ZHT16HKSCS, ZHT16MSWIN950, ZHT32EUC, ZHT32SOPS, ZHT32TRIS
- clone
Type string - The Autonomous Database clone type. This parameter is not used to create a refreshable clone type, and for refreshable clones one must use the (source=CLONE_TO_REFRESHABLE) parameter.
FULL
- This option creates a new database that includes all source database data.METADATA
- This option creates a new database that includes the source database schema and select metadata, but not the source database data.
- compute
Count number - (Updatable) The compute amount available to the database. Minimum and maximum values depend on the compute model and whether the database is an Autonomous Database Serverless instance or an Autonomous Database on Dedicated Exadata Infrastructure. For an Autonomous Database Serverless instance, the 'ECPU' compute model requires a minimum value of one, for databases in the elastic resource pool and minimum value of two, otherwise. Required when using the
computeModel
parameter. When usingcpuCoreCount
parameter, it is an error to specify computeCount to a non-null value. ProvidingcomputeModel
andcomputeCount
is the preferred method for both OCPU and ECPU. - compute
Model string - (Updatable) The compute model of the Autonomous Database. This is required if using the
computeCount
parameter. If usingcpuCoreCount
then it is an error to specifycomputeModel
to a non-null value. ECPU compute model is the recommended model and OCPU compute model is legacy. - cpu
Core numberCount - (Updatable) The number of CPU cores to be made available to the database. For Autonomous Databases on dedicated Exadata infrastructure, the maximum number of cores is determined by the infrastructure shape. See Characteristics of Infrastructure Shapes for shape details.
Note: This parameter cannot be used with the
ocpuCount
parameter. This input is ignored for Always Free resources.- The data type must be an integer.
- The minimum number of cores for all types of autonomous database is 1
- The maximum number of cores is as follows:
- Autonomous Database Serverless instances: The maximum number of cores is 128.
- Autonomous Databases on dedicated Exadata infrastructure: The maximum number of cores is determined by the infrastructure shape. See Characteristics of Infrastructure Shapes for shape details.
- Providing
computeModel
andcomputeCount
is the preferred method for setting CPUs for both OCPU and ECPU.
- customer
Contacts AutonomousDatabase Customer Contact[] - (Updatable) Customer Contacts.
- data
Safe stringStatus - (Updatable) Status of the Data Safe registration for this Autonomous Database. Could be REGISTERED or NOT_REGISTERED.
- data
Storage numberSize In Gb (Updatable) The size, in gigabytes, of the data volume that will be created and attached to the database. This storage can later be scaled up if needed. The maximum storage value is determined by the infrastructure shape. See Characteristics of Infrastructure Shapes for shape details.
Notes
- This parameter is only supported for dedicated Exadata infrastructure.
- This parameter cannot be used with the
dataStorageSizeInTBs
parameter.
- data
Storage numberSize In Tbs (Updatable) The size, in terabytes, of the data volume that will be created and attached to the database. This storage can later be scaled up if needed. For Autonomous Databases on dedicated Exadata infrastructure, the maximum storage value is determined by the infrastructure shape. See Characteristics of Infrastructure Shapes for shape details. A full Exadata service is allocated when the Autonomous Database size is set to the upper limit (384 TB).
Note: This parameter cannot be used with the
dataStorageSizeInGBs
parameter. This input is ignored for Always Free resources.- database
Edition string - (Updatable) The Oracle Database Edition that applies to the Autonomous databases. It can be set to
ENTERPRISE_EDITION
orSTANDARD_EDITION
. - database
Management stringStatus - Status of Database Management for this Autonomous Database.
- db
Tools AutonomousDetails Database Db Tools Detail[] (Updatable) The list of database tools details.
This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, whitelistedIps, isMTLSConnectionRequired, openMode, permissionLevel, dbWorkload, privateEndpointLabel, nsgIds, dbVersion, isRefreshable, dbName, scheduledOperations, isLocalDataGuardEnabled, or isFreeTier.
- db
Version string - (Updatable) A valid Oracle Database version for Autonomous Database.
db_workload
AJD and APEX are only supported fordb_version
19c
and above. - db
Workload string (Updatable) The Autonomous Database workload type. The following values are valid:
- OLTP - indicates an Autonomous Transaction Processing database
- DW - indicates an Autonomous Data Warehouse database
- AJD - indicates an Autonomous JSON Database
- APEX - indicates an Autonomous Database with the Oracle APEX Application Development workload type.
This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, isMTLSConnectionRequired, privateEndpointLabel, nsgIds, dbVersion, isRefreshable, dbName, scheduledOperations, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier. *Note:
db_workload
can only be updated from AJD to OLTP or from a free OLTP to AJD.- {[key: string]: string}
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- disaster
Recovery stringType - Indicates the disaster recovery (DR) type of the standby Autonomous Database Serverless instance. Autonomous Data Guard (ADG) DR type provides business critical DR with a faster recovery time objective (RTO) during failover or switchover. Backup-based DR type provides lower cost DR with a slower RTO during failover or switchover.
- display
Name string - (Updatable) The user-friendly name for the Autonomous Database. The name does not have to be unique.
- encryption
Key AutonomousDatabase Encryption Key - (Updatable) Details of the Autonomous Database encryption key.
- {[key: string]: string}
- (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example:
{"Department": "Finance"}
- in
Memory numberPercentage - (Updatable) The percentage of the System Global Area(SGA) assigned to In-Memory tables in Autonomous Database. This property is applicable only to Autonomous Databases on the Exadata Cloud@Customer platform.
- is
Access booleanControl Enabled (Updatable) Indicates if the database-level access control is enabled. If disabled, database access is defined by the network security rules. If enabled, database access is restricted to the IP addresses defined by the rules specified with the
whitelistedIps
property. While specifyingwhitelistedIps
rules is optional, if database-level access control is enabled and no rules are specified, the database will become inaccessible. The rules can be added later using theUpdateAutonomousDatabase
API operation or edit option in console. When creating a database clone, the desired access control setting should be specified. By default, database-level access control will be disabled for the clone.This property is applicable only to Autonomous Databases on the Exadata Cloud@Customer platform. For Autonomous Database Serverless instances,
whitelistedIps
is used.- is
Auto booleanScaling Enabled - (Updatable) Indicates if auto scaling is enabled for the Autonomous Database CPU core count. The default value is
TRUE
. - is
Auto booleanScaling For Storage Enabled - (Updatable) Indicates if auto scaling is enabled for the Autonomous Database storage. The default value is
FALSE
. - is
Data booleanGuard Enabled - (Updatable) Deprecated. Indicates whether the Autonomous Database has local (in-region) Data Guard enabled. Not applicable to cross-region Autonomous Data Guard associations, or to Autonomous Databases using dedicated Exadata infrastructure or Exadata Cloud@Customer infrastructure.
- is
Dedicated boolean - True if the database is on dedicated Exadata infrastructure.
- is
Dev booleanTier - (Updatable) Autonomous Database for Developers are free Autonomous Databases that developers can use to build and test new applications.With Autonomous these database instancess instances, you can try new Autonomous Database features for free and apply them to ongoing or new development projects. Developer database comes with limited resources and is, therefore, not suitable for large-scale testing and production deployments. When you need more compute or storage resources, you can transition to a paid database licensing by cloning your developer database into a regular Autonomous Database. See Autonomous Database documentation for more details.
- is
Free booleanTier - (Updatable) Indicates if this is an Always Free resource. The default value is false. Note that Always Free Autonomous Databases have 1 CPU and 20GB of memory. For Always Free databases, memory and CPU cannot be scaled. When
db_workload
isAJD
orAPEX
it cannot betrue
. - is
Local booleanData Guard Enabled - (Updatable) Indicates whether the Autonomous Database has local (in-region) Data Guard enabled. It takes boolean values. Not applicable to cross-region Autonomous Data Guard associations, or to Autonomous Databases using dedicated Exadata infrastructure or Exadata Cloud@Customer infrastructure.
- is
Mtls booleanConnection Required - (Updatable) Indicates whether the Autonomous Database requires mTLS connections.
- is
Preview booleanVersion With Service Terms Accepted - If set to
TRUE
, indicates that an Autonomous Database preview version is being provisioned, and that the preview version's terms of service have been accepted. Note that preview version software is only available for databases on Autonomous Database Serverless. - is
Refreshable booleanClone - (Updatable) True for creating a refreshable clone and False for detaching the clone from source Autonomous Database. Detaching is one time operation and clone becomes a regular Autonomous Database.
- is
Replicate booleanAutomatic Backups - If true, 7 days worth of backups are replicated across regions for Cross-Region ADB or Backup-Based DR between Primary and Standby. If false, the backups taken on the Primary are not replicated to the Standby database.
- is
Shrink booleanOnly (Updatable) An optional property when enabled triggers the Shrinking of Autonomous Database once. To trigger Shrinking of ADB once again, this flag needs to be disabled and re-enabled again. It should not be passed during create database operation. It is only applicable on Serverless databases i.e. where
is_dedicated
is false.** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- key
Version stringId - The OCID of the key version that is used in rotate key operations.
- kms
Key stringId - The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
- license
Model string - (Updatable) The Oracle license model that applies to the Oracle Autonomous Database. Bring your own license (BYOL) allows you to apply your current on-premises Oracle software licenses to equivalent, highly automated Oracle PaaS and IaaS services in the cloud. License Included allows you to subscribe to new Oracle Database software licenses and the Database service. Note that when provisioning an Autonomous Database on dedicated Exadata infrastructure, this attribute must be null because the attribute is already set at the Autonomous Exadata Infrastructure level. When using shared Exadata infrastructure, if a value is not specified, the system will supply the value of
BRING_YOUR_OWN_LICENSE
. It is a required field whendb_workload
is AJD and needs to be set toLICENSE_INCLUDED
as AJD does not support defaultlicense_model
valueBRING_YOUR_OWN_LICENSE
. - local
Adg numberAuto Failover Max Data Loss Limit - Parameter that allows users to select an acceptable maximum data loss limit in seconds, up to which Automatic Failover will be triggered when necessary for a Local Autonomous Data Guard
- long
Term AutonomousBackup Schedules Database Long Term Backup Schedule[] - Details for the long-term backup schedule.
- max
Cpu numberCore Count - (Updatable) Deprecated. The number of Max OCPU cores to be made available to the autonomous database with auto scaling of cpu enabled.
- ncharacter
Set string - The national character set for the autonomous database. The default is AL16UTF16. Allowed values are: AL16UTF16 or UTF8.
- nsg
Ids string[] - (Updatable) The list of OCIDs for the network security groups (NSGs) to which this resource belongs. Setting this to an empty list removes all resources from all NSGs. For more information about NSGs, see Security Rules. NsgIds restrictions:
- A network security group (NSG) is optional for Autonomous Databases with private access. The nsgIds list can be empty.
- ocpu
Count number (Updatable) The number of OCPU cores to be made available to the database.
- Providing
computeModel
andcomputeCount
is the preferred method for setting CPUs for both OCPU and ECPU. The following points apply: - For Autonomous Databases on dedicated Exadata infrastructure, to provision less than 1 core, enter a fractional value in an increment of 0.1. For example, you can provision 0.3 or 0.4 cores, but not 0.35 cores. (Note that fractional OCPU values are not supported for Autonomous Databasese on shared Exadata infrastructure.)
- To provision 1 or more cores, you must enter an integer between 1 and the maximum number of cores available for the infrastructure shape. For example, you can provision 2 cores or 3 cores, but not 2.5 cores. This applies to Autonomous Databases on both shared and dedicated Exadata infrastructure.
For Autonomous Databases on dedicated Exadata infrastructure, the maximum number of cores is determined by the infrastructure shape. See Characteristics of Infrastructure Shapes for shape details.
Note: This parameter cannot be used with the
cpuCoreCount
parameter.- Providing
- open
Mode string - Indicates the Autonomous Database mode. The database can be opened in
READ_ONLY
orREAD_WRITE
mode. - operations
Insights stringStatus - (Updatable) Status of Operations Insights for this Autonomous Database. Values supported are
ENABLED
andNOT_ENABLED
- permission
Level string - The Autonomous Database permission level. Restricted mode allows access only by admin users.
- private
Endpoint stringIp - The private endpoint Ip address for the resource.
- private
Endpoint stringLabel - (Updatable) (Optional) (Updatable) The resource's private endpoint label.
- Setting the endpoint label to a non-empty string creates a private endpoint database.
- Resetting the endpoint label to an empty string, after the creation of the private endpoint database, changes the private endpoint database to a public endpoint database.
- Setting the endpoint label to a non-empty string value, updates to a new private endpoint database, when the database is disabled and re-enabled.
- refreshable
Mode string - (Updatable) The refresh mode of the clone. AUTOMATIC indicates that the clone is automatically being refreshed with data from the source Autonomous Database.
- remote
Disaster stringRecovery Type - Indicates the cross-region disaster recovery (DR) type of the standby Autonomous Database Serverless instance. Autonomous Data Guard (ADG) DR type provides business critical DR with a faster recovery time objective (RTO) during failover or switchover. Backup-based DR type provides lower cost DR with a slower RTO during failover or switchover.
- resource
Pool stringLeader Id - (Updatable) The unique identifier for leader autonomous database OCID OCID.
- resource
Pool AutonomousSummary Database Resource Pool Summary - (Updatable) The configuration details for resource pool
- rotate
Key booleanTrigger - (Updatable) An optional property when flipped triggers rotation of KMS key. It is only applicable on dedicated databases i.e. where
is_dedicated
is true. - scheduled
Operations AutonomousDatabase Scheduled Operation[] (Updatable) The list of scheduled operations. Consists of values such as dayOfWeek, scheduledStartTime, scheduledStopTime.
This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, whitelistedIps, isMTLSConnectionRequired, openMode, permissionLevel, dbWorkload, privateEndpointLabel, nsgIds, dbVersion, isRefreshable, dbName, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier.
- secret
Id string (Updatable) The Oracle Cloud Infrastructure vault secret [/Content/General/Concepts/identifiers.htm]OCID.
This cannot be used in conjunction with adminPassword.
- secret
Version numberNumber - (Updatable) The version of the vault secret. If no version is specified, the latest version will be used.
- security
Attributes {[key: string]: string} - (Updatable) Security Attributes for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "audit"}}}
- shrink
Adb numberTrigger - source string
The source of the database:
- Use
NONE
for creating a new Autonomous Database. - Use
DATABASE
for creating a new Autonomous Database by cloning an existing running Autonomous Database from the latest timestamp, also provide the source database OCID in thesource_id
parameter. - Use
CROSS_REGION_DATAGUARD
to create a standby Data Guard database in another region, also provide the remote primary database OCID in thesource_id
parameter. - Use
CLONE_TO_REFRESHABLE
for creating a refreshable clone.
For Autonomous Database Serverless instances, the following cloning options are available:
- Use
BACKUP_FROM_ID
for creating a new Autonomous Database by cloning from a specified backup. Also provide the backup OCID in theautonomous_database_backup_id
parameter. - Use
BACKUP_FROM_TIMESTAMP
for creating a point-in-time Autonomous Database clone using backups. Also provide the backup timestamp in thetimestamp
parameter. For more information, see Cloning and Moving an Autonomous Database.
- Use
- source
Id string - The OCID of the source Autonomous Database that will be used to create a new standby database for the Data Guard association.
- standby
Whitelisted string[]Ips (Updatable) The client IP access control list (ACL). This feature is available for [Autonomous Database Serverless] (https://docs.oracle.com/en/cloud/paas/autonomous-database/index.html) and on Exadata Cloud@Customer. Only clients connecting from an IP address included in the ACL may access the Autonomous Database instance. If
arePrimaryWhitelistedIpsUsed
is 'TRUE' then Autonomous Database uses this primary's IP access control list (ACL) for the disaster recovery peer calledstandbywhitelistedips
.For Autonomous Database Serverless instances, this is an array of CIDR (Classless Inter-Domain Routing) notations for a subnet or VCN OCID. Use a semicolon (;) as a deliminator between the VCN-specific subnets or IPs. Example:
["1.1.1.1","1.1.1.0/24","ocid1.vcn.oc1.sea.<unique_id>","ocid1.vcn.oc1.sea.<unique_id1>;1.1.1.1","ocid1.vcn.oc1.sea.<unique_id2>;1.1.0.0/16"]
For Exadata Cloud@Customer, this is an array of IP addresses or CIDR (Classless Inter-Domain Routing) notations. Example:["1.1.1.1","1.1.1.0/24","1.1.2.25"]
For an update operation, if you want to delete all the IPs in the ACL, use an array with a single empty string entry.
If
arePrimaryWhitelistedIpsUsed
is 'TRUE' then Autonomous Database useswhitelisted_ips
primary's IP access control list (ACL) asstandbywhitelistedips
for the disaster recovery peer.This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, isMTLSConnectionRequired, openMode, permissionLevel, dbWorkload, dbVersion, isRefreshable, dbName, scheduledOperations, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier.
- state string
- The current state of the Autonomous Database.
- subnet
Id string (Updatable) The OCID of the subnet the resource is associated with. This the only parameter to configure private endpoint, VCN details are obtained from the
subnet_id
.Subnet Restrictions:
- For bare metal DB systems and for single node virtual machine DB systems, do not use a subnet that overlaps with 192.168.16.16/28.
- For Exadata and virtual machine 2-node RAC systems, do not use a subnet that overlaps with 192.168.128.0/20.
- For Autonomous Database, setting this will disable public secure access to the database.
- subscription
Id string - The OCID of the subscription with which resource needs to be associated with. These subnets are used by the Oracle Clusterware private interconnect on the database instance. Specifying an overlapping subnet will cause the private interconnect to malfunction. This restriction applies to both the client subnet and the backup subnet.
- switchover
To string - It is applicable only when
is_local_data_guard_enabled
is true. Could be set toPRIMARY
orSTANDBY
. Default value isPRIMARY
. - switchover
To stringRemote Peer Id - (Updatable) It is applicable only when
dataguard_region_type
androle
are set, andis_dedicated
is false. For Autonomous Database Serverless instances, Data Guard associations have designated primary and standby regions, and these region types do not change when the database changes roles. It takes the OCID of the remote peer to switchover to and the API is called from the remote region. - time
Of stringAuto Refresh Start - The the date and time that auto-refreshing will begin for an Autonomous Database refreshable clone. This value controls only the start time for the first refresh operation. Subsequent (ongoing) refresh operations have start times controlled by the value of the
autoRefreshFrequencyInSeconds
parameter. - timestamp string
- The timestamp specified for the point-in-time clone of the source Autonomous Database. The timestamp must be in the past.
- use
Latest booleanAvailable Backup Time Stamp - Clone from latest available backup timestamp.
- vault
Id string - The OCID of the Oracle Cloud Infrastructure vault.
- whitelisted
Ips string[] (Updatable) The client IP access control list (ACL). This feature is available for autonomous databases on shared Exadata infrastructure and on Exadata Cloud@Customer. Only clients connecting from an IP address included in the ACL may access the Autonomous Database instance.
For Autonomous Database Serverless instances, this is an array of CIDR (Classless Inter-Domain Routing) notations for a subnet or VCN OCID. Use a semicolon (;) as a deliminator between the VCN-specific subnets or IPs. Example:
["1.1.1.1","1.1.1.0/24","ocid1.vcn.oc1.sea.<unique_id>","ocid1.vcn.oc1.sea.<unique_id1>;1.1.1.1","ocid1.vcn.oc1.sea.<unique_id2>;1.1.0.0/16"]
For Exadata Cloud@Customer, this is an array of IP addresses or CIDR (Classless Inter-Domain Routing) notations. Example:["1.1.1.1","1.1.1.0/24","1.1.2.25"]
For an update operation, if you want to delete all the IPs in the ACL, use an array with a single empty string entry.
This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, isMTLSConnectionRequired, openMode, permissionLevel, dbWorkload, dbVersion, isRefreshable, dbName, scheduledOperations, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier. To remove all whitelisted IPs, set the field to a list with an empty string
[""]
.
- compartment_
id str - (Updatable) The OCID of the compartment of the Autonomous Database.
- db_
name str - The database name. The name must begin with an alphabetic character and can contain a maximum of 14 alphanumeric characters. Special characters are not permitted. The database name must be unique in the tenancy. It is required in all cases except when creating a cross-region Autonomous Data Guard standby instance or a cross-region disaster recovery standby instance.
- admin_
password str - (Updatable) The password must be between 12 and 30 characters long, and must contain at least 1 uppercase, 1 lowercase, and 1 numeric character. It cannot contain the double quote symbol (") or the username "admin", regardless of casing. The password is mandatory if source value is "BACKUP_FROM_ID", "BACKUP_FROM_TIMESTAMP", "DATABASE" or "NONE".
- are_
primary_ boolwhitelisted_ ips_ used - (Updatable) This field will be null if the Autonomous Database is not Data Guard enabled or Access Control is disabled. It's value would be
TRUE
if Autonomous Database is Data Guard enabled and Access Control is enabled and if the Autonomous Database uses primary IP access control list (ACL) for standby. It's value would beFALSE
if Autonomous Database is Data Guard enabled and Access Control is enabled and if the Autonomous Database uses different IP access control list (ACL) for standby compared to primary. - auto_
refresh_ intfrequency_ in_ seconds - (Updatable) The frequency a refreshable clone is refreshed after auto-refresh is enabled. The minimum is 1 hour. The maximum is 7 days. The date and time that auto-refresh is enabled is controlled by the
timeOfAutoRefreshStart
parameter. - auto_
refresh_ intpoint_ lag_ in_ seconds - (Updatable) The time, in seconds, the data of the refreshable clone lags the primary database at the point of refresh. The minimum is 0 minutes (0 mins means refresh to the latest available timestamp). The maximum is 7 days. The lag time increases after refreshing until the next data refresh happens.
- autonomous_
container_ strdatabase_ id - The Autonomous Container Database OCID.
- autonomous_
database_ strbackup_ id - The OCID of the source Autonomous Database Backup that you will clone to create a new Autonomous Database.
- autonomous_
database_ strid - The OCID of the source Autonomous Database that you will clone to create a new Autonomous Database.
- autonomous_
maintenance_ strschedule_ type - The maintenance schedule type of the Autonomous Database Serverless instances. The EARLY maintenance schedule of this Autonomous Database follows a schedule that applies patches prior to the REGULAR schedule.The REGULAR maintenance schedule of this Autonomous Database follows the normal cycle.
- backup_
retention_ intperiod_ in_ days - (Updatable) Retention period, in days, for backups.
- byol_
compute_ floatcount_ limit - character_
set str The character set for the autonomous database. The default is AL32UTF8. Allowed values for an Autonomous Database on Serverless infrastructure as returned by List Autonomous Database Character Sets
For an Autonomous Database on dedicated infrastructure, the allowed values are:
AL32UTF8, AR8ADOS710, AR8ADOS720, AR8APTEC715, AR8ARABICMACS, AR8ASMO8X, AR8ISO8859P6, AR8MSWIN1256, AR8MUSSAD768, AR8NAFITHA711, AR8NAFITHA721, AR8SAKHR706, AR8SAKHR707, AZ8ISO8859P9E, BG8MSWIN, BG8PC437S, BLT8CP921, BLT8ISO8859P13, BLT8MSWIN1257, BLT8PC775, BN8BSCII, CDN8PC863, CEL8ISO8859P14, CL8ISO8859P5, CL8ISOIR111, CL8KOI8R, CL8KOI8U, CL8MACCYRILLICS, CL8MSWIN1251, EE8ISO8859P2, EE8MACCES, EE8MACCROATIANS, EE8MSWIN1250, EE8PC852, EL8DEC, EL8ISO8859P7, EL8MACGREEKS, EL8MSWIN1253, EL8PC437S, EL8PC851, EL8PC869, ET8MSWIN923, HU8ABMOD, HU8CWI2, IN8ISCII, IS8PC861, IW8ISO8859P8, IW8MACHEBREWS, IW8MSWIN1255, IW8PC1507, JA16EUC, JA16EUCTILDE, JA16SJIS, JA16SJISTILDE, JA16VMS, KO16KSC5601, KO16KSCCS, KO16MSWIN949, LA8ISO6937, LA8PASSPORT, LT8MSWIN921, LT8PC772, LT8PC774, LV8PC1117, LV8PC8LR, LV8RST104090, N8PC865, NE8ISO8859P10, NEE8ISO8859P4, RU8BESTA, RU8PC855, RU8PC866, SE8ISO8859P3, TH8MACTHAIS, TH8TISASCII, TR8DEC, TR8MACTURKISHS, TR8MSWIN1254, TR8PC857, US7ASCII, US8PC437, UTF8, VN8MSWIN1258, VN8VN3, WE8DEC, WE8DG, WE8ISO8859P1, WE8ISO8859P15, WE8ISO8859P9, WE8MACROMAN8S, WE8MSWIN1252, WE8NCR4970, WE8NEXTSTEP, WE8PC850, WE8PC858, WE8PC860, WE8ROMAN8, ZHS16CGB231280, ZHS16GBK, ZHT16BIG5, ZHT16CCDC, ZHT16DBT, ZHT16HKSCS, ZHT16MSWIN950, ZHT32EUC, ZHT32SOPS, ZHT32TRIS
- clone_
type str - The Autonomous Database clone type. This parameter is not used to create a refreshable clone type, and for refreshable clones one must use the (source=CLONE_TO_REFRESHABLE) parameter.
FULL
- This option creates a new database that includes all source database data.METADATA
- This option creates a new database that includes the source database schema and select metadata, but not the source database data.
- compute_
count float - (Updatable) The compute amount available to the database. Minimum and maximum values depend on the compute model and whether the database is an Autonomous Database Serverless instance or an Autonomous Database on Dedicated Exadata Infrastructure. For an Autonomous Database Serverless instance, the 'ECPU' compute model requires a minimum value of one, for databases in the elastic resource pool and minimum value of two, otherwise. Required when using the
computeModel
parameter. When usingcpuCoreCount
parameter, it is an error to specify computeCount to a non-null value. ProvidingcomputeModel
andcomputeCount
is the preferred method for both OCPU and ECPU. - compute_
model str - (Updatable) The compute model of the Autonomous Database. This is required if using the
computeCount
parameter. If usingcpuCoreCount
then it is an error to specifycomputeModel
to a non-null value. ECPU compute model is the recommended model and OCPU compute model is legacy. - cpu_
core_ intcount - (Updatable) The number of CPU cores to be made available to the database. For Autonomous Databases on dedicated Exadata infrastructure, the maximum number of cores is determined by the infrastructure shape. See Characteristics of Infrastructure Shapes for shape details.
Note: This parameter cannot be used with the
ocpuCount
parameter. This input is ignored for Always Free resources.- The data type must be an integer.
- The minimum number of cores for all types of autonomous database is 1
- The maximum number of cores is as follows:
- Autonomous Database Serverless instances: The maximum number of cores is 128.
- Autonomous Databases on dedicated Exadata infrastructure: The maximum number of cores is determined by the infrastructure shape. See Characteristics of Infrastructure Shapes for shape details.
- Providing
computeModel
andcomputeCount
is the preferred method for setting CPUs for both OCPU and ECPU.
- customer_
contacts Sequence[database.Autonomous Database Customer Contact Args] - (Updatable) Customer Contacts.
- data_
safe_ strstatus - (Updatable) Status of the Data Safe registration for this Autonomous Database. Could be REGISTERED or NOT_REGISTERED.
- data_
storage_ intsize_ in_ gb (Updatable) The size, in gigabytes, of the data volume that will be created and attached to the database. This storage can later be scaled up if needed. The maximum storage value is determined by the infrastructure shape. See Characteristics of Infrastructure Shapes for shape details.
Notes
- This parameter is only supported for dedicated Exadata infrastructure.
- This parameter cannot be used with the
dataStorageSizeInTBs
parameter.
- data_
storage_ intsize_ in_ tbs (Updatable) The size, in terabytes, of the data volume that will be created and attached to the database. This storage can later be scaled up if needed. For Autonomous Databases on dedicated Exadata infrastructure, the maximum storage value is determined by the infrastructure shape. See Characteristics of Infrastructure Shapes for shape details. A full Exadata service is allocated when the Autonomous Database size is set to the upper limit (384 TB).
Note: This parameter cannot be used with the
dataStorageSizeInGBs
parameter. This input is ignored for Always Free resources.- database_
edition str - (Updatable) The Oracle Database Edition that applies to the Autonomous databases. It can be set to
ENTERPRISE_EDITION
orSTANDARD_EDITION
. - database_
management_ strstatus - Status of Database Management for this Autonomous Database.
- db_
tools_ Sequence[database.details Autonomous Database Db Tools Detail Args] (Updatable) The list of database tools details.
This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, whitelistedIps, isMTLSConnectionRequired, openMode, permissionLevel, dbWorkload, privateEndpointLabel, nsgIds, dbVersion, isRefreshable, dbName, scheduledOperations, isLocalDataGuardEnabled, or isFreeTier.
- db_
version str - (Updatable) A valid Oracle Database version for Autonomous Database.
db_workload
AJD and APEX are only supported fordb_version
19c
and above. - db_
workload str (Updatable) The Autonomous Database workload type. The following values are valid:
- OLTP - indicates an Autonomous Transaction Processing database
- DW - indicates an Autonomous Data Warehouse database
- AJD - indicates an Autonomous JSON Database
- APEX - indicates an Autonomous Database with the Oracle APEX Application Development workload type.
This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, isMTLSConnectionRequired, privateEndpointLabel, nsgIds, dbVersion, isRefreshable, dbName, scheduledOperations, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier. *Note:
db_workload
can only be updated from AJD to OLTP or from a free OLTP to AJD.- Mapping[str, str]
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- disaster_
recovery_ strtype - Indicates the disaster recovery (DR) type of the standby Autonomous Database Serverless instance. Autonomous Data Guard (ADG) DR type provides business critical DR with a faster recovery time objective (RTO) during failover or switchover. Backup-based DR type provides lower cost DR with a slower RTO during failover or switchover.
- display_
name str - (Updatable) The user-friendly name for the Autonomous Database. The name does not have to be unique.
- encryption_
key database.Autonomous Database Encryption Key Args - (Updatable) Details of the Autonomous Database encryption key.
- Mapping[str, str]
- (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example:
{"Department": "Finance"}
- in_
memory_ intpercentage - (Updatable) The percentage of the System Global Area(SGA) assigned to In-Memory tables in Autonomous Database. This property is applicable only to Autonomous Databases on the Exadata Cloud@Customer platform.
- is_
access_ boolcontrol_ enabled (Updatable) Indicates if the database-level access control is enabled. If disabled, database access is defined by the network security rules. If enabled, database access is restricted to the IP addresses defined by the rules specified with the
whitelistedIps
property. While specifyingwhitelistedIps
rules is optional, if database-level access control is enabled and no rules are specified, the database will become inaccessible. The rules can be added later using theUpdateAutonomousDatabase
API operation or edit option in console. When creating a database clone, the desired access control setting should be specified. By default, database-level access control will be disabled for the clone.This property is applicable only to Autonomous Databases on the Exadata Cloud@Customer platform. For Autonomous Database Serverless instances,
whitelistedIps
is used.- is_
auto_ boolscaling_ enabled - (Updatable) Indicates if auto scaling is enabled for the Autonomous Database CPU core count. The default value is
TRUE
. - is_
auto_ boolscaling_ for_ storage_ enabled - (Updatable) Indicates if auto scaling is enabled for the Autonomous Database storage. The default value is
FALSE
. - is_
data_ boolguard_ enabled - (Updatable) Deprecated. Indicates whether the Autonomous Database has local (in-region) Data Guard enabled. Not applicable to cross-region Autonomous Data Guard associations, or to Autonomous Databases using dedicated Exadata infrastructure or Exadata Cloud@Customer infrastructure.
- is_
dedicated bool - True if the database is on dedicated Exadata infrastructure.
- is_
dev_ booltier - (Updatable) Autonomous Database for Developers are free Autonomous Databases that developers can use to build and test new applications.With Autonomous these database instancess instances, you can try new Autonomous Database features for free and apply them to ongoing or new development projects. Developer database comes with limited resources and is, therefore, not suitable for large-scale testing and production deployments. When you need more compute or storage resources, you can transition to a paid database licensing by cloning your developer database into a regular Autonomous Database. See Autonomous Database documentation for more details.
- is_
free_ booltier - (Updatable) Indicates if this is an Always Free resource. The default value is false. Note that Always Free Autonomous Databases have 1 CPU and 20GB of memory. For Always Free databases, memory and CPU cannot be scaled. When
db_workload
isAJD
orAPEX
it cannot betrue
. - is_
local_ booldata_ guard_ enabled - (Updatable) Indicates whether the Autonomous Database has local (in-region) Data Guard enabled. It takes boolean values. Not applicable to cross-region Autonomous Data Guard associations, or to Autonomous Databases using dedicated Exadata infrastructure or Exadata Cloud@Customer infrastructure.
- is_
mtls_ boolconnection_ required - (Updatable) Indicates whether the Autonomous Database requires mTLS connections.
- is_
preview_ boolversion_ with_ service_ terms_ accepted - If set to
TRUE
, indicates that an Autonomous Database preview version is being provisioned, and that the preview version's terms of service have been accepted. Note that preview version software is only available for databases on Autonomous Database Serverless. - is_
refreshable_ boolclone - (Updatable) True for creating a refreshable clone and False for detaching the clone from source Autonomous Database. Detaching is one time operation and clone becomes a regular Autonomous Database.
- is_
replicate_ boolautomatic_ backups - If true, 7 days worth of backups are replicated across regions for Cross-Region ADB or Backup-Based DR between Primary and Standby. If false, the backups taken on the Primary are not replicated to the Standby database.
- is_
shrink_ boolonly (Updatable) An optional property when enabled triggers the Shrinking of Autonomous Database once. To trigger Shrinking of ADB once again, this flag needs to be disabled and re-enabled again. It should not be passed during create database operation. It is only applicable on Serverless databases i.e. where
is_dedicated
is false.** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- key_
version_ strid - The OCID of the key version that is used in rotate key operations.
- kms_
key_ strid - The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
- license_
model str - (Updatable) The Oracle license model that applies to the Oracle Autonomous Database. Bring your own license (BYOL) allows you to apply your current on-premises Oracle software licenses to equivalent, highly automated Oracle PaaS and IaaS services in the cloud. License Included allows you to subscribe to new Oracle Database software licenses and the Database service. Note that when provisioning an Autonomous Database on dedicated Exadata infrastructure, this attribute must be null because the attribute is already set at the Autonomous Exadata Infrastructure level. When using shared Exadata infrastructure, if a value is not specified, the system will supply the value of
BRING_YOUR_OWN_LICENSE
. It is a required field whendb_workload
is AJD and needs to be set toLICENSE_INCLUDED
as AJD does not support defaultlicense_model
valueBRING_YOUR_OWN_LICENSE
. - local_
adg_ intauto_ failover_ max_ data_ loss_ limit - Parameter that allows users to select an acceptable maximum data loss limit in seconds, up to which Automatic Failover will be triggered when necessary for a Local Autonomous Data Guard
- long_
term_ Sequence[database.backup_ schedules Autonomous Database Long Term Backup Schedule Args] - Details for the long-term backup schedule.
- max_
cpu_ intcore_ count - (Updatable) Deprecated. The number of Max OCPU cores to be made available to the autonomous database with auto scaling of cpu enabled.
- ncharacter_
set str - The national character set for the autonomous database. The default is AL16UTF16. Allowed values are: AL16UTF16 or UTF8.
- nsg_
ids Sequence[str] - (Updatable) The list of OCIDs for the network security groups (NSGs) to which this resource belongs. Setting this to an empty list removes all resources from all NSGs. For more information about NSGs, see Security Rules. NsgIds restrictions:
- A network security group (NSG) is optional for Autonomous Databases with private access. The nsgIds list can be empty.
- ocpu_
count float (Updatable) The number of OCPU cores to be made available to the database.
- Providing
computeModel
andcomputeCount
is the preferred method for setting CPUs for both OCPU and ECPU. The following points apply: - For Autonomous Databases on dedicated Exadata infrastructure, to provision less than 1 core, enter a fractional value in an increment of 0.1. For example, you can provision 0.3 or 0.4 cores, but not 0.35 cores. (Note that fractional OCPU values are not supported for Autonomous Databasese on shared Exadata infrastructure.)
- To provision 1 or more cores, you must enter an integer between 1 and the maximum number of cores available for the infrastructure shape. For example, you can provision 2 cores or 3 cores, but not 2.5 cores. This applies to Autonomous Databases on both shared and dedicated Exadata infrastructure.
For Autonomous Databases on dedicated Exadata infrastructure, the maximum number of cores is determined by the infrastructure shape. See Characteristics of Infrastructure Shapes for shape details.
Note: This parameter cannot be used with the
cpuCoreCount
parameter.- Providing
- open_
mode str - Indicates the Autonomous Database mode. The database can be opened in
READ_ONLY
orREAD_WRITE
mode. - operations_
insights_ strstatus - (Updatable) Status of Operations Insights for this Autonomous Database. Values supported are
ENABLED
andNOT_ENABLED
- permission_
level str - The Autonomous Database permission level. Restricted mode allows access only by admin users.
- private_
endpoint_ strip - The private endpoint Ip address for the resource.
- private_
endpoint_ strlabel - (Updatable) (Optional) (Updatable) The resource's private endpoint label.
- Setting the endpoint label to a non-empty string creates a private endpoint database.
- Resetting the endpoint label to an empty string, after the creation of the private endpoint database, changes the private endpoint database to a public endpoint database.
- Setting the endpoint label to a non-empty string value, updates to a new private endpoint database, when the database is disabled and re-enabled.
- refreshable_
mode str - (Updatable) The refresh mode of the clone. AUTOMATIC indicates that the clone is automatically being refreshed with data from the source Autonomous Database.
- remote_
disaster_ strrecovery_ type - Indicates the cross-region disaster recovery (DR) type of the standby Autonomous Database Serverless instance. Autonomous Data Guard (ADG) DR type provides business critical DR with a faster recovery time objective (RTO) during failover or switchover. Backup-based DR type provides lower cost DR with a slower RTO during failover or switchover.
- resource_
pool_ strleader_ id - (Updatable) The unique identifier for leader autonomous database OCID OCID.
- resource_
pool_ database.summary Autonomous Database Resource Pool Summary Args - (Updatable) The configuration details for resource pool
- rotate_
key_ booltrigger - (Updatable) An optional property when flipped triggers rotation of KMS key. It is only applicable on dedicated databases i.e. where
is_dedicated
is true. - scheduled_
operations Sequence[database.Autonomous Database Scheduled Operation Args] (Updatable) The list of scheduled operations. Consists of values such as dayOfWeek, scheduledStartTime, scheduledStopTime.
This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, whitelistedIps, isMTLSConnectionRequired, openMode, permissionLevel, dbWorkload, privateEndpointLabel, nsgIds, dbVersion, isRefreshable, dbName, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier.
- secret_
id str (Updatable) The Oracle Cloud Infrastructure vault secret [/Content/General/Concepts/identifiers.htm]OCID.
This cannot be used in conjunction with adminPassword.
- secret_
version_ intnumber - (Updatable) The version of the vault secret. If no version is specified, the latest version will be used.
- security_
attributes Mapping[str, str] - (Updatable) Security Attributes for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "audit"}}}
- shrink_
adb_ inttrigger - source str
The source of the database:
- Use
NONE
for creating a new Autonomous Database. - Use
DATABASE
for creating a new Autonomous Database by cloning an existing running Autonomous Database from the latest timestamp, also provide the source database OCID in thesource_id
parameter. - Use
CROSS_REGION_DATAGUARD
to create a standby Data Guard database in another region, also provide the remote primary database OCID in thesource_id
parameter. - Use
CLONE_TO_REFRESHABLE
for creating a refreshable clone.
For Autonomous Database Serverless instances, the following cloning options are available:
- Use
BACKUP_FROM_ID
for creating a new Autonomous Database by cloning from a specified backup. Also provide the backup OCID in theautonomous_database_backup_id
parameter. - Use
BACKUP_FROM_TIMESTAMP
for creating a point-in-time Autonomous Database clone using backups. Also provide the backup timestamp in thetimestamp
parameter. For more information, see Cloning and Moving an Autonomous Database.
- Use
- source_
id str - The OCID of the source Autonomous Database that will be used to create a new standby database for the Data Guard association.
- standby_
whitelisted_ Sequence[str]ips (Updatable) The client IP access control list (ACL). This feature is available for [Autonomous Database Serverless] (https://docs.oracle.com/en/cloud/paas/autonomous-database/index.html) and on Exadata Cloud@Customer. Only clients connecting from an IP address included in the ACL may access the Autonomous Database instance. If
arePrimaryWhitelistedIpsUsed
is 'TRUE' then Autonomous Database uses this primary's IP access control list (ACL) for the disaster recovery peer calledstandbywhitelistedips
.For Autonomous Database Serverless instances, this is an array of CIDR (Classless Inter-Domain Routing) notations for a subnet or VCN OCID. Use a semicolon (;) as a deliminator between the VCN-specific subnets or IPs. Example:
["1.1.1.1","1.1.1.0/24","ocid1.vcn.oc1.sea.<unique_id>","ocid1.vcn.oc1.sea.<unique_id1>;1.1.1.1","ocid1.vcn.oc1.sea.<unique_id2>;1.1.0.0/16"]
For Exadata Cloud@Customer, this is an array of IP addresses or CIDR (Classless Inter-Domain Routing) notations. Example:["1.1.1.1","1.1.1.0/24","1.1.2.25"]
For an update operation, if you want to delete all the IPs in the ACL, use an array with a single empty string entry.
If
arePrimaryWhitelistedIpsUsed
is 'TRUE' then Autonomous Database useswhitelisted_ips
primary's IP access control list (ACL) asstandbywhitelistedips
for the disaster recovery peer.This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, isMTLSConnectionRequired, openMode, permissionLevel, dbWorkload, dbVersion, isRefreshable, dbName, scheduledOperations, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier.
- state str
- The current state of the Autonomous Database.
- subnet_
id str (Updatable) The OCID of the subnet the resource is associated with. This the only parameter to configure private endpoint, VCN details are obtained from the
subnet_id
.Subnet Restrictions:
- For bare metal DB systems and for single node virtual machine DB systems, do not use a subnet that overlaps with 192.168.16.16/28.
- For Exadata and virtual machine 2-node RAC systems, do not use a subnet that overlaps with 192.168.128.0/20.
- For Autonomous Database, setting this will disable public secure access to the database.
- subscription_
id str - The OCID of the subscription with which resource needs to be associated with. These subnets are used by the Oracle Clusterware private interconnect on the database instance. Specifying an overlapping subnet will cause the private interconnect to malfunction. This restriction applies to both the client subnet and the backup subnet.
- switchover_
to str - It is applicable only when
is_local_data_guard_enabled
is true. Could be set toPRIMARY
orSTANDBY
. Default value isPRIMARY
. - switchover_
to_ strremote_ peer_ id - (Updatable) It is applicable only when
dataguard_region_type
androle
are set, andis_dedicated
is false. For Autonomous Database Serverless instances, Data Guard associations have designated primary and standby regions, and these region types do not change when the database changes roles. It takes the OCID of the remote peer to switchover to and the API is called from the remote region. - time_
of_ strauto_ refresh_ start - The the date and time that auto-refreshing will begin for an Autonomous Database refreshable clone. This value controls only the start time for the first refresh operation. Subsequent (ongoing) refresh operations have start times controlled by the value of the
autoRefreshFrequencyInSeconds
parameter. - timestamp str
- The timestamp specified for the point-in-time clone of the source Autonomous Database. The timestamp must be in the past.
- use_
latest_ boolavailable_ backup_ time_ stamp - Clone from latest available backup timestamp.
- vault_
id str - The OCID of the Oracle Cloud Infrastructure vault.
- whitelisted_
ips Sequence[str] (Updatable) The client IP access control list (ACL). This feature is available for autonomous databases on shared Exadata infrastructure and on Exadata Cloud@Customer. Only clients connecting from an IP address included in the ACL may access the Autonomous Database instance.
For Autonomous Database Serverless instances, this is an array of CIDR (Classless Inter-Domain Routing) notations for a subnet or VCN OCID. Use a semicolon (;) as a deliminator between the VCN-specific subnets or IPs. Example:
["1.1.1.1","1.1.1.0/24","ocid1.vcn.oc1.sea.<unique_id>","ocid1.vcn.oc1.sea.<unique_id1>;1.1.1.1","ocid1.vcn.oc1.sea.<unique_id2>;1.1.0.0/16"]
For Exadata Cloud@Customer, this is an array of IP addresses or CIDR (Classless Inter-Domain Routing) notations. Example:["1.1.1.1","1.1.1.0/24","1.1.2.25"]
For an update operation, if you want to delete all the IPs in the ACL, use an array with a single empty string entry.
This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, isMTLSConnectionRequired, openMode, permissionLevel, dbWorkload, dbVersion, isRefreshable, dbName, scheduledOperations, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier. To remove all whitelisted IPs, set the field to a list with an empty string
[""]
.
- compartment
Id String - (Updatable) The OCID of the compartment of the Autonomous Database.
- db
Name String - The database name. The name must begin with an alphabetic character and can contain a maximum of 14 alphanumeric characters. Special characters are not permitted. The database name must be unique in the tenancy. It is required in all cases except when creating a cross-region Autonomous Data Guard standby instance or a cross-region disaster recovery standby instance.
- admin
Password String - (Updatable) The password must be between 12 and 30 characters long, and must contain at least 1 uppercase, 1 lowercase, and 1 numeric character. It cannot contain the double quote symbol (") or the username "admin", regardless of casing. The password is mandatory if source value is "BACKUP_FROM_ID", "BACKUP_FROM_TIMESTAMP", "DATABASE" or "NONE".
- are
Primary BooleanWhitelisted Ips Used - (Updatable) This field will be null if the Autonomous Database is not Data Guard enabled or Access Control is disabled. It's value would be
TRUE
if Autonomous Database is Data Guard enabled and Access Control is enabled and if the Autonomous Database uses primary IP access control list (ACL) for standby. It's value would beFALSE
if Autonomous Database is Data Guard enabled and Access Control is enabled and if the Autonomous Database uses different IP access control list (ACL) for standby compared to primary. - auto
Refresh NumberFrequency In Seconds - (Updatable) The frequency a refreshable clone is refreshed after auto-refresh is enabled. The minimum is 1 hour. The maximum is 7 days. The date and time that auto-refresh is enabled is controlled by the
timeOfAutoRefreshStart
parameter. - auto
Refresh NumberPoint Lag In Seconds - (Updatable) The time, in seconds, the data of the refreshable clone lags the primary database at the point of refresh. The minimum is 0 minutes (0 mins means refresh to the latest available timestamp). The maximum is 7 days. The lag time increases after refreshing until the next data refresh happens.
- autonomous
Container StringDatabase Id - The Autonomous Container Database OCID.
- autonomous
Database StringBackup Id - The OCID of the source Autonomous Database Backup that you will clone to create a new Autonomous Database.
- autonomous
Database StringId - The OCID of the source Autonomous Database that you will clone to create a new Autonomous Database.
- autonomous
Maintenance StringSchedule Type - The maintenance schedule type of the Autonomous Database Serverless instances. The EARLY maintenance schedule of this Autonomous Database follows a schedule that applies patches prior to the REGULAR schedule.The REGULAR maintenance schedule of this Autonomous Database follows the normal cycle.
- backup
Retention NumberPeriod In Days - (Updatable) Retention period, in days, for backups.
- byol
Compute NumberCount Limit - character
Set String The character set for the autonomous database. The default is AL32UTF8. Allowed values for an Autonomous Database on Serverless infrastructure as returned by List Autonomous Database Character Sets
For an Autonomous Database on dedicated infrastructure, the allowed values are:
AL32UTF8, AR8ADOS710, AR8ADOS720, AR8APTEC715, AR8ARABICMACS, AR8ASMO8X, AR8ISO8859P6, AR8MSWIN1256, AR8MUSSAD768, AR8NAFITHA711, AR8NAFITHA721, AR8SAKHR706, AR8SAKHR707, AZ8ISO8859P9E, BG8MSWIN, BG8PC437S, BLT8CP921, BLT8ISO8859P13, BLT8MSWIN1257, BLT8PC775, BN8BSCII, CDN8PC863, CEL8ISO8859P14, CL8ISO8859P5, CL8ISOIR111, CL8KOI8R, CL8KOI8U, CL8MACCYRILLICS, CL8MSWIN1251, EE8ISO8859P2, EE8MACCES, EE8MACCROATIANS, EE8MSWIN1250, EE8PC852, EL8DEC, EL8ISO8859P7, EL8MACGREEKS, EL8MSWIN1253, EL8PC437S, EL8PC851, EL8PC869, ET8MSWIN923, HU8ABMOD, HU8CWI2, IN8ISCII, IS8PC861, IW8ISO8859P8, IW8MACHEBREWS, IW8MSWIN1255, IW8PC1507, JA16EUC, JA16EUCTILDE, JA16SJIS, JA16SJISTILDE, JA16VMS, KO16KSC5601, KO16KSCCS, KO16MSWIN949, LA8ISO6937, LA8PASSPORT, LT8MSWIN921, LT8PC772, LT8PC774, LV8PC1117, LV8PC8LR, LV8RST104090, N8PC865, NE8ISO8859P10, NEE8ISO8859P4, RU8BESTA, RU8PC855, RU8PC866, SE8ISO8859P3, TH8MACTHAIS, TH8TISASCII, TR8DEC, TR8MACTURKISHS, TR8MSWIN1254, TR8PC857, US7ASCII, US8PC437, UTF8, VN8MSWIN1258, VN8VN3, WE8DEC, WE8DG, WE8ISO8859P1, WE8ISO8859P15, WE8ISO8859P9, WE8MACROMAN8S, WE8MSWIN1252, WE8NCR4970, WE8NEXTSTEP, WE8PC850, WE8PC858, WE8PC860, WE8ROMAN8, ZHS16CGB231280, ZHS16GBK, ZHT16BIG5, ZHT16CCDC, ZHT16DBT, ZHT16HKSCS, ZHT16MSWIN950, ZHT32EUC, ZHT32SOPS, ZHT32TRIS
- clone
Type String - The Autonomous Database clone type. This parameter is not used to create a refreshable clone type, and for refreshable clones one must use the (source=CLONE_TO_REFRESHABLE) parameter.
FULL
- This option creates a new database that includes all source database data.METADATA
- This option creates a new database that includes the source database schema and select metadata, but not the source database data.
- compute
Count Number - (Updatable) The compute amount available to the database. Minimum and maximum values depend on the compute model and whether the database is an Autonomous Database Serverless instance or an Autonomous Database on Dedicated Exadata Infrastructure. For an Autonomous Database Serverless instance, the 'ECPU' compute model requires a minimum value of one, for databases in the elastic resource pool and minimum value of two, otherwise. Required when using the
computeModel
parameter. When usingcpuCoreCount
parameter, it is an error to specify computeCount to a non-null value. ProvidingcomputeModel
andcomputeCount
is the preferred method for both OCPU and ECPU. - compute
Model String - (Updatable) The compute model of the Autonomous Database. This is required if using the
computeCount
parameter. If usingcpuCoreCount
then it is an error to specifycomputeModel
to a non-null value. ECPU compute model is the recommended model and OCPU compute model is legacy. - cpu
Core NumberCount - (Updatable) The number of CPU cores to be made available to the database. For Autonomous Databases on dedicated Exadata infrastructure, the maximum number of cores is determined by the infrastructure shape. See Characteristics of Infrastructure Shapes for shape details.
Note: This parameter cannot be used with the
ocpuCount
parameter. This input is ignored for Always Free resources.- The data type must be an integer.
- The minimum number of cores for all types of autonomous database is 1
- The maximum number of cores is as follows:
- Autonomous Database Serverless instances: The maximum number of cores is 128.
- Autonomous Databases on dedicated Exadata infrastructure: The maximum number of cores is determined by the infrastructure shape. See Characteristics of Infrastructure Shapes for shape details.
- Providing
computeModel
andcomputeCount
is the preferred method for setting CPUs for both OCPU and ECPU.
- customer
Contacts List<Property Map> - (Updatable) Customer Contacts.
- data
Safe StringStatus - (Updatable) Status of the Data Safe registration for this Autonomous Database. Could be REGISTERED or NOT_REGISTERED.
- data
Storage NumberSize In Gb (Updatable) The size, in gigabytes, of the data volume that will be created and attached to the database. This storage can later be scaled up if needed. The maximum storage value is determined by the infrastructure shape. See Characteristics of Infrastructure Shapes for shape details.
Notes
- This parameter is only supported for dedicated Exadata infrastructure.
- This parameter cannot be used with the
dataStorageSizeInTBs
parameter.
- data
Storage NumberSize In Tbs (Updatable) The size, in terabytes, of the data volume that will be created and attached to the database. This storage can later be scaled up if needed. For Autonomous Databases on dedicated Exadata infrastructure, the maximum storage value is determined by the infrastructure shape. See Characteristics of Infrastructure Shapes for shape details. A full Exadata service is allocated when the Autonomous Database size is set to the upper limit (384 TB).
Note: This parameter cannot be used with the
dataStorageSizeInGBs
parameter. This input is ignored for Always Free resources.- database
Edition String - (Updatable) The Oracle Database Edition that applies to the Autonomous databases. It can be set to
ENTERPRISE_EDITION
orSTANDARD_EDITION
. - database
Management StringStatus - Status of Database Management for this Autonomous Database.
- db
Tools List<Property Map>Details (Updatable) The list of database tools details.
This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, whitelistedIps, isMTLSConnectionRequired, openMode, permissionLevel, dbWorkload, privateEndpointLabel, nsgIds, dbVersion, isRefreshable, dbName, scheduledOperations, isLocalDataGuardEnabled, or isFreeTier.
- db
Version String - (Updatable) A valid Oracle Database version for Autonomous Database.
db_workload
AJD and APEX are only supported fordb_version
19c
and above. - db
Workload String (Updatable) The Autonomous Database workload type. The following values are valid:
- OLTP - indicates an Autonomous Transaction Processing database
- DW - indicates an Autonomous Data Warehouse database
- AJD - indicates an Autonomous JSON Database
- APEX - indicates an Autonomous Database with the Oracle APEX Application Development workload type.
This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, isMTLSConnectionRequired, privateEndpointLabel, nsgIds, dbVersion, isRefreshable, dbName, scheduledOperations, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier. *Note:
db_workload
can only be updated from AJD to OLTP or from a free OLTP to AJD.- Map<String>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- disaster
Recovery StringType - Indicates the disaster recovery (DR) type of the standby Autonomous Database Serverless instance. Autonomous Data Guard (ADG) DR type provides business critical DR with a faster recovery time objective (RTO) during failover or switchover. Backup-based DR type provides lower cost DR with a slower RTO during failover or switchover.
- display
Name String - (Updatable) The user-friendly name for the Autonomous Database. The name does not have to be unique.
- encryption
Key Property Map - (Updatable) Details of the Autonomous Database encryption key.
- Map<String>
- (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example:
{"Department": "Finance"}
- in
Memory NumberPercentage - (Updatable) The percentage of the System Global Area(SGA) assigned to In-Memory tables in Autonomous Database. This property is applicable only to Autonomous Databases on the Exadata Cloud@Customer platform.
- is
Access BooleanControl Enabled (Updatable) Indicates if the database-level access control is enabled. If disabled, database access is defined by the network security rules. If enabled, database access is restricted to the IP addresses defined by the rules specified with the
whitelistedIps
property. While specifyingwhitelistedIps
rules is optional, if database-level access control is enabled and no rules are specified, the database will become inaccessible. The rules can be added later using theUpdateAutonomousDatabase
API operation or edit option in console. When creating a database clone, the desired access control setting should be specified. By default, database-level access control will be disabled for the clone.This property is applicable only to Autonomous Databases on the Exadata Cloud@Customer platform. For Autonomous Database Serverless instances,
whitelistedIps
is used.- is
Auto BooleanScaling Enabled - (Updatable) Indicates if auto scaling is enabled for the Autonomous Database CPU core count. The default value is
TRUE
. - is
Auto BooleanScaling For Storage Enabled - (Updatable) Indicates if auto scaling is enabled for the Autonomous Database storage. The default value is
FALSE
. - is
Data BooleanGuard Enabled - (Updatable) Deprecated. Indicates whether the Autonomous Database has local (in-region) Data Guard enabled. Not applicable to cross-region Autonomous Data Guard associations, or to Autonomous Databases using dedicated Exadata infrastructure or Exadata Cloud@Customer infrastructure.
- is
Dedicated Boolean - True if the database is on dedicated Exadata infrastructure.
- is
Dev BooleanTier - (Updatable) Autonomous Database for Developers are free Autonomous Databases that developers can use to build and test new applications.With Autonomous these database instancess instances, you can try new Autonomous Database features for free and apply them to ongoing or new development projects. Developer database comes with limited resources and is, therefore, not suitable for large-scale testing and production deployments. When you need more compute or storage resources, you can transition to a paid database licensing by cloning your developer database into a regular Autonomous Database. See Autonomous Database documentation for more details.
- is
Free BooleanTier - (Updatable) Indicates if this is an Always Free resource. The default value is false. Note that Always Free Autonomous Databases have 1 CPU and 20GB of memory. For Always Free databases, memory and CPU cannot be scaled. When
db_workload
isAJD
orAPEX
it cannot betrue
. - is
Local BooleanData Guard Enabled - (Updatable) Indicates whether the Autonomous Database has local (in-region) Data Guard enabled. It takes boolean values. Not applicable to cross-region Autonomous Data Guard associations, or to Autonomous Databases using dedicated Exadata infrastructure or Exadata Cloud@Customer infrastructure.
- is
Mtls BooleanConnection Required - (Updatable) Indicates whether the Autonomous Database requires mTLS connections.
- is
Preview BooleanVersion With Service Terms Accepted - If set to
TRUE
, indicates that an Autonomous Database preview version is being provisioned, and that the preview version's terms of service have been accepted. Note that preview version software is only available for databases on Autonomous Database Serverless. - is
Refreshable BooleanClone - (Updatable) True for creating a refreshable clone and False for detaching the clone from source Autonomous Database. Detaching is one time operation and clone becomes a regular Autonomous Database.
- is
Replicate BooleanAutomatic Backups - If true, 7 days worth of backups are replicated across regions for Cross-Region ADB or Backup-Based DR between Primary and Standby. If false, the backups taken on the Primary are not replicated to the Standby database.
- is
Shrink BooleanOnly (Updatable) An optional property when enabled triggers the Shrinking of Autonomous Database once. To trigger Shrinking of ADB once again, this flag needs to be disabled and re-enabled again. It should not be passed during create database operation. It is only applicable on Serverless databases i.e. where
is_dedicated
is false.** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- key
Version StringId - The OCID of the key version that is used in rotate key operations.
- kms
Key StringId - The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
- license
Model String - (Updatable) The Oracle license model that applies to the Oracle Autonomous Database. Bring your own license (BYOL) allows you to apply your current on-premises Oracle software licenses to equivalent, highly automated Oracle PaaS and IaaS services in the cloud. License Included allows you to subscribe to new Oracle Database software licenses and the Database service. Note that when provisioning an Autonomous Database on dedicated Exadata infrastructure, this attribute must be null because the attribute is already set at the Autonomous Exadata Infrastructure level. When using shared Exadata infrastructure, if a value is not specified, the system will supply the value of
BRING_YOUR_OWN_LICENSE
. It is a required field whendb_workload
is AJD and needs to be set toLICENSE_INCLUDED
as AJD does not support defaultlicense_model
valueBRING_YOUR_OWN_LICENSE
. - local
Adg NumberAuto Failover Max Data Loss Limit - Parameter that allows users to select an acceptable maximum data loss limit in seconds, up to which Automatic Failover will be triggered when necessary for a Local Autonomous Data Guard
- long
Term List<Property Map>Backup Schedules - Details for the long-term backup schedule.
- max
Cpu NumberCore Count - (Updatable) Deprecated. The number of Max OCPU cores to be made available to the autonomous database with auto scaling of cpu enabled.
- ncharacter
Set String - The national character set for the autonomous database. The default is AL16UTF16. Allowed values are: AL16UTF16 or UTF8.
- nsg
Ids List<String> - (Updatable) The list of OCIDs for the network security groups (NSGs) to which this resource belongs. Setting this to an empty list removes all resources from all NSGs. For more information about NSGs, see Security Rules. NsgIds restrictions:
- A network security group (NSG) is optional for Autonomous Databases with private access. The nsgIds list can be empty.
- ocpu
Count Number (Updatable) The number of OCPU cores to be made available to the database.
- Providing
computeModel
andcomputeCount
is the preferred method for setting CPUs for both OCPU and ECPU. The following points apply: - For Autonomous Databases on dedicated Exadata infrastructure, to provision less than 1 core, enter a fractional value in an increment of 0.1. For example, you can provision 0.3 or 0.4 cores, but not 0.35 cores. (Note that fractional OCPU values are not supported for Autonomous Databasese on shared Exadata infrastructure.)
- To provision 1 or more cores, you must enter an integer between 1 and the maximum number of cores available for the infrastructure shape. For example, you can provision 2 cores or 3 cores, but not 2.5 cores. This applies to Autonomous Databases on both shared and dedicated Exadata infrastructure.
For Autonomous Databases on dedicated Exadata infrastructure, the maximum number of cores is determined by the infrastructure shape. See Characteristics of Infrastructure Shapes for shape details.
Note: This parameter cannot be used with the
cpuCoreCount
parameter.- Providing
- open
Mode String - Indicates the Autonomous Database mode. The database can be opened in
READ_ONLY
orREAD_WRITE
mode. - operations
Insights StringStatus - (Updatable) Status of Operations Insights for this Autonomous Database. Values supported are
ENABLED
andNOT_ENABLED
- permission
Level String - The Autonomous Database permission level. Restricted mode allows access only by admin users.
- private
Endpoint StringIp - The private endpoint Ip address for the resource.
- private
Endpoint StringLabel - (Updatable) (Optional) (Updatable) The resource's private endpoint label.
- Setting the endpoint label to a non-empty string creates a private endpoint database.
- Resetting the endpoint label to an empty string, after the creation of the private endpoint database, changes the private endpoint database to a public endpoint database.
- Setting the endpoint label to a non-empty string value, updates to a new private endpoint database, when the database is disabled and re-enabled.
- refreshable
Mode String - (Updatable) The refresh mode of the clone. AUTOMATIC indicates that the clone is automatically being refreshed with data from the source Autonomous Database.
- remote
Disaster StringRecovery Type - Indicates the cross-region disaster recovery (DR) type of the standby Autonomous Database Serverless instance. Autonomous Data Guard (ADG) DR type provides business critical DR with a faster recovery time objective (RTO) during failover or switchover. Backup-based DR type provides lower cost DR with a slower RTO during failover or switchover.
- resource
Pool StringLeader Id - (Updatable) The unique identifier for leader autonomous database OCID OCID.
- resource
Pool Property MapSummary - (Updatable) The configuration details for resource pool
- rotate
Key BooleanTrigger - (Updatable) An optional property when flipped triggers rotation of KMS key. It is only applicable on dedicated databases i.e. where
is_dedicated
is true. - scheduled
Operations List<Property Map> (Updatable) The list of scheduled operations. Consists of values such as dayOfWeek, scheduledStartTime, scheduledStopTime.
This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, whitelistedIps, isMTLSConnectionRequired, openMode, permissionLevel, dbWorkload, privateEndpointLabel, nsgIds, dbVersion, isRefreshable, dbName, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier.
- secret
Id String (Updatable) The Oracle Cloud Infrastructure vault secret [/Content/General/Concepts/identifiers.htm]OCID.
This cannot be used in conjunction with adminPassword.
- secret
Version NumberNumber - (Updatable) The version of the vault secret. If no version is specified, the latest version will be used.
- security
Attributes Map<String> - (Updatable) Security Attributes for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "audit"}}}
- shrink
Adb NumberTrigger - source String
The source of the database:
- Use
NONE
for creating a new Autonomous Database. - Use
DATABASE
for creating a new Autonomous Database by cloning an existing running Autonomous Database from the latest timestamp, also provide the source database OCID in thesource_id
parameter. - Use
CROSS_REGION_DATAGUARD
to create a standby Data Guard database in another region, also provide the remote primary database OCID in thesource_id
parameter. - Use
CLONE_TO_REFRESHABLE
for creating a refreshable clone.
For Autonomous Database Serverless instances, the following cloning options are available:
- Use
BACKUP_FROM_ID
for creating a new Autonomous Database by cloning from a specified backup. Also provide the backup OCID in theautonomous_database_backup_id
parameter. - Use
BACKUP_FROM_TIMESTAMP
for creating a point-in-time Autonomous Database clone using backups. Also provide the backup timestamp in thetimestamp
parameter. For more information, see Cloning and Moving an Autonomous Database.
- Use
- source
Id String - The OCID of the source Autonomous Database that will be used to create a new standby database for the Data Guard association.
- standby
Whitelisted List<String>Ips (Updatable) The client IP access control list (ACL). This feature is available for [Autonomous Database Serverless] (https://docs.oracle.com/en/cloud/paas/autonomous-database/index.html) and on Exadata Cloud@Customer. Only clients connecting from an IP address included in the ACL may access the Autonomous Database instance. If
arePrimaryWhitelistedIpsUsed
is 'TRUE' then Autonomous Database uses this primary's IP access control list (ACL) for the disaster recovery peer calledstandbywhitelistedips
.For Autonomous Database Serverless instances, this is an array of CIDR (Classless Inter-Domain Routing) notations for a subnet or VCN OCID. Use a semicolon (;) as a deliminator between the VCN-specific subnets or IPs. Example:
["1.1.1.1","1.1.1.0/24","ocid1.vcn.oc1.sea.<unique_id>","ocid1.vcn.oc1.sea.<unique_id1>;1.1.1.1","ocid1.vcn.oc1.sea.<unique_id2>;1.1.0.0/16"]
For Exadata Cloud@Customer, this is an array of IP addresses or CIDR (Classless Inter-Domain Routing) notations. Example:["1.1.1.1","1.1.1.0/24","1.1.2.25"]
For an update operation, if you want to delete all the IPs in the ACL, use an array with a single empty string entry.
If
arePrimaryWhitelistedIpsUsed
is 'TRUE' then Autonomous Database useswhitelisted_ips
primary's IP access control list (ACL) asstandbywhitelistedips
for the disaster recovery peer.This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, isMTLSConnectionRequired, openMode, permissionLevel, dbWorkload, dbVersion, isRefreshable, dbName, scheduledOperations, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier.
- state String
- The current state of the Autonomous Database.
- subnet
Id String (Updatable) The OCID of the subnet the resource is associated with. This the only parameter to configure private endpoint, VCN details are obtained from the
subnet_id
.Subnet Restrictions:
- For bare metal DB systems and for single node virtual machine DB systems, do not use a subnet that overlaps with 192.168.16.16/28.
- For Exadata and virtual machine 2-node RAC systems, do not use a subnet that overlaps with 192.168.128.0/20.
- For Autonomous Database, setting this will disable public secure access to the database.
- subscription
Id String - The OCID of the subscription with which resource needs to be associated with. These subnets are used by the Oracle Clusterware private interconnect on the database instance. Specifying an overlapping subnet will cause the private interconnect to malfunction. This restriction applies to both the client subnet and the backup subnet.
- switchover
To String - It is applicable only when
is_local_data_guard_enabled
is true. Could be set toPRIMARY
orSTANDBY
. Default value isPRIMARY
. - switchover
To StringRemote Peer Id - (Updatable) It is applicable only when
dataguard_region_type
androle
are set, andis_dedicated
is false. For Autonomous Database Serverless instances, Data Guard associations have designated primary and standby regions, and these region types do not change when the database changes roles. It takes the OCID of the remote peer to switchover to and the API is called from the remote region. - time
Of StringAuto Refresh Start - The the date and time that auto-refreshing will begin for an Autonomous Database refreshable clone. This value controls only the start time for the first refresh operation. Subsequent (ongoing) refresh operations have start times controlled by the value of the
autoRefreshFrequencyInSeconds
parameter. - timestamp String
- The timestamp specified for the point-in-time clone of the source Autonomous Database. The timestamp must be in the past.
- use
Latest BooleanAvailable Backup Time Stamp - Clone from latest available backup timestamp.
- vault
Id String - The OCID of the Oracle Cloud Infrastructure vault.
- whitelisted
Ips List<String> (Updatable) The client IP access control list (ACL). This feature is available for autonomous databases on shared Exadata infrastructure and on Exadata Cloud@Customer. Only clients connecting from an IP address included in the ACL may access the Autonomous Database instance.
For Autonomous Database Serverless instances, this is an array of CIDR (Classless Inter-Domain Routing) notations for a subnet or VCN OCID. Use a semicolon (;) as a deliminator between the VCN-specific subnets or IPs. Example:
["1.1.1.1","1.1.1.0/24","ocid1.vcn.oc1.sea.<unique_id>","ocid1.vcn.oc1.sea.<unique_id1>;1.1.1.1","ocid1.vcn.oc1.sea.<unique_id2>;1.1.0.0/16"]
For Exadata Cloud@Customer, this is an array of IP addresses or CIDR (Classless Inter-Domain Routing) notations. Example:["1.1.1.1","1.1.1.0/24","1.1.2.25"]
For an update operation, if you want to delete all the IPs in the ACL, use an array with a single empty string entry.
This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, isMTLSConnectionRequired, openMode, permissionLevel, dbWorkload, dbVersion, isRefreshable, dbName, scheduledOperations, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier. To remove all whitelisted IPs, set the field to a list with an empty string
[""]
.
Outputs
All input properties are implicitly available as output properties. Additionally, the AutonomousDatabase resource produces the following output properties:
- Actual
Used doubleData Storage Size In Tbs - The current amount of storage in use for user and system data, in terabytes (TB).
- Allocated
Storage doubleSize In Tbs - The amount of storage currently allocated for the database tables and billed for, rounded up. When auto-scaling is not enabled, this value is equal to the
dataStorageSizeInTBs
value. You can compare this value to theactualUsedDataStorageSizeInTBs
value to determine if a manual shrink operation is appropriate for your allocated storage. - Apex
Details List<AutonomousDatabase Apex Detail> - Information about Oracle APEX Application Development.
- Availability
Domain string - The availability domain of a local Autonomous Data Guard standby database of an Autonomous Database Serverless instance.
- Available
Upgrade List<string>Versions - List of Oracle Database versions available for a database upgrade. If there are no version upgrades available, this list is empty.
- Backup
Configs List<AutonomousDatabase Backup Config> - Autonomous Database configuration details for storing manual backups in the Object Storage service.
- Cluster
Placement stringGroup Id - The OCID of the cluster placement group of the Autonomous Serverless Database.
- Connection
Strings List<AutonomousDatabase Connection String> - The connection string used to connect to the Autonomous Database. The username for the Service Console is ADMIN. Use the password you entered when creating the Autonomous Database for the password value.
- Connection
Urls List<AutonomousDatabase Connection Url> - The URLs for accessing Oracle Application Express (APEX) and SQL Developer Web with a browser from a Compute instance within your VCN or that has a direct connection to your VCN. Note that these URLs are provided by the console only for databases on dedicated Exadata infrastructure. Example:
{"sqlDevWebUrl": "https://<hostname>/ords...", "apexUrl", "https://<hostname>/ords..."}
- Dataguard
Region stringType - Deprecated (Optional) The Autonomous Data Guard region type of the Autonomous Database. For Autonomous Database Serverless instances, Data Guard associations have designated primary (
PRIMARY_DG_REGION
) and standby (REMOTE_STANDBY_DG_REGION
) regions, and these region types do not change when the database changes roles. The standby regions in Data Guard associations can be the same region designated as the primary region, or they can be remote regions. Certain database administrative operations may be available only in the primary region of the Data Guard association, and cannot be performed when the database using the "primary" role is operating in a remote Data Guard standby region. - Disaster
Recovery stringRegion Type - Deprecated The disaster recovery (DR) region type of the Autonomous Database. For Serverless Autonomous Databases, DR associations have designated primary (
PRIMARY
) and standby (REMOTE
) regions. These region types do not change when the database changes roles. The standby region in DR associations can be the same region as the primary region, or they can be in a remote regions. Some database administration operations may be available only in the primary region of the DR association, and cannot be performed when the database using the primary role is operating in a remote region. - Encryption
Key List<AutonomousHistory Entries Database Encryption Key History Entry> - Key History Entry.
- Failed
Data intRecovery In Seconds - Indicates the number of seconds of data loss for a Data Guard failover.
- Id string
- The provider-assigned unique ID for this managed resource.
- In
Memory intArea In Gbs - The area assigned to In-Memory tables in Autonomous Database.
- Infrastructure
Type string - The infrastructure type this resource belongs to.
- Is
Preview bool - Indicates if the Autonomous Database version is a preview version.
- Is
Reconnect boolClone Enabled - Indicates if the refreshable clone can be reconnected to its source database.
- Is
Remote boolData Guard Enabled - Indicates whether the Autonomous Database has Cross Region Data Guard enabled. It takes boolean values. Not applicable to Autonomous Databases using dedicated Exadata infrastructure or Exadata Cloud@Customer infrastructure.
- Key
History List<AutonomousEntries Database Key History Entry> - Key History Entry.
- Key
Store stringId - The OCID of the key store of Oracle Vault. This is used in Autonomous Databases on Serverless instances and dedicated Exadata infrastructure.
- Key
Store stringWallet Name - The wallet name for Oracle Key Vault.
- Kms
Key stringLifecycle Details - KMS key lifecycle details.
- Kms
Key stringVersion Id - The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation. Autonomous Database Serverless does not use key versions, hence is not applicable for Autonomous Database Serverless instances.
- Lifecycle
Details string - Additional information about the current lifecycle state.
- Local
Disaster stringRecovery Type - Indicates the local disaster recovery (DR) type of the Serverless Autonomous Database. Autonomous Data Guard (
ADG
) DR type provides business critical DR with a faster recovery time objective (RTO) during failover or switchover. Backup-based (BACKUP_BASED
) DR type provides lower cost DR with a slower RTO during failover or switchover. - Local
Standby List<AutonomousDbs Database Local Standby Db> - Autonomous Data Guard local (same region) standby database details.
- Memory
Per intOracle Compute Unit In Gbs - The amount of memory (in GBs) enabled per OCPU or ECPU. See Compute Models in Autonomous Database on Dedicated Exadata Infrastructure for more details. This parameter is not used for Autonomous database Serverless.
- Net
Services stringArchitecture - Enabling SHARED server architecture enables a database server to allow many client processes to share very few server processes, thereby increasing the number of supported users.
- Next
Long stringTerm Backup Time Stamp - The date and time when the next long-term backup would be created.
- Peer
Db List<string>Ids - The list of OCIDs of standby databases located in Autonomous Data Guard remote regions that are associated with the source database. Note that for Autonomous Database Serverless instances, standby databases located in the same region as the source primary database do not have OCIDs.
- Private
Endpoint string - The private endpoint for the resource. This parameter is not used in Autonomous Databases using Serverless infrastructure and Exadata Cloud@Customer infrastructure.
- Provisionable
Cpuses List<double> - An array of CPU values that an Autonomous Database can be scaled to.
- Public
Connection List<AutonomousUrls Database Public Connection Url> - The Public URLs of Private Endpoint database for accessing Oracle Application Express (APEX) and SQL Developer Web with a browser from a Compute instance within your VCN or that has a direct connection to your VCN.
- Public
Endpoint string - The public endpoint for the private endpoint enabled resource.
- Refreshable
Status string - The refresh status of the clone. REFRESHING indicates that the clone is currently being refreshed with data from the source Autonomous Database.
- Remote
Disaster List<AutonomousRecovery Configurations Database Remote Disaster Recovery Configuration> - Configurations of a Disaster Recovery.
- Role string
- The Data Guard role of the Autonomous Container Database or Autonomous Database, if Autonomous Data Guard is enabled.
- Service
Console stringUrl - The URL of the Service Console for the Autonomous Database.
- Standby
Dbs List<AutonomousDatabase Standby Db> - Deprecated Autonomous Data Guard standby database details.
- Supported
Regions List<string>To Clone Tos - The list of regions that support the creation of an Autonomous Database clone or an Autonomous Data Guard standby database.
- Dictionary<string, string>
- System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- Time
Created string - The date and time the Autonomous Database was created.
- Time
Data stringGuard Role Changed - The date and time the Autonomous Data Guard role was switched for the Autonomous Database. For databases that have standbys in both the primary Data Guard region and a remote Data Guard standby region, this is the latest timestamp of either the database using the "primary" role in the primary Data Guard region, or database located in the remote Data Guard standby region.
- Time
Deletion stringOf Free Autonomous Database - The date and time the Always Free database will be automatically deleted because of inactivity. If the database is in the STOPPED state and without activity until this time, it will be deleted.
- Time
Disaster stringRecovery Role Changed - The date and time the Disaster Recovery role was switched for the standby Autonomous Database.
- Time
Local stringData Guard Enabled - The date and time that Autonomous Data Guard was enabled for an Autonomous Database where the standby was provisioned in the same region as the primary database.
- Time
Maintenance stringBegin - The date and time when maintenance will begin.
- Time
Maintenance stringEnd - The date and time when maintenance will end.
- Time
Of stringJoining Resource Pool - Time
Of stringLast Failover - The timestamp of the last failover operation.
- Time
Of stringLast Refresh - The date and time when last refresh happened.
- Time
Of stringLast Refresh Point - The refresh point timestamp (UTC). The refresh point is the time to which the database was most recently refreshed. Data created after the refresh point is not included in the refresh.
- Time
Of stringLast Switchover - The timestamp of the last switchover operation for the Autonomous Database.
- Time
Of stringNext Refresh - The date and time of next refresh.
- Time
Reclamation stringOf Free Autonomous Database - The date and time the Always Free database will be stopped because of inactivity. If this time is reached without any database activity, the database will automatically be put into the STOPPED state.
- Time
Undeleted string - Time
Until stringReconnect Clone Enabled - The time and date as an RFC3339 formatted string, e.g., 2022-01-01T12:00:00.000Z, to set the limit for a refreshable clone to be reconnected to its source database.
- Total
Backup doubleStorage Size In Gbs - The backup storage to the database.
- Used
Data intStorage Size In Gbs - The storage space consumed by Autonomous Database in GBs.
- Used
Data intStorage Size In Tbs - The amount of storage that has been used, in terabytes.
- Actual
Used float64Data Storage Size In Tbs - The current amount of storage in use for user and system data, in terabytes (TB).
- Allocated
Storage float64Size In Tbs - The amount of storage currently allocated for the database tables and billed for, rounded up. When auto-scaling is not enabled, this value is equal to the
dataStorageSizeInTBs
value. You can compare this value to theactualUsedDataStorageSizeInTBs
value to determine if a manual shrink operation is appropriate for your allocated storage. - Apex
Details []AutonomousDatabase Apex Detail - Information about Oracle APEX Application Development.
- Availability
Domain string - The availability domain of a local Autonomous Data Guard standby database of an Autonomous Database Serverless instance.
- Available
Upgrade []stringVersions - List of Oracle Database versions available for a database upgrade. If there are no version upgrades available, this list is empty.
- Backup
Configs []AutonomousDatabase Backup Config - Autonomous Database configuration details for storing manual backups in the Object Storage service.
- Cluster
Placement stringGroup Id - The OCID of the cluster placement group of the Autonomous Serverless Database.
- Connection
Strings []AutonomousDatabase Connection String - The connection string used to connect to the Autonomous Database. The username for the Service Console is ADMIN. Use the password you entered when creating the Autonomous Database for the password value.
- Connection
Urls []AutonomousDatabase Connection Url - The URLs for accessing Oracle Application Express (APEX) and SQL Developer Web with a browser from a Compute instance within your VCN or that has a direct connection to your VCN. Note that these URLs are provided by the console only for databases on dedicated Exadata infrastructure. Example:
{"sqlDevWebUrl": "https://<hostname>/ords...", "apexUrl", "https://<hostname>/ords..."}
- Dataguard
Region stringType - Deprecated (Optional) The Autonomous Data Guard region type of the Autonomous Database. For Autonomous Database Serverless instances, Data Guard associations have designated primary (
PRIMARY_DG_REGION
) and standby (REMOTE_STANDBY_DG_REGION
) regions, and these region types do not change when the database changes roles. The standby regions in Data Guard associations can be the same region designated as the primary region, or they can be remote regions. Certain database administrative operations may be available only in the primary region of the Data Guard association, and cannot be performed when the database using the "primary" role is operating in a remote Data Guard standby region. - Disaster
Recovery stringRegion Type - Deprecated The disaster recovery (DR) region type of the Autonomous Database. For Serverless Autonomous Databases, DR associations have designated primary (
PRIMARY
) and standby (REMOTE
) regions. These region types do not change when the database changes roles. The standby region in DR associations can be the same region as the primary region, or they can be in a remote regions. Some database administration operations may be available only in the primary region of the DR association, and cannot be performed when the database using the primary role is operating in a remote region. - Encryption
Key []AutonomousHistory Entries Database Encryption Key History Entry - Key History Entry.
- Failed
Data intRecovery In Seconds - Indicates the number of seconds of data loss for a Data Guard failover.
- Id string
- The provider-assigned unique ID for this managed resource.
- In
Memory intArea In Gbs - The area assigned to In-Memory tables in Autonomous Database.
- Infrastructure
Type string - The infrastructure type this resource belongs to.
- Is
Preview bool - Indicates if the Autonomous Database version is a preview version.
- Is
Reconnect boolClone Enabled - Indicates if the refreshable clone can be reconnected to its source database.
- Is
Remote boolData Guard Enabled - Indicates whether the Autonomous Database has Cross Region Data Guard enabled. It takes boolean values. Not applicable to Autonomous Databases using dedicated Exadata infrastructure or Exadata Cloud@Customer infrastructure.
- Key
History []AutonomousEntries Database Key History Entry - Key History Entry.
- Key
Store stringId - The OCID of the key store of Oracle Vault. This is used in Autonomous Databases on Serverless instances and dedicated Exadata infrastructure.
- Key
Store stringWallet Name - The wallet name for Oracle Key Vault.
- Kms
Key stringLifecycle Details - KMS key lifecycle details.
- Kms
Key stringVersion Id - The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation. Autonomous Database Serverless does not use key versions, hence is not applicable for Autonomous Database Serverless instances.
- Lifecycle
Details string - Additional information about the current lifecycle state.
- Local
Disaster stringRecovery Type - Indicates the local disaster recovery (DR) type of the Serverless Autonomous Database. Autonomous Data Guard (
ADG
) DR type provides business critical DR with a faster recovery time objective (RTO) during failover or switchover. Backup-based (BACKUP_BASED
) DR type provides lower cost DR with a slower RTO during failover or switchover. - Local
Standby []AutonomousDbs Database Local Standby Db - Autonomous Data Guard local (same region) standby database details.
- Memory
Per intOracle Compute Unit In Gbs - The amount of memory (in GBs) enabled per OCPU or ECPU. See Compute Models in Autonomous Database on Dedicated Exadata Infrastructure for more details. This parameter is not used for Autonomous database Serverless.
- Net
Services stringArchitecture - Enabling SHARED server architecture enables a database server to allow many client processes to share very few server processes, thereby increasing the number of supported users.
- Next
Long stringTerm Backup Time Stamp - The date and time when the next long-term backup would be created.
- Peer
Db []stringIds - The list of OCIDs of standby databases located in Autonomous Data Guard remote regions that are associated with the source database. Note that for Autonomous Database Serverless instances, standby databases located in the same region as the source primary database do not have OCIDs.
- Private
Endpoint string - The private endpoint for the resource. This parameter is not used in Autonomous Databases using Serverless infrastructure and Exadata Cloud@Customer infrastructure.
- Provisionable
Cpuses []float64 - An array of CPU values that an Autonomous Database can be scaled to.
- Public
Connection []AutonomousUrls Database Public Connection Url - The Public URLs of Private Endpoint database for accessing Oracle Application Express (APEX) and SQL Developer Web with a browser from a Compute instance within your VCN or that has a direct connection to your VCN.
- Public
Endpoint string - The public endpoint for the private endpoint enabled resource.
- Refreshable
Status string - The refresh status of the clone. REFRESHING indicates that the clone is currently being refreshed with data from the source Autonomous Database.
- Remote
Disaster []AutonomousRecovery Configurations Database Remote Disaster Recovery Configuration - Configurations of a Disaster Recovery.
- Role string
- The Data Guard role of the Autonomous Container Database or Autonomous Database, if Autonomous Data Guard is enabled.
- Service
Console stringUrl - The URL of the Service Console for the Autonomous Database.
- Standby
Dbs []AutonomousDatabase Standby Db - Deprecated Autonomous Data Guard standby database details.
- Supported
Regions []stringTo Clone Tos - The list of regions that support the creation of an Autonomous Database clone or an Autonomous Data Guard standby database.
- map[string]string
- System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- Time
Created string - The date and time the Autonomous Database was created.
- Time
Data stringGuard Role Changed - The date and time the Autonomous Data Guard role was switched for the Autonomous Database. For databases that have standbys in both the primary Data Guard region and a remote Data Guard standby region, this is the latest timestamp of either the database using the "primary" role in the primary Data Guard region, or database located in the remote Data Guard standby region.
- Time
Deletion stringOf Free Autonomous Database - The date and time the Always Free database will be automatically deleted because of inactivity. If the database is in the STOPPED state and without activity until this time, it will be deleted.
- Time
Disaster stringRecovery Role Changed - The date and time the Disaster Recovery role was switched for the standby Autonomous Database.
- Time
Local stringData Guard Enabled - The date and time that Autonomous Data Guard was enabled for an Autonomous Database where the standby was provisioned in the same region as the primary database.
- Time
Maintenance stringBegin - The date and time when maintenance will begin.
- Time
Maintenance stringEnd - The date and time when maintenance will end.
- Time
Of stringJoining Resource Pool - Time
Of stringLast Failover - The timestamp of the last failover operation.
- Time
Of stringLast Refresh - The date and time when last refresh happened.
- Time
Of stringLast Refresh Point - The refresh point timestamp (UTC). The refresh point is the time to which the database was most recently refreshed. Data created after the refresh point is not included in the refresh.
- Time
Of stringLast Switchover - The timestamp of the last switchover operation for the Autonomous Database.
- Time
Of stringNext Refresh - The date and time of next refresh.
- Time
Reclamation stringOf Free Autonomous Database - The date and time the Always Free database will be stopped because of inactivity. If this time is reached without any database activity, the database will automatically be put into the STOPPED state.
- Time
Undeleted string - Time
Until stringReconnect Clone Enabled - The time and date as an RFC3339 formatted string, e.g., 2022-01-01T12:00:00.000Z, to set the limit for a refreshable clone to be reconnected to its source database.
- Total
Backup float64Storage Size In Gbs - The backup storage to the database.
- Used
Data intStorage Size In Gbs - The storage space consumed by Autonomous Database in GBs.
- Used
Data intStorage Size In Tbs - The amount of storage that has been used, in terabytes.
- actual
Used DoubleData Storage Size In Tbs - The current amount of storage in use for user and system data, in terabytes (TB).
- allocated
Storage DoubleSize In Tbs - The amount of storage currently allocated for the database tables and billed for, rounded up. When auto-scaling is not enabled, this value is equal to the
dataStorageSizeInTBs
value. You can compare this value to theactualUsedDataStorageSizeInTBs
value to determine if a manual shrink operation is appropriate for your allocated storage. - apex
Details List<AutonomousApex Detail> - Information about Oracle APEX Application Development.
- availability
Domain String - The availability domain of a local Autonomous Data Guard standby database of an Autonomous Database Serverless instance.
- available
Upgrade List<String>Versions - List of Oracle Database versions available for a database upgrade. If there are no version upgrades available, this list is empty.
- backup
Configs List<AutonomousBackup Config> - Autonomous Database configuration details for storing manual backups in the Object Storage service.
- cluster
Placement StringGroup Id - The OCID of the cluster placement group of the Autonomous Serverless Database.
- connection
Strings List<AutonomousConnection String> - The connection string used to connect to the Autonomous Database. The username for the Service Console is ADMIN. Use the password you entered when creating the Autonomous Database for the password value.
- connection
Urls List<AutonomousConnection Url> - The URLs for accessing Oracle Application Express (APEX) and SQL Developer Web with a browser from a Compute instance within your VCN or that has a direct connection to your VCN. Note that these URLs are provided by the console only for databases on dedicated Exadata infrastructure. Example:
{"sqlDevWebUrl": "https://<hostname>/ords...", "apexUrl", "https://<hostname>/ords..."}
- dataguard
Region StringType - Deprecated (Optional) The Autonomous Data Guard region type of the Autonomous Database. For Autonomous Database Serverless instances, Data Guard associations have designated primary (
PRIMARY_DG_REGION
) and standby (REMOTE_STANDBY_DG_REGION
) regions, and these region types do not change when the database changes roles. The standby regions in Data Guard associations can be the same region designated as the primary region, or they can be remote regions. Certain database administrative operations may be available only in the primary region of the Data Guard association, and cannot be performed when the database using the "primary" role is operating in a remote Data Guard standby region. - disaster
Recovery StringRegion Type - Deprecated The disaster recovery (DR) region type of the Autonomous Database. For Serverless Autonomous Databases, DR associations have designated primary (
PRIMARY
) and standby (REMOTE
) regions. These region types do not change when the database changes roles. The standby region in DR associations can be the same region as the primary region, or they can be in a remote regions. Some database administration operations may be available only in the primary region of the DR association, and cannot be performed when the database using the primary role is operating in a remote region. - encryption
Key List<AutonomousHistory Entries Encryption Key History Entry> - Key History Entry.
- failed
Data IntegerRecovery In Seconds - Indicates the number of seconds of data loss for a Data Guard failover.
- id String
- The provider-assigned unique ID for this managed resource.
- in
Memory IntegerArea In Gbs - The area assigned to In-Memory tables in Autonomous Database.
- infrastructure
Type String - The infrastructure type this resource belongs to.
- is
Preview Boolean - Indicates if the Autonomous Database version is a preview version.
- is
Reconnect BooleanClone Enabled - Indicates if the refreshable clone can be reconnected to its source database.
- is
Remote BooleanData Guard Enabled - Indicates whether the Autonomous Database has Cross Region Data Guard enabled. It takes boolean values. Not applicable to Autonomous Databases using dedicated Exadata infrastructure or Exadata Cloud@Customer infrastructure.
- key
History List<AutonomousEntries Key History Entry> - Key History Entry.
- key
Store StringId - The OCID of the key store of Oracle Vault. This is used in Autonomous Databases on Serverless instances and dedicated Exadata infrastructure.
- key
Store StringWallet Name - The wallet name for Oracle Key Vault.
- kms
Key StringLifecycle Details - KMS key lifecycle details.
- kms
Key StringVersion Id - The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation. Autonomous Database Serverless does not use key versions, hence is not applicable for Autonomous Database Serverless instances.
- lifecycle
Details String - Additional information about the current lifecycle state.
- local
Disaster StringRecovery Type - Indicates the local disaster recovery (DR) type of the Serverless Autonomous Database. Autonomous Data Guard (
ADG
) DR type provides business critical DR with a faster recovery time objective (RTO) during failover or switchover. Backup-based (BACKUP_BASED
) DR type provides lower cost DR with a slower RTO during failover or switchover. - local
Standby List<AutonomousDbs Local Standby Db> - Autonomous Data Guard local (same region) standby database details.
- memory
Per IntegerOracle Compute Unit In Gbs - The amount of memory (in GBs) enabled per OCPU or ECPU. See Compute Models in Autonomous Database on Dedicated Exadata Infrastructure for more details. This parameter is not used for Autonomous database Serverless.
- net
Services StringArchitecture - Enabling SHARED server architecture enables a database server to allow many client processes to share very few server processes, thereby increasing the number of supported users.
- next
Long StringTerm Backup Time Stamp - The date and time when the next long-term backup would be created.
- peer
Db List<String>Ids - The list of OCIDs of standby databases located in Autonomous Data Guard remote regions that are associated with the source database. Note that for Autonomous Database Serverless instances, standby databases located in the same region as the source primary database do not have OCIDs.
- private
Endpoint String - The private endpoint for the resource. This parameter is not used in Autonomous Databases using Serverless infrastructure and Exadata Cloud@Customer infrastructure.
- provisionable
Cpuses List<Double> - An array of CPU values that an Autonomous Database can be scaled to.
- public
Connection List<AutonomousUrls Public Connection Url> - The Public URLs of Private Endpoint database for accessing Oracle Application Express (APEX) and SQL Developer Web with a browser from a Compute instance within your VCN or that has a direct connection to your VCN.
- public
Endpoint String - The public endpoint for the private endpoint enabled resource.
- refreshable
Status String - The refresh status of the clone. REFRESHING indicates that the clone is currently being refreshed with data from the source Autonomous Database.
- remote
Disaster List<AutonomousRecovery Configurations Remote Disaster Recovery Configuration> - Configurations of a Disaster Recovery.
- role String
- The Data Guard role of the Autonomous Container Database or Autonomous Database, if Autonomous Data Guard is enabled.
- service
Console StringUrl - The URL of the Service Console for the Autonomous Database.
- standby
Dbs List<AutonomousStandby Db> - Deprecated Autonomous Data Guard standby database details.
- supported
Regions List<String>To Clone Tos - The list of regions that support the creation of an Autonomous Database clone or an Autonomous Data Guard standby database.
- Map<String,String>
- System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- time
Created String - The date and time the Autonomous Database was created.
- time
Data StringGuard Role Changed - The date and time the Autonomous Data Guard role was switched for the Autonomous Database. For databases that have standbys in both the primary Data Guard region and a remote Data Guard standby region, this is the latest timestamp of either the database using the "primary" role in the primary Data Guard region, or database located in the remote Data Guard standby region.
- time
Deletion StringOf Free Autonomous Database - The date and time the Always Free database will be automatically deleted because of inactivity. If the database is in the STOPPED state and without activity until this time, it will be deleted.
- time
Disaster StringRecovery Role Changed - The date and time the Disaster Recovery role was switched for the standby Autonomous Database.
- time
Local StringData Guard Enabled - The date and time that Autonomous Data Guard was enabled for an Autonomous Database where the standby was provisioned in the same region as the primary database.
- time
Maintenance StringBegin - The date and time when maintenance will begin.
- time
Maintenance StringEnd - The date and time when maintenance will end.
- time
Of StringJoining Resource Pool - time
Of StringLast Failover - The timestamp of the last failover operation.
- time
Of StringLast Refresh - The date and time when last refresh happened.
- time
Of StringLast Refresh Point - The refresh point timestamp (UTC). The refresh point is the time to which the database was most recently refreshed. Data created after the refresh point is not included in the refresh.
- time
Of StringLast Switchover - The timestamp of the last switchover operation for the Autonomous Database.
- time
Of StringNext Refresh - The date and time of next refresh.
- time
Reclamation StringOf Free Autonomous Database - The date and time the Always Free database will be stopped because of inactivity. If this time is reached without any database activity, the database will automatically be put into the STOPPED state.
- time
Undeleted String - time
Until StringReconnect Clone Enabled - The time and date as an RFC3339 formatted string, e.g., 2022-01-01T12:00:00.000Z, to set the limit for a refreshable clone to be reconnected to its source database.
- total
Backup DoubleStorage Size In Gbs - The backup storage to the database.
- used
Data IntegerStorage Size In Gbs - The storage space consumed by Autonomous Database in GBs.
- used
Data IntegerStorage Size In Tbs - The amount of storage that has been used, in terabytes.
- actual
Used numberData Storage Size In Tbs - The current amount of storage in use for user and system data, in terabytes (TB).
- allocated
Storage numberSize In Tbs - The amount of storage currently allocated for the database tables and billed for, rounded up. When auto-scaling is not enabled, this value is equal to the
dataStorageSizeInTBs
value. You can compare this value to theactualUsedDataStorageSizeInTBs
value to determine if a manual shrink operation is appropriate for your allocated storage. - apex
Details AutonomousDatabase Apex Detail[] - Information about Oracle APEX Application Development.
- availability
Domain string - The availability domain of a local Autonomous Data Guard standby database of an Autonomous Database Serverless instance.
- available
Upgrade string[]Versions - List of Oracle Database versions available for a database upgrade. If there are no version upgrades available, this list is empty.
- backup
Configs AutonomousDatabase Backup Config[] - Autonomous Database configuration details for storing manual backups in the Object Storage service.
- cluster
Placement stringGroup Id - The OCID of the cluster placement group of the Autonomous Serverless Database.
- connection
Strings AutonomousDatabase Connection String[] - The connection string used to connect to the Autonomous Database. The username for the Service Console is ADMIN. Use the password you entered when creating the Autonomous Database for the password value.
- connection
Urls AutonomousDatabase Connection Url[] - The URLs for accessing Oracle Application Express (APEX) and SQL Developer Web with a browser from a Compute instance within your VCN or that has a direct connection to your VCN. Note that these URLs are provided by the console only for databases on dedicated Exadata infrastructure. Example:
{"sqlDevWebUrl": "https://<hostname>/ords...", "apexUrl", "https://<hostname>/ords..."}
- dataguard
Region stringType - Deprecated (Optional) The Autonomous Data Guard region type of the Autonomous Database. For Autonomous Database Serverless instances, Data Guard associations have designated primary (
PRIMARY_DG_REGION
) and standby (REMOTE_STANDBY_DG_REGION
) regions, and these region types do not change when the database changes roles. The standby regions in Data Guard associations can be the same region designated as the primary region, or they can be remote regions. Certain database administrative operations may be available only in the primary region of the Data Guard association, and cannot be performed when the database using the "primary" role is operating in a remote Data Guard standby region. - disaster
Recovery stringRegion Type - Deprecated The disaster recovery (DR) region type of the Autonomous Database. For Serverless Autonomous Databases, DR associations have designated primary (
PRIMARY
) and standby (REMOTE
) regions. These region types do not change when the database changes roles. The standby region in DR associations can be the same region as the primary region, or they can be in a remote regions. Some database administration operations may be available only in the primary region of the DR association, and cannot be performed when the database using the primary role is operating in a remote region. - encryption
Key AutonomousHistory Entries Database Encryption Key History Entry[] - Key History Entry.
- failed
Data numberRecovery In Seconds - Indicates the number of seconds of data loss for a Data Guard failover.
- id string
- The provider-assigned unique ID for this managed resource.
- in
Memory numberArea In Gbs - The area assigned to In-Memory tables in Autonomous Database.
- infrastructure
Type string - The infrastructure type this resource belongs to.
- is
Preview boolean - Indicates if the Autonomous Database version is a preview version.
- is
Reconnect booleanClone Enabled - Indicates if the refreshable clone can be reconnected to its source database.
- is
Remote booleanData Guard Enabled - Indicates whether the Autonomous Database has Cross Region Data Guard enabled. It takes boolean values. Not applicable to Autonomous Databases using dedicated Exadata infrastructure or Exadata Cloud@Customer infrastructure.
- key
History AutonomousEntries Database Key History Entry[] - Key History Entry.
- key
Store stringId - The OCID of the key store of Oracle Vault. This is used in Autonomous Databases on Serverless instances and dedicated Exadata infrastructure.
- key
Store stringWallet Name - The wallet name for Oracle Key Vault.
- kms
Key stringLifecycle Details - KMS key lifecycle details.
- kms
Key stringVersion Id - The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation. Autonomous Database Serverless does not use key versions, hence is not applicable for Autonomous Database Serverless instances.
- lifecycle
Details string - Additional information about the current lifecycle state.
- local
Disaster stringRecovery Type - Indicates the local disaster recovery (DR) type of the Serverless Autonomous Database. Autonomous Data Guard (
ADG
) DR type provides business critical DR with a faster recovery time objective (RTO) during failover or switchover. Backup-based (BACKUP_BASED
) DR type provides lower cost DR with a slower RTO during failover or switchover. - local
Standby AutonomousDbs Database Local Standby Db[] - Autonomous Data Guard local (same region) standby database details.
- memory
Per numberOracle Compute Unit In Gbs - The amount of memory (in GBs) enabled per OCPU or ECPU. See Compute Models in Autonomous Database on Dedicated Exadata Infrastructure for more details. This parameter is not used for Autonomous database Serverless.
- net
Services stringArchitecture - Enabling SHARED server architecture enables a database server to allow many client processes to share very few server processes, thereby increasing the number of supported users.
- next
Long stringTerm Backup Time Stamp - The date and time when the next long-term backup would be created.
- peer
Db string[]Ids - The list of OCIDs of standby databases located in Autonomous Data Guard remote regions that are associated with the source database. Note that for Autonomous Database Serverless instances, standby databases located in the same region as the source primary database do not have OCIDs.
- private
Endpoint string - The private endpoint for the resource. This parameter is not used in Autonomous Databases using Serverless infrastructure and Exadata Cloud@Customer infrastructure.
- provisionable
Cpuses number[] - An array of CPU values that an Autonomous Database can be scaled to.
- public
Connection AutonomousUrls Database Public Connection Url[] - The Public URLs of Private Endpoint database for accessing Oracle Application Express (APEX) and SQL Developer Web with a browser from a Compute instance within your VCN or that has a direct connection to your VCN.
- public
Endpoint string - The public endpoint for the private endpoint enabled resource.
- refreshable
Status string - The refresh status of the clone. REFRESHING indicates that the clone is currently being refreshed with data from the source Autonomous Database.
- remote
Disaster AutonomousRecovery Configurations Database Remote Disaster Recovery Configuration[] - Configurations of a Disaster Recovery.
- role string
- The Data Guard role of the Autonomous Container Database or Autonomous Database, if Autonomous Data Guard is enabled.
- service
Console stringUrl - The URL of the Service Console for the Autonomous Database.
- standby
Dbs AutonomousDatabase Standby Db[] - Deprecated Autonomous Data Guard standby database details.
- supported
Regions string[]To Clone Tos - The list of regions that support the creation of an Autonomous Database clone or an Autonomous Data Guard standby database.
- {[key: string]: string}
- System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- time
Created string - The date and time the Autonomous Database was created.
- time
Data stringGuard Role Changed - The date and time the Autonomous Data Guard role was switched for the Autonomous Database. For databases that have standbys in both the primary Data Guard region and a remote Data Guard standby region, this is the latest timestamp of either the database using the "primary" role in the primary Data Guard region, or database located in the remote Data Guard standby region.
- time
Deletion stringOf Free Autonomous Database - The date and time the Always Free database will be automatically deleted because of inactivity. If the database is in the STOPPED state and without activity until this time, it will be deleted.
- time
Disaster stringRecovery Role Changed - The date and time the Disaster Recovery role was switched for the standby Autonomous Database.
- time
Local stringData Guard Enabled - The date and time that Autonomous Data Guard was enabled for an Autonomous Database where the standby was provisioned in the same region as the primary database.
- time
Maintenance stringBegin - The date and time when maintenance will begin.
- time
Maintenance stringEnd - The date and time when maintenance will end.
- time
Of stringJoining Resource Pool - time
Of stringLast Failover - The timestamp of the last failover operation.
- time
Of stringLast Refresh - The date and time when last refresh happened.
- time
Of stringLast Refresh Point - The refresh point timestamp (UTC). The refresh point is the time to which the database was most recently refreshed. Data created after the refresh point is not included in the refresh.
- time
Of stringLast Switchover - The timestamp of the last switchover operation for the Autonomous Database.
- time
Of stringNext Refresh - The date and time of next refresh.
- time
Reclamation stringOf Free Autonomous Database - The date and time the Always Free database will be stopped because of inactivity. If this time is reached without any database activity, the database will automatically be put into the STOPPED state.
- time
Undeleted string - time
Until stringReconnect Clone Enabled - The time and date as an RFC3339 formatted string, e.g., 2022-01-01T12:00:00.000Z, to set the limit for a refreshable clone to be reconnected to its source database.
- total
Backup numberStorage Size In Gbs - The backup storage to the database.
- used
Data numberStorage Size In Gbs - The storage space consumed by Autonomous Database in GBs.
- used
Data numberStorage Size In Tbs - The amount of storage that has been used, in terabytes.
- actual_
used_ floatdata_ storage_ size_ in_ tbs - The current amount of storage in use for user and system data, in terabytes (TB).
- allocated_
storage_ floatsize_ in_ tbs - The amount of storage currently allocated for the database tables and billed for, rounded up. When auto-scaling is not enabled, this value is equal to the
dataStorageSizeInTBs
value. You can compare this value to theactualUsedDataStorageSizeInTBs
value to determine if a manual shrink operation is appropriate for your allocated storage. - apex_
details Sequence[database.Autonomous Database Apex Detail] - Information about Oracle APEX Application Development.
- availability_
domain str - The availability domain of a local Autonomous Data Guard standby database of an Autonomous Database Serverless instance.
- available_
upgrade_ Sequence[str]versions - List of Oracle Database versions available for a database upgrade. If there are no version upgrades available, this list is empty.
- backup_
configs Sequence[database.Autonomous Database Backup Config] - Autonomous Database configuration details for storing manual backups in the Object Storage service.
- cluster_
placement_ strgroup_ id - The OCID of the cluster placement group of the Autonomous Serverless Database.
- connection_
strings Sequence[database.Autonomous Database Connection String] - The connection string used to connect to the Autonomous Database. The username for the Service Console is ADMIN. Use the password you entered when creating the Autonomous Database for the password value.
- connection_
urls Sequence[database.Autonomous Database Connection Url] - The URLs for accessing Oracle Application Express (APEX) and SQL Developer Web with a browser from a Compute instance within your VCN or that has a direct connection to your VCN. Note that these URLs are provided by the console only for databases on dedicated Exadata infrastructure. Example:
{"sqlDevWebUrl": "https://<hostname>/ords...", "apexUrl", "https://<hostname>/ords..."}
- dataguard_
region_ strtype - Deprecated (Optional) The Autonomous Data Guard region type of the Autonomous Database. For Autonomous Database Serverless instances, Data Guard associations have designated primary (
PRIMARY_DG_REGION
) and standby (REMOTE_STANDBY_DG_REGION
) regions, and these region types do not change when the database changes roles. The standby regions in Data Guard associations can be the same region designated as the primary region, or they can be remote regions. Certain database administrative operations may be available only in the primary region of the Data Guard association, and cannot be performed when the database using the "primary" role is operating in a remote Data Guard standby region. - disaster_
recovery_ strregion_ type - Deprecated The disaster recovery (DR) region type of the Autonomous Database. For Serverless Autonomous Databases, DR associations have designated primary (
PRIMARY
) and standby (REMOTE
) regions. These region types do not change when the database changes roles. The standby region in DR associations can be the same region as the primary region, or they can be in a remote regions. Some database administration operations may be available only in the primary region of the DR association, and cannot be performed when the database using the primary role is operating in a remote region. - encryption_
key_ Sequence[database.history_ entries Autonomous Database Encryption Key History Entry] - Key History Entry.
- failed_
data_ intrecovery_ in_ seconds - Indicates the number of seconds of data loss for a Data Guard failover.
- id str
- The provider-assigned unique ID for this managed resource.
- in_
memory_ intarea_ in_ gbs - The area assigned to In-Memory tables in Autonomous Database.
- infrastructure_
type str - The infrastructure type this resource belongs to.
- is_
preview bool - Indicates if the Autonomous Database version is a preview version.
- is_
reconnect_ boolclone_ enabled - Indicates if the refreshable clone can be reconnected to its source database.
- is_
remote_ booldata_ guard_ enabled - Indicates whether the Autonomous Database has Cross Region Data Guard enabled. It takes boolean values. Not applicable to Autonomous Databases using dedicated Exadata infrastructure or Exadata Cloud@Customer infrastructure.
- key_
history_ Sequence[database.entries Autonomous Database Key History Entry] - Key History Entry.
- key_
store_ strid - The OCID of the key store of Oracle Vault. This is used in Autonomous Databases on Serverless instances and dedicated Exadata infrastructure.
- key_
store_ strwallet_ name - The wallet name for Oracle Key Vault.
- kms_
key_ strlifecycle_ details - KMS key lifecycle details.
- kms_
key_ strversion_ id - The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation. Autonomous Database Serverless does not use key versions, hence is not applicable for Autonomous Database Serverless instances.
- lifecycle_
details str - Additional information about the current lifecycle state.
- local_
disaster_ strrecovery_ type - Indicates the local disaster recovery (DR) type of the Serverless Autonomous Database. Autonomous Data Guard (
ADG
) DR type provides business critical DR with a faster recovery time objective (RTO) during failover or switchover. Backup-based (BACKUP_BASED
) DR type provides lower cost DR with a slower RTO during failover or switchover. - local_
standby_ Sequence[database.dbs Autonomous Database Local Standby Db] - Autonomous Data Guard local (same region) standby database details.
- memory_
per_ intoracle_ compute_ unit_ in_ gbs - The amount of memory (in GBs) enabled per OCPU or ECPU. See Compute Models in Autonomous Database on Dedicated Exadata Infrastructure for more details. This parameter is not used for Autonomous database Serverless.
- net_
services_ strarchitecture - Enabling SHARED server architecture enables a database server to allow many client processes to share very few server processes, thereby increasing the number of supported users.
- next_
long_ strterm_ backup_ time_ stamp - The date and time when the next long-term backup would be created.
- peer_
db_ Sequence[str]ids - The list of OCIDs of standby databases located in Autonomous Data Guard remote regions that are associated with the source database. Note that for Autonomous Database Serverless instances, standby databases located in the same region as the source primary database do not have OCIDs.
- private_
endpoint str - The private endpoint for the resource. This parameter is not used in Autonomous Databases using Serverless infrastructure and Exadata Cloud@Customer infrastructure.
- provisionable_
cpuses Sequence[float] - An array of CPU values that an Autonomous Database can be scaled to.
- public_
connection_ Sequence[database.urls Autonomous Database Public Connection Url] - The Public URLs of Private Endpoint database for accessing Oracle Application Express (APEX) and SQL Developer Web with a browser from a Compute instance within your VCN or that has a direct connection to your VCN.
- public_
endpoint str - The public endpoint for the private endpoint enabled resource.
- refreshable_
status str - The refresh status of the clone. REFRESHING indicates that the clone is currently being refreshed with data from the source Autonomous Database.
- remote_
disaster_ Sequence[database.recovery_ configurations Autonomous Database Remote Disaster Recovery Configuration] - Configurations of a Disaster Recovery.
- role str
- The Data Guard role of the Autonomous Container Database or Autonomous Database, if Autonomous Data Guard is enabled.
- service_
console_ strurl - The URL of the Service Console for the Autonomous Database.
- standby_
dbs Sequence[database.Autonomous Database Standby Db] - Deprecated Autonomous Data Guard standby database details.
- supported_
regions_ Sequence[str]to_ clone_ tos - The list of regions that support the creation of an Autonomous Database clone or an Autonomous Data Guard standby database.
- Mapping[str, str]
- System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- time_
created str - The date and time the Autonomous Database was created.
- time_
data_ strguard_ role_ changed - The date and time the Autonomous Data Guard role was switched for the Autonomous Database. For databases that have standbys in both the primary Data Guard region and a remote Data Guard standby region, this is the latest timestamp of either the database using the "primary" role in the primary Data Guard region, or database located in the remote Data Guard standby region.
- time_
deletion_ strof_ free_ autonomous_ database - The date and time the Always Free database will be automatically deleted because of inactivity. If the database is in the STOPPED state and without activity until this time, it will be deleted.
- time_
disaster_ strrecovery_ role_ changed - The date and time the Disaster Recovery role was switched for the standby Autonomous Database.
- time_
local_ strdata_ guard_ enabled - The date and time that Autonomous Data Guard was enabled for an Autonomous Database where the standby was provisioned in the same region as the primary database.
- time_
maintenance_ strbegin - The date and time when maintenance will begin.
- time_
maintenance_ strend - The date and time when maintenance will end.
- time_
of_ strjoining_ resource_ pool - time_
of_ strlast_ failover - The timestamp of the last failover operation.
- time_
of_ strlast_ refresh - The date and time when last refresh happened.
- time_
of_ strlast_ refresh_ point - The refresh point timestamp (UTC). The refresh point is the time to which the database was most recently refreshed. Data created after the refresh point is not included in the refresh.
- time_
of_ strlast_ switchover - The timestamp of the last switchover operation for the Autonomous Database.
- time_
of_ strnext_ refresh - The date and time of next refresh.
- time_
reclamation_ strof_ free_ autonomous_ database - The date and time the Always Free database will be stopped because of inactivity. If this time is reached without any database activity, the database will automatically be put into the STOPPED state.
- time_
undeleted str - time_
until_ strreconnect_ clone_ enabled - The time and date as an RFC3339 formatted string, e.g., 2022-01-01T12:00:00.000Z, to set the limit for a refreshable clone to be reconnected to its source database.
- total_
backup_ floatstorage_ size_ in_ gbs - The backup storage to the database.
- used_
data_ intstorage_ size_ in_ gbs - The storage space consumed by Autonomous Database in GBs.
- used_
data_ intstorage_ size_ in_ tbs - The amount of storage that has been used, in terabytes.
- actual
Used NumberData Storage Size In Tbs - The current amount of storage in use for user and system data, in terabytes (TB).
- allocated
Storage NumberSize In Tbs - The amount of storage currently allocated for the database tables and billed for, rounded up. When auto-scaling is not enabled, this value is equal to the
dataStorageSizeInTBs
value. You can compare this value to theactualUsedDataStorageSizeInTBs
value to determine if a manual shrink operation is appropriate for your allocated storage. - apex
Details List<Property Map> - Information about Oracle APEX Application Development.
- availability
Domain String - The availability domain of a local Autonomous Data Guard standby database of an Autonomous Database Serverless instance.
- available
Upgrade List<String>Versions - List of Oracle Database versions available for a database upgrade. If there are no version upgrades available, this list is empty.
- backup
Configs List<Property Map> - Autonomous Database configuration details for storing manual backups in the Object Storage service.
- cluster
Placement StringGroup Id - The OCID of the cluster placement group of the Autonomous Serverless Database.
- connection
Strings List<Property Map> - The connection string used to connect to the Autonomous Database. The username for the Service Console is ADMIN. Use the password you entered when creating the Autonomous Database for the password value.
- connection
Urls List<Property Map> - The URLs for accessing Oracle Application Express (APEX) and SQL Developer Web with a browser from a Compute instance within your VCN or that has a direct connection to your VCN. Note that these URLs are provided by the console only for databases on dedicated Exadata infrastructure. Example:
{"sqlDevWebUrl": "https://<hostname>/ords...", "apexUrl", "https://<hostname>/ords..."}
- dataguard
Region StringType - Deprecated (Optional) The Autonomous Data Guard region type of the Autonomous Database. For Autonomous Database Serverless instances, Data Guard associations have designated primary (
PRIMARY_DG_REGION
) and standby (REMOTE_STANDBY_DG_REGION
) regions, and these region types do not change when the database changes roles. The standby regions in Data Guard associations can be the same region designated as the primary region, or they can be remote regions. Certain database administrative operations may be available only in the primary region of the Data Guard association, and cannot be performed when the database using the "primary" role is operating in a remote Data Guard standby region. - disaster
Recovery StringRegion Type - Deprecated The disaster recovery (DR) region type of the Autonomous Database. For Serverless Autonomous Databases, DR associations have designated primary (
PRIMARY
) and standby (REMOTE
) regions. These region types do not change when the database changes roles. The standby region in DR associations can be the same region as the primary region, or they can be in a remote regions. Some database administration operations may be available only in the primary region of the DR association, and cannot be performed when the database using the primary role is operating in a remote region. - encryption
Key List<Property Map>History Entries - Key History Entry.
- failed
Data NumberRecovery In Seconds - Indicates the number of seconds of data loss for a Data Guard failover.
- id String
- The provider-assigned unique ID for this managed resource.
- in
Memory NumberArea In Gbs - The area assigned to In-Memory tables in Autonomous Database.
- infrastructure
Type String - The infrastructure type this resource belongs to.
- is
Preview Boolean - Indicates if the Autonomous Database version is a preview version.
- is
Reconnect BooleanClone Enabled - Indicates if the refreshable clone can be reconnected to its source database.
- is
Remote BooleanData Guard Enabled - Indicates whether the Autonomous Database has Cross Region Data Guard enabled. It takes boolean values. Not applicable to Autonomous Databases using dedicated Exadata infrastructure or Exadata Cloud@Customer infrastructure.
- key
History List<Property Map>Entries - Key History Entry.
- key
Store StringId - The OCID of the key store of Oracle Vault. This is used in Autonomous Databases on Serverless instances and dedicated Exadata infrastructure.
- key
Store StringWallet Name - The wallet name for Oracle Key Vault.
- kms
Key StringLifecycle Details - KMS key lifecycle details.
- kms
Key StringVersion Id - The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation. Autonomous Database Serverless does not use key versions, hence is not applicable for Autonomous Database Serverless instances.
- lifecycle
Details String - Additional information about the current lifecycle state.
- local
Disaster StringRecovery Type - Indicates the local disaster recovery (DR) type of the Serverless Autonomous Database. Autonomous Data Guard (
ADG
) DR type provides business critical DR with a faster recovery time objective (RTO) during failover or switchover. Backup-based (BACKUP_BASED
) DR type provides lower cost DR with a slower RTO during failover or switchover. - local
Standby List<Property Map>Dbs - Autonomous Data Guard local (same region) standby database details.
- memory
Per NumberOracle Compute Unit In Gbs - The amount of memory (in GBs) enabled per OCPU or ECPU. See Compute Models in Autonomous Database on Dedicated Exadata Infrastructure for more details. This parameter is not used for Autonomous database Serverless.
- net
Services StringArchitecture - Enabling SHARED server architecture enables a database server to allow many client processes to share very few server processes, thereby increasing the number of supported users.
- next
Long StringTerm Backup Time Stamp - The date and time when the next long-term backup would be created.
- peer
Db List<String>Ids - The list of OCIDs of standby databases located in Autonomous Data Guard remote regions that are associated with the source database. Note that for Autonomous Database Serverless instances, standby databases located in the same region as the source primary database do not have OCIDs.
- private
Endpoint String - The private endpoint for the resource. This parameter is not used in Autonomous Databases using Serverless infrastructure and Exadata Cloud@Customer infrastructure.
- provisionable
Cpuses List<Number> - An array of CPU values that an Autonomous Database can be scaled to.
- public
Connection List<Property Map>Urls - The Public URLs of Private Endpoint database for accessing Oracle Application Express (APEX) and SQL Developer Web with a browser from a Compute instance within your VCN or that has a direct connection to your VCN.
- public
Endpoint String - The public endpoint for the private endpoint enabled resource.
- refreshable
Status String - The refresh status of the clone. REFRESHING indicates that the clone is currently being refreshed with data from the source Autonomous Database.
- remote
Disaster List<Property Map>Recovery Configurations - Configurations of a Disaster Recovery.
- role String
- The Data Guard role of the Autonomous Container Database or Autonomous Database, if Autonomous Data Guard is enabled.
- service
Console StringUrl - The URL of the Service Console for the Autonomous Database.
- standby
Dbs List<Property Map> - Deprecated Autonomous Data Guard standby database details.
- supported
Regions List<String>To Clone Tos - The list of regions that support the creation of an Autonomous Database clone or an Autonomous Data Guard standby database.
- Map<String>
- System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- time
Created String - The date and time the Autonomous Database was created.
- time
Data StringGuard Role Changed - The date and time the Autonomous Data Guard role was switched for the Autonomous Database. For databases that have standbys in both the primary Data Guard region and a remote Data Guard standby region, this is the latest timestamp of either the database using the "primary" role in the primary Data Guard region, or database located in the remote Data Guard standby region.
- time
Deletion StringOf Free Autonomous Database - The date and time the Always Free database will be automatically deleted because of inactivity. If the database is in the STOPPED state and without activity until this time, it will be deleted.
- time
Disaster StringRecovery Role Changed - The date and time the Disaster Recovery role was switched for the standby Autonomous Database.
- time
Local StringData Guard Enabled - The date and time that Autonomous Data Guard was enabled for an Autonomous Database where the standby was provisioned in the same region as the primary database.
- time
Maintenance StringBegin - The date and time when maintenance will begin.
- time
Maintenance StringEnd - The date and time when maintenance will end.
- time
Of StringJoining Resource Pool - time
Of StringLast Failover - The timestamp of the last failover operation.
- time
Of StringLast Refresh - The date and time when last refresh happened.
- time
Of StringLast Refresh Point - The refresh point timestamp (UTC). The refresh point is the time to which the database was most recently refreshed. Data created after the refresh point is not included in the refresh.
- time
Of StringLast Switchover - The timestamp of the last switchover operation for the Autonomous Database.
- time
Of StringNext Refresh - The date and time of next refresh.
- time
Reclamation StringOf Free Autonomous Database - The date and time the Always Free database will be stopped because of inactivity. If this time is reached without any database activity, the database will automatically be put into the STOPPED state.
- time
Undeleted String - time
Until StringReconnect Clone Enabled - The time and date as an RFC3339 formatted string, e.g., 2022-01-01T12:00:00.000Z, to set the limit for a refreshable clone to be reconnected to its source database.
- total
Backup NumberStorage Size In Gbs - The backup storage to the database.
- used
Data NumberStorage Size In Gbs - The storage space consumed by Autonomous Database in GBs.
- used
Data NumberStorage Size In Tbs - The amount of storage that has been used, in terabytes.
Look up Existing AutonomousDatabase Resource
Get an existing AutonomousDatabase resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: AutonomousDatabaseState, opts?: CustomResourceOptions): AutonomousDatabase
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
actual_used_data_storage_size_in_tbs: Optional[float] = None,
admin_password: Optional[str] = None,
allocated_storage_size_in_tbs: Optional[float] = None,
apex_details: Optional[Sequence[_database.AutonomousDatabaseApexDetailArgs]] = None,
are_primary_whitelisted_ips_used: Optional[bool] = None,
auto_refresh_frequency_in_seconds: Optional[int] = None,
auto_refresh_point_lag_in_seconds: Optional[int] = None,
autonomous_container_database_id: Optional[str] = None,
autonomous_database_backup_id: Optional[str] = None,
autonomous_database_id: Optional[str] = None,
autonomous_maintenance_schedule_type: Optional[str] = None,
availability_domain: Optional[str] = None,
available_upgrade_versions: Optional[Sequence[str]] = None,
backup_configs: Optional[Sequence[_database.AutonomousDatabaseBackupConfigArgs]] = None,
backup_retention_period_in_days: Optional[int] = None,
byol_compute_count_limit: Optional[float] = None,
character_set: Optional[str] = None,
clone_type: Optional[str] = None,
cluster_placement_group_id: Optional[str] = None,
compartment_id: Optional[str] = None,
compute_count: Optional[float] = None,
compute_model: Optional[str] = None,
connection_strings: Optional[Sequence[_database.AutonomousDatabaseConnectionStringArgs]] = None,
connection_urls: Optional[Sequence[_database.AutonomousDatabaseConnectionUrlArgs]] = None,
cpu_core_count: Optional[int] = None,
customer_contacts: Optional[Sequence[_database.AutonomousDatabaseCustomerContactArgs]] = None,
data_safe_status: Optional[str] = None,
data_storage_size_in_gb: Optional[int] = None,
data_storage_size_in_tbs: Optional[int] = None,
database_edition: Optional[str] = None,
database_management_status: Optional[str] = None,
dataguard_region_type: Optional[str] = None,
db_name: Optional[str] = None,
db_tools_details: Optional[Sequence[_database.AutonomousDatabaseDbToolsDetailArgs]] = None,
db_version: Optional[str] = None,
db_workload: Optional[str] = None,
defined_tags: Optional[Mapping[str, str]] = None,
disaster_recovery_region_type: Optional[str] = None,
disaster_recovery_type: Optional[str] = None,
display_name: Optional[str] = None,
encryption_key: Optional[_database.AutonomousDatabaseEncryptionKeyArgs] = None,
encryption_key_history_entries: Optional[Sequence[_database.AutonomousDatabaseEncryptionKeyHistoryEntryArgs]] = None,
failed_data_recovery_in_seconds: Optional[int] = None,
freeform_tags: Optional[Mapping[str, str]] = None,
in_memory_area_in_gbs: Optional[int] = None,
in_memory_percentage: Optional[int] = None,
infrastructure_type: Optional[str] = None,
is_access_control_enabled: Optional[bool] = None,
is_auto_scaling_enabled: Optional[bool] = None,
is_auto_scaling_for_storage_enabled: Optional[bool] = None,
is_data_guard_enabled: Optional[bool] = None,
is_dedicated: Optional[bool] = None,
is_dev_tier: Optional[bool] = None,
is_free_tier: Optional[bool] = None,
is_local_data_guard_enabled: Optional[bool] = None,
is_mtls_connection_required: Optional[bool] = None,
is_preview: Optional[bool] = None,
is_preview_version_with_service_terms_accepted: Optional[bool] = None,
is_reconnect_clone_enabled: Optional[bool] = None,
is_refreshable_clone: Optional[bool] = None,
is_remote_data_guard_enabled: Optional[bool] = None,
is_replicate_automatic_backups: Optional[bool] = None,
is_shrink_only: Optional[bool] = None,
key_history_entries: Optional[Sequence[_database.AutonomousDatabaseKeyHistoryEntryArgs]] = None,
key_store_id: Optional[str] = None,
key_store_wallet_name: Optional[str] = None,
key_version_id: Optional[str] = None,
kms_key_id: Optional[str] = None,
kms_key_lifecycle_details: Optional[str] = None,
kms_key_version_id: Optional[str] = None,
license_model: Optional[str] = None,
lifecycle_details: Optional[str] = None,
local_adg_auto_failover_max_data_loss_limit: Optional[int] = None,
local_disaster_recovery_type: Optional[str] = None,
local_standby_dbs: Optional[Sequence[_database.AutonomousDatabaseLocalStandbyDbArgs]] = None,
long_term_backup_schedules: Optional[Sequence[_database.AutonomousDatabaseLongTermBackupScheduleArgs]] = None,
max_cpu_core_count: Optional[int] = None,
memory_per_oracle_compute_unit_in_gbs: Optional[int] = None,
ncharacter_set: Optional[str] = None,
net_services_architecture: Optional[str] = None,
next_long_term_backup_time_stamp: Optional[str] = None,
nsg_ids: Optional[Sequence[str]] = None,
ocpu_count: Optional[float] = None,
open_mode: Optional[str] = None,
operations_insights_status: Optional[str] = None,
peer_db_ids: Optional[Sequence[str]] = None,
permission_level: Optional[str] = None,
private_endpoint: Optional[str] = None,
private_endpoint_ip: Optional[str] = None,
private_endpoint_label: Optional[str] = None,
provisionable_cpuses: Optional[Sequence[float]] = None,
public_connection_urls: Optional[Sequence[_database.AutonomousDatabasePublicConnectionUrlArgs]] = None,
public_endpoint: Optional[str] = None,
refreshable_mode: Optional[str] = None,
refreshable_status: Optional[str] = None,
remote_disaster_recovery_configurations: Optional[Sequence[_database.AutonomousDatabaseRemoteDisasterRecoveryConfigurationArgs]] = None,
remote_disaster_recovery_type: Optional[str] = None,
resource_pool_leader_id: Optional[str] = None,
resource_pool_summary: Optional[_database.AutonomousDatabaseResourcePoolSummaryArgs] = None,
role: Optional[str] = None,
rotate_key_trigger: Optional[bool] = None,
scheduled_operations: Optional[Sequence[_database.AutonomousDatabaseScheduledOperationArgs]] = None,
secret_id: Optional[str] = None,
secret_version_number: Optional[int] = None,
security_attributes: Optional[Mapping[str, str]] = None,
service_console_url: Optional[str] = None,
shrink_adb_trigger: Optional[int] = None,
source: Optional[str] = None,
source_id: Optional[str] = None,
standby_dbs: Optional[Sequence[_database.AutonomousDatabaseStandbyDbArgs]] = None,
standby_whitelisted_ips: Optional[Sequence[str]] = None,
state: Optional[str] = None,
subnet_id: Optional[str] = None,
subscription_id: Optional[str] = None,
supported_regions_to_clone_tos: Optional[Sequence[str]] = None,
switchover_to: Optional[str] = None,
switchover_to_remote_peer_id: Optional[str] = None,
system_tags: Optional[Mapping[str, str]] = None,
time_created: Optional[str] = None,
time_data_guard_role_changed: Optional[str] = None,
time_deletion_of_free_autonomous_database: Optional[str] = None,
time_disaster_recovery_role_changed: Optional[str] = None,
time_local_data_guard_enabled: Optional[str] = None,
time_maintenance_begin: Optional[str] = None,
time_maintenance_end: Optional[str] = None,
time_of_auto_refresh_start: Optional[str] = None,
time_of_joining_resource_pool: Optional[str] = None,
time_of_last_failover: Optional[str] = None,
time_of_last_refresh: Optional[str] = None,
time_of_last_refresh_point: Optional[str] = None,
time_of_last_switchover: Optional[str] = None,
time_of_next_refresh: Optional[str] = None,
time_reclamation_of_free_autonomous_database: Optional[str] = None,
time_undeleted: Optional[str] = None,
time_until_reconnect_clone_enabled: Optional[str] = None,
timestamp: Optional[str] = None,
total_backup_storage_size_in_gbs: Optional[float] = None,
use_latest_available_backup_time_stamp: Optional[bool] = None,
used_data_storage_size_in_gbs: Optional[int] = None,
used_data_storage_size_in_tbs: Optional[int] = None,
vault_id: Optional[str] = None,
whitelisted_ips: Optional[Sequence[str]] = None) -> AutonomousDatabase
func GetAutonomousDatabase(ctx *Context, name string, id IDInput, state *AutonomousDatabaseState, opts ...ResourceOption) (*AutonomousDatabase, error)
public static AutonomousDatabase Get(string name, Input<string> id, AutonomousDatabaseState? state, CustomResourceOptions? opts = null)
public static AutonomousDatabase get(String name, Output<String> id, AutonomousDatabaseState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Actual
Used doubleData Storage Size In Tbs - The current amount of storage in use for user and system data, in terabytes (TB).
- Admin
Password string - (Updatable) The password must be between 12 and 30 characters long, and must contain at least 1 uppercase, 1 lowercase, and 1 numeric character. It cannot contain the double quote symbol (") or the username "admin", regardless of casing. The password is mandatory if source value is "BACKUP_FROM_ID", "BACKUP_FROM_TIMESTAMP", "DATABASE" or "NONE".
- Allocated
Storage doubleSize In Tbs - The amount of storage currently allocated for the database tables and billed for, rounded up. When auto-scaling is not enabled, this value is equal to the
dataStorageSizeInTBs
value. You can compare this value to theactualUsedDataStorageSizeInTBs
value to determine if a manual shrink operation is appropriate for your allocated storage. - Apex
Details List<AutonomousDatabase Apex Detail> - Information about Oracle APEX Application Development.
- Are
Primary boolWhitelisted Ips Used - (Updatable) This field will be null if the Autonomous Database is not Data Guard enabled or Access Control is disabled. It's value would be
TRUE
if Autonomous Database is Data Guard enabled and Access Control is enabled and if the Autonomous Database uses primary IP access control list (ACL) for standby. It's value would beFALSE
if Autonomous Database is Data Guard enabled and Access Control is enabled and if the Autonomous Database uses different IP access control list (ACL) for standby compared to primary. - Auto
Refresh intFrequency In Seconds - (Updatable) The frequency a refreshable clone is refreshed after auto-refresh is enabled. The minimum is 1 hour. The maximum is 7 days. The date and time that auto-refresh is enabled is controlled by the
timeOfAutoRefreshStart
parameter. - Auto
Refresh intPoint Lag In Seconds - (Updatable) The time, in seconds, the data of the refreshable clone lags the primary database at the point of refresh. The minimum is 0 minutes (0 mins means refresh to the latest available timestamp). The maximum is 7 days. The lag time increases after refreshing until the next data refresh happens.
- Autonomous
Container stringDatabase Id - The Autonomous Container Database OCID.
- Autonomous
Database stringBackup Id - The OCID of the source Autonomous Database Backup that you will clone to create a new Autonomous Database.
- Autonomous
Database stringId - The OCID of the source Autonomous Database that you will clone to create a new Autonomous Database.
- Autonomous
Maintenance stringSchedule Type - The maintenance schedule type of the Autonomous Database Serverless instances. The EARLY maintenance schedule of this Autonomous Database follows a schedule that applies patches prior to the REGULAR schedule.The REGULAR maintenance schedule of this Autonomous Database follows the normal cycle.
- Availability
Domain string - The availability domain of a local Autonomous Data Guard standby database of an Autonomous Database Serverless instance.
- Available
Upgrade List<string>Versions - List of Oracle Database versions available for a database upgrade. If there are no version upgrades available, this list is empty.
- Backup
Configs List<AutonomousDatabase Backup Config> - Autonomous Database configuration details for storing manual backups in the Object Storage service.
- Backup
Retention intPeriod In Days - (Updatable) Retention period, in days, for backups.
- Byol
Compute doubleCount Limit - Character
Set string The character set for the autonomous database. The default is AL32UTF8. Allowed values for an Autonomous Database on Serverless infrastructure as returned by List Autonomous Database Character Sets
For an Autonomous Database on dedicated infrastructure, the allowed values are:
AL32UTF8, AR8ADOS710, AR8ADOS720, AR8APTEC715, AR8ARABICMACS, AR8ASMO8X, AR8ISO8859P6, AR8MSWIN1256, AR8MUSSAD768, AR8NAFITHA711, AR8NAFITHA721, AR8SAKHR706, AR8SAKHR707, AZ8ISO8859P9E, BG8MSWIN, BG8PC437S, BLT8CP921, BLT8ISO8859P13, BLT8MSWIN1257, BLT8PC775, BN8BSCII, CDN8PC863, CEL8ISO8859P14, CL8ISO8859P5, CL8ISOIR111, CL8KOI8R, CL8KOI8U, CL8MACCYRILLICS, CL8MSWIN1251, EE8ISO8859P2, EE8MACCES, EE8MACCROATIANS, EE8MSWIN1250, EE8PC852, EL8DEC, EL8ISO8859P7, EL8MACGREEKS, EL8MSWIN1253, EL8PC437S, EL8PC851, EL8PC869, ET8MSWIN923, HU8ABMOD, HU8CWI2, IN8ISCII, IS8PC861, IW8ISO8859P8, IW8MACHEBREWS, IW8MSWIN1255, IW8PC1507, JA16EUC, JA16EUCTILDE, JA16SJIS, JA16SJISTILDE, JA16VMS, KO16KSC5601, KO16KSCCS, KO16MSWIN949, LA8ISO6937, LA8PASSPORT, LT8MSWIN921, LT8PC772, LT8PC774, LV8PC1117, LV8PC8LR, LV8RST104090, N8PC865, NE8ISO8859P10, NEE8ISO8859P4, RU8BESTA, RU8PC855, RU8PC866, SE8ISO8859P3, TH8MACTHAIS, TH8TISASCII, TR8DEC, TR8MACTURKISHS, TR8MSWIN1254, TR8PC857, US7ASCII, US8PC437, UTF8, VN8MSWIN1258, VN8VN3, WE8DEC, WE8DG, WE8ISO8859P1, WE8ISO8859P15, WE8ISO8859P9, WE8MACROMAN8S, WE8MSWIN1252, WE8NCR4970, WE8NEXTSTEP, WE8PC850, WE8PC858, WE8PC860, WE8ROMAN8, ZHS16CGB231280, ZHS16GBK, ZHT16BIG5, ZHT16CCDC, ZHT16DBT, ZHT16HKSCS, ZHT16MSWIN950, ZHT32EUC, ZHT32SOPS, ZHT32TRIS
- Clone
Type string - The Autonomous Database clone type. This parameter is not used to create a refreshable clone type, and for refreshable clones one must use the (source=CLONE_TO_REFRESHABLE) parameter.
FULL
- This option creates a new database that includes all source database data.METADATA
- This option creates a new database that includes the source database schema and select metadata, but not the source database data.
- Cluster
Placement stringGroup Id - The OCID of the cluster placement group of the Autonomous Serverless Database.
- Compartment
Id string - (Updatable) The OCID of the compartment of the Autonomous Database.
- Compute
Count double - (Updatable) The compute amount available to the database. Minimum and maximum values depend on the compute model and whether the database is an Autonomous Database Serverless instance or an Autonomous Database on Dedicated Exadata Infrastructure. For an Autonomous Database Serverless instance, the 'ECPU' compute model requires a minimum value of one, for databases in the elastic resource pool and minimum value of two, otherwise. Required when using the
computeModel
parameter. When usingcpuCoreCount
parameter, it is an error to specify computeCount to a non-null value. ProvidingcomputeModel
andcomputeCount
is the preferred method for both OCPU and ECPU. - Compute
Model string - (Updatable) The compute model of the Autonomous Database. This is required if using the
computeCount
parameter. If usingcpuCoreCount
then it is an error to specifycomputeModel
to a non-null value. ECPU compute model is the recommended model and OCPU compute model is legacy. - Connection
Strings List<AutonomousDatabase Connection String> - The connection string used to connect to the Autonomous Database. The username for the Service Console is ADMIN. Use the password you entered when creating the Autonomous Database for the password value.
- Connection
Urls List<AutonomousDatabase Connection Url> - The URLs for accessing Oracle Application Express (APEX) and SQL Developer Web with a browser from a Compute instance within your VCN or that has a direct connection to your VCN. Note that these URLs are provided by the console only for databases on dedicated Exadata infrastructure. Example:
{"sqlDevWebUrl": "https://<hostname>/ords...", "apexUrl", "https://<hostname>/ords..."}
- Cpu
Core intCount - (Updatable) The number of CPU cores to be made available to the database. For Autonomous Databases on dedicated Exadata infrastructure, the maximum number of cores is determined by the infrastructure shape. See Characteristics of Infrastructure Shapes for shape details.
Note: This parameter cannot be used with the
ocpuCount
parameter. This input is ignored for Always Free resources.- The data type must be an integer.
- The minimum number of cores for all types of autonomous database is 1
- The maximum number of cores is as follows:
- Autonomous Database Serverless instances: The maximum number of cores is 128.
- Autonomous Databases on dedicated Exadata infrastructure: The maximum number of cores is determined by the infrastructure shape. See Characteristics of Infrastructure Shapes for shape details.
- Providing
computeModel
andcomputeCount
is the preferred method for setting CPUs for both OCPU and ECPU.
- Customer
Contacts List<AutonomousDatabase Customer Contact> - (Updatable) Customer Contacts.
- Data
Safe stringStatus - (Updatable) Status of the Data Safe registration for this Autonomous Database. Could be REGISTERED or NOT_REGISTERED.
- Data
Storage intSize In Gb (Updatable) The size, in gigabytes, of the data volume that will be created and attached to the database. This storage can later be scaled up if needed. The maximum storage value is determined by the infrastructure shape. See Characteristics of Infrastructure Shapes for shape details.
Notes
- This parameter is only supported for dedicated Exadata infrastructure.
- This parameter cannot be used with the
dataStorageSizeInTBs
parameter.
- Data
Storage intSize In Tbs (Updatable) The size, in terabytes, of the data volume that will be created and attached to the database. This storage can later be scaled up if needed. For Autonomous Databases on dedicated Exadata infrastructure, the maximum storage value is determined by the infrastructure shape. See Characteristics of Infrastructure Shapes for shape details. A full Exadata service is allocated when the Autonomous Database size is set to the upper limit (384 TB).
Note: This parameter cannot be used with the
dataStorageSizeInGBs
parameter. This input is ignored for Always Free resources.- Database
Edition string - (Updatable) The Oracle Database Edition that applies to the Autonomous databases. It can be set to
ENTERPRISE_EDITION
orSTANDARD_EDITION
. - Database
Management stringStatus - Status of Database Management for this Autonomous Database.
- Dataguard
Region stringType - Deprecated (Optional) The Autonomous Data Guard region type of the Autonomous Database. For Autonomous Database Serverless instances, Data Guard associations have designated primary (
PRIMARY_DG_REGION
) and standby (REMOTE_STANDBY_DG_REGION
) regions, and these region types do not change when the database changes roles. The standby regions in Data Guard associations can be the same region designated as the primary region, or they can be remote regions. Certain database administrative operations may be available only in the primary region of the Data Guard association, and cannot be performed when the database using the "primary" role is operating in a remote Data Guard standby region. - Db
Name string - The database name. The name must begin with an alphabetic character and can contain a maximum of 14 alphanumeric characters. Special characters are not permitted. The database name must be unique in the tenancy. It is required in all cases except when creating a cross-region Autonomous Data Guard standby instance or a cross-region disaster recovery standby instance.
- Db
Tools List<AutonomousDetails Database Db Tools Detail> (Updatable) The list of database tools details.
This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, whitelistedIps, isMTLSConnectionRequired, openMode, permissionLevel, dbWorkload, privateEndpointLabel, nsgIds, dbVersion, isRefreshable, dbName, scheduledOperations, isLocalDataGuardEnabled, or isFreeTier.
- Db
Version string - (Updatable) A valid Oracle Database version for Autonomous Database.
db_workload
AJD and APEX are only supported fordb_version
19c
and above. - Db
Workload string (Updatable) The Autonomous Database workload type. The following values are valid:
- OLTP - indicates an Autonomous Transaction Processing database
- DW - indicates an Autonomous Data Warehouse database
- AJD - indicates an Autonomous JSON Database
- APEX - indicates an Autonomous Database with the Oracle APEX Application Development workload type.
This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, isMTLSConnectionRequired, privateEndpointLabel, nsgIds, dbVersion, isRefreshable, dbName, scheduledOperations, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier. *Note:
db_workload
can only be updated from AJD to OLTP or from a free OLTP to AJD.- Dictionary<string, string>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- Disaster
Recovery stringRegion Type - Deprecated The disaster recovery (DR) region type of the Autonomous Database. For Serverless Autonomous Databases, DR associations have designated primary (
PRIMARY
) and standby (REMOTE
) regions. These region types do not change when the database changes roles. The standby region in DR associations can be the same region as the primary region, or they can be in a remote regions. Some database administration operations may be available only in the primary region of the DR association, and cannot be performed when the database using the primary role is operating in a remote region. - Disaster
Recovery stringType - Indicates the disaster recovery (DR) type of the standby Autonomous Database Serverless instance. Autonomous Data Guard (ADG) DR type provides business critical DR with a faster recovery time objective (RTO) during failover or switchover. Backup-based DR type provides lower cost DR with a slower RTO during failover or switchover.
- Display
Name string - (Updatable) The user-friendly name for the Autonomous Database. The name does not have to be unique.
- Encryption
Key AutonomousDatabase Encryption Key - (Updatable) Details of the Autonomous Database encryption key.
- Encryption
Key List<AutonomousHistory Entries Database Encryption Key History Entry> - Key History Entry.
- Failed
Data intRecovery In Seconds - Indicates the number of seconds of data loss for a Data Guard failover.
- Dictionary<string, string>
- (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example:
{"Department": "Finance"}
- In
Memory intArea In Gbs - The area assigned to In-Memory tables in Autonomous Database.
- In
Memory intPercentage - (Updatable) The percentage of the System Global Area(SGA) assigned to In-Memory tables in Autonomous Database. This property is applicable only to Autonomous Databases on the Exadata Cloud@Customer platform.
- Infrastructure
Type string - The infrastructure type this resource belongs to.
- Is
Access boolControl Enabled (Updatable) Indicates if the database-level access control is enabled. If disabled, database access is defined by the network security rules. If enabled, database access is restricted to the IP addresses defined by the rules specified with the
whitelistedIps
property. While specifyingwhitelistedIps
rules is optional, if database-level access control is enabled and no rules are specified, the database will become inaccessible. The rules can be added later using theUpdateAutonomousDatabase
API operation or edit option in console. When creating a database clone, the desired access control setting should be specified. By default, database-level access control will be disabled for the clone.This property is applicable only to Autonomous Databases on the Exadata Cloud@Customer platform. For Autonomous Database Serverless instances,
whitelistedIps
is used.- Is
Auto boolScaling Enabled - (Updatable) Indicates if auto scaling is enabled for the Autonomous Database CPU core count. The default value is
TRUE
. - Is
Auto boolScaling For Storage Enabled - (Updatable) Indicates if auto scaling is enabled for the Autonomous Database storage. The default value is
FALSE
. - Is
Data boolGuard Enabled - (Updatable) Deprecated. Indicates whether the Autonomous Database has local (in-region) Data Guard enabled. Not applicable to cross-region Autonomous Data Guard associations, or to Autonomous Databases using dedicated Exadata infrastructure or Exadata Cloud@Customer infrastructure.
- Is
Dedicated bool - True if the database is on dedicated Exadata infrastructure.
- Is
Dev boolTier - (Updatable) Autonomous Database for Developers are free Autonomous Databases that developers can use to build and test new applications.With Autonomous these database instancess instances, you can try new Autonomous Database features for free and apply them to ongoing or new development projects. Developer database comes with limited resources and is, therefore, not suitable for large-scale testing and production deployments. When you need more compute or storage resources, you can transition to a paid database licensing by cloning your developer database into a regular Autonomous Database. See Autonomous Database documentation for more details.
- Is
Free boolTier - (Updatable) Indicates if this is an Always Free resource. The default value is false. Note that Always Free Autonomous Databases have 1 CPU and 20GB of memory. For Always Free databases, memory and CPU cannot be scaled. When
db_workload
isAJD
orAPEX
it cannot betrue
. - Is
Local boolData Guard Enabled - (Updatable) Indicates whether the Autonomous Database has local (in-region) Data Guard enabled. It takes boolean values. Not applicable to cross-region Autonomous Data Guard associations, or to Autonomous Databases using dedicated Exadata infrastructure or Exadata Cloud@Customer infrastructure.
- Is
Mtls boolConnection Required - (Updatable) Indicates whether the Autonomous Database requires mTLS connections.
- Is
Preview bool - Indicates if the Autonomous Database version is a preview version.
- Is
Preview boolVersion With Service Terms Accepted - If set to
TRUE
, indicates that an Autonomous Database preview version is being provisioned, and that the preview version's terms of service have been accepted. Note that preview version software is only available for databases on Autonomous Database Serverless. - Is
Reconnect boolClone Enabled - Indicates if the refreshable clone can be reconnected to its source database.
- Is
Refreshable boolClone - (Updatable) True for creating a refreshable clone and False for detaching the clone from source Autonomous Database. Detaching is one time operation and clone becomes a regular Autonomous Database.
- Is
Remote boolData Guard Enabled - Indicates whether the Autonomous Database has Cross Region Data Guard enabled. It takes boolean values. Not applicable to Autonomous Databases using dedicated Exadata infrastructure or Exadata Cloud@Customer infrastructure.
- Is
Replicate boolAutomatic Backups - If true, 7 days worth of backups are replicated across regions for Cross-Region ADB or Backup-Based DR between Primary and Standby. If false, the backups taken on the Primary are not replicated to the Standby database.
- Is
Shrink boolOnly (Updatable) An optional property when enabled triggers the Shrinking of Autonomous Database once. To trigger Shrinking of ADB once again, this flag needs to be disabled and re-enabled again. It should not be passed during create database operation. It is only applicable on Serverless databases i.e. where
is_dedicated
is false.** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- Key
History List<AutonomousEntries Database Key History Entry> - Key History Entry.
- Key
Store stringId - The OCID of the key store of Oracle Vault. This is used in Autonomous Databases on Serverless instances and dedicated Exadata infrastructure.
- Key
Store stringWallet Name - The wallet name for Oracle Key Vault.
- Key
Version stringId - The OCID of the key version that is used in rotate key operations.
- Kms
Key stringId - The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
- Kms
Key stringLifecycle Details - KMS key lifecycle details.
- Kms
Key stringVersion Id - The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation. Autonomous Database Serverless does not use key versions, hence is not applicable for Autonomous Database Serverless instances.
- License
Model string - (Updatable) The Oracle license model that applies to the Oracle Autonomous Database. Bring your own license (BYOL) allows you to apply your current on-premises Oracle software licenses to equivalent, highly automated Oracle PaaS and IaaS services in the cloud. License Included allows you to subscribe to new Oracle Database software licenses and the Database service. Note that when provisioning an Autonomous Database on dedicated Exadata infrastructure, this attribute must be null because the attribute is already set at the Autonomous Exadata Infrastructure level. When using shared Exadata infrastructure, if a value is not specified, the system will supply the value of
BRING_YOUR_OWN_LICENSE
. It is a required field whendb_workload
is AJD and needs to be set toLICENSE_INCLUDED
as AJD does not support defaultlicense_model
valueBRING_YOUR_OWN_LICENSE
. - Lifecycle
Details string - Additional information about the current lifecycle state.
- Local
Adg intAuto Failover Max Data Loss Limit - Parameter that allows users to select an acceptable maximum data loss limit in seconds, up to which Automatic Failover will be triggered when necessary for a Local Autonomous Data Guard
- Local
Disaster stringRecovery Type - Indicates the local disaster recovery (DR) type of the Serverless Autonomous Database. Autonomous Data Guard (
ADG
) DR type provides business critical DR with a faster recovery time objective (RTO) during failover or switchover. Backup-based (BACKUP_BASED
) DR type provides lower cost DR with a slower RTO during failover or switchover. - Local
Standby List<AutonomousDbs Database Local Standby Db> - Autonomous Data Guard local (same region) standby database details.
- Long
Term List<AutonomousBackup Schedules Database Long Term Backup Schedule> - Details for the long-term backup schedule.
- Max
Cpu intCore Count - (Updatable) Deprecated. The number of Max OCPU cores to be made available to the autonomous database with auto scaling of cpu enabled.
- Memory
Per intOracle Compute Unit In Gbs - The amount of memory (in GBs) enabled per OCPU or ECPU. See Compute Models in Autonomous Database on Dedicated Exadata Infrastructure for more details. This parameter is not used for Autonomous database Serverless.
- Ncharacter
Set string - The national character set for the autonomous database. The default is AL16UTF16. Allowed values are: AL16UTF16 or UTF8.
- Net
Services stringArchitecture - Enabling SHARED server architecture enables a database server to allow many client processes to share very few server processes, thereby increasing the number of supported users.
- Next
Long stringTerm Backup Time Stamp - The date and time when the next long-term backup would be created.
- Nsg
Ids List<string> - (Updatable) The list of OCIDs for the network security groups (NSGs) to which this resource belongs. Setting this to an empty list removes all resources from all NSGs. For more information about NSGs, see Security Rules. NsgIds restrictions:
- A network security group (NSG) is optional for Autonomous Databases with private access. The nsgIds list can be empty.
- Ocpu
Count double (Updatable) The number of OCPU cores to be made available to the database.
- Providing
computeModel
andcomputeCount
is the preferred method for setting CPUs for both OCPU and ECPU. The following points apply: - For Autonomous Databases on dedicated Exadata infrastructure, to provision less than 1 core, enter a fractional value in an increment of 0.1. For example, you can provision 0.3 or 0.4 cores, but not 0.35 cores. (Note that fractional OCPU values are not supported for Autonomous Databasese on shared Exadata infrastructure.)
- To provision 1 or more cores, you must enter an integer between 1 and the maximum number of cores available for the infrastructure shape. For example, you can provision 2 cores or 3 cores, but not 2.5 cores. This applies to Autonomous Databases on both shared and dedicated Exadata infrastructure.
For Autonomous Databases on dedicated Exadata infrastructure, the maximum number of cores is determined by the infrastructure shape. See Characteristics of Infrastructure Shapes for shape details.
Note: This parameter cannot be used with the
cpuCoreCount
parameter.- Providing
- Open
Mode string - Indicates the Autonomous Database mode. The database can be opened in
READ_ONLY
orREAD_WRITE
mode. - Operations
Insights stringStatus - (Updatable) Status of Operations Insights for this Autonomous Database. Values supported are
ENABLED
andNOT_ENABLED
- Peer
Db List<string>Ids - The list of OCIDs of standby databases located in Autonomous Data Guard remote regions that are associated with the source database. Note that for Autonomous Database Serverless instances, standby databases located in the same region as the source primary database do not have OCIDs.
- Permission
Level string - The Autonomous Database permission level. Restricted mode allows access only by admin users.
- Private
Endpoint string - The private endpoint for the resource. This parameter is not used in Autonomous Databases using Serverless infrastructure and Exadata Cloud@Customer infrastructure.
- Private
Endpoint stringIp - The private endpoint Ip address for the resource.
- Private
Endpoint stringLabel - (Updatable) (Optional) (Updatable) The resource's private endpoint label.
- Setting the endpoint label to a non-empty string creates a private endpoint database.
- Resetting the endpoint label to an empty string, after the creation of the private endpoint database, changes the private endpoint database to a public endpoint database.
- Setting the endpoint label to a non-empty string value, updates to a new private endpoint database, when the database is disabled and re-enabled.
- Provisionable
Cpuses List<double> - An array of CPU values that an Autonomous Database can be scaled to.
- Public
Connection List<AutonomousUrls Database Public Connection Url> - The Public URLs of Private Endpoint database for accessing Oracle Application Express (APEX) and SQL Developer Web with a browser from a Compute instance within your VCN or that has a direct connection to your VCN.
- Public
Endpoint string - The public endpoint for the private endpoint enabled resource.
- Refreshable
Mode string - (Updatable) The refresh mode of the clone. AUTOMATIC indicates that the clone is automatically being refreshed with data from the source Autonomous Database.
- Refreshable
Status string - The refresh status of the clone. REFRESHING indicates that the clone is currently being refreshed with data from the source Autonomous Database.
- Remote
Disaster List<AutonomousRecovery Configurations Database Remote Disaster Recovery Configuration> - Configurations of a Disaster Recovery.
- Remote
Disaster stringRecovery Type - Indicates the cross-region disaster recovery (DR) type of the standby Autonomous Database Serverless instance. Autonomous Data Guard (ADG) DR type provides business critical DR with a faster recovery time objective (RTO) during failover or switchover. Backup-based DR type provides lower cost DR with a slower RTO during failover or switchover.
- Resource
Pool stringLeader Id - (Updatable) The unique identifier for leader autonomous database OCID OCID.
- Resource
Pool AutonomousSummary Database Resource Pool Summary - (Updatable) The configuration details for resource pool
- Role string
- The Data Guard role of the Autonomous Container Database or Autonomous Database, if Autonomous Data Guard is enabled.
- Rotate
Key boolTrigger - (Updatable) An optional property when flipped triggers rotation of KMS key. It is only applicable on dedicated databases i.e. where
is_dedicated
is true. - Scheduled
Operations List<AutonomousDatabase Scheduled Operation> (Updatable) The list of scheduled operations. Consists of values such as dayOfWeek, scheduledStartTime, scheduledStopTime.
This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, whitelistedIps, isMTLSConnectionRequired, openMode, permissionLevel, dbWorkload, privateEndpointLabel, nsgIds, dbVersion, isRefreshable, dbName, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier.
- Secret
Id string (Updatable) The Oracle Cloud Infrastructure vault secret [/Content/General/Concepts/identifiers.htm]OCID.
This cannot be used in conjunction with adminPassword.
- Secret
Version intNumber - (Updatable) The version of the vault secret. If no version is specified, the latest version will be used.
- Security
Attributes Dictionary<string, string> - (Updatable) Security Attributes for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "audit"}}}
- Service
Console stringUrl - The URL of the Service Console for the Autonomous Database.
- Shrink
Adb intTrigger - Source string
The source of the database:
- Use
NONE
for creating a new Autonomous Database. - Use
DATABASE
for creating a new Autonomous Database by cloning an existing running Autonomous Database from the latest timestamp, also provide the source database OCID in thesource_id
parameter. - Use
CROSS_REGION_DATAGUARD
to create a standby Data Guard database in another region, also provide the remote primary database OCID in thesource_id
parameter. - Use
CLONE_TO_REFRESHABLE
for creating a refreshable clone.
For Autonomous Database Serverless instances, the following cloning options are available:
- Use
BACKUP_FROM_ID
for creating a new Autonomous Database by cloning from a specified backup. Also provide the backup OCID in theautonomous_database_backup_id
parameter. - Use
BACKUP_FROM_TIMESTAMP
for creating a point-in-time Autonomous Database clone using backups. Also provide the backup timestamp in thetimestamp
parameter. For more information, see Cloning and Moving an Autonomous Database.
- Use
- Source
Id string - The OCID of the source Autonomous Database that will be used to create a new standby database for the Data Guard association.
- Standby
Dbs List<AutonomousDatabase Standby Db> - Deprecated Autonomous Data Guard standby database details.
- Standby
Whitelisted List<string>Ips (Updatable) The client IP access control list (ACL). This feature is available for [Autonomous Database Serverless] (https://docs.oracle.com/en/cloud/paas/autonomous-database/index.html) and on Exadata Cloud@Customer. Only clients connecting from an IP address included in the ACL may access the Autonomous Database instance. If
arePrimaryWhitelistedIpsUsed
is 'TRUE' then Autonomous Database uses this primary's IP access control list (ACL) for the disaster recovery peer calledstandbywhitelistedips
.For Autonomous Database Serverless instances, this is an array of CIDR (Classless Inter-Domain Routing) notations for a subnet or VCN OCID. Use a semicolon (;) as a deliminator between the VCN-specific subnets or IPs. Example:
["1.1.1.1","1.1.1.0/24","ocid1.vcn.oc1.sea.<unique_id>","ocid1.vcn.oc1.sea.<unique_id1>;1.1.1.1","ocid1.vcn.oc1.sea.<unique_id2>;1.1.0.0/16"]
For Exadata Cloud@Customer, this is an array of IP addresses or CIDR (Classless Inter-Domain Routing) notations. Example:["1.1.1.1","1.1.1.0/24","1.1.2.25"]
For an update operation, if you want to delete all the IPs in the ACL, use an array with a single empty string entry.
If
arePrimaryWhitelistedIpsUsed
is 'TRUE' then Autonomous Database useswhitelisted_ips
primary's IP access control list (ACL) asstandbywhitelistedips
for the disaster recovery peer.This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, isMTLSConnectionRequired, openMode, permissionLevel, dbWorkload, dbVersion, isRefreshable, dbName, scheduledOperations, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier.
- State string
- The current state of the Autonomous Database.
- Subnet
Id string (Updatable) The OCID of the subnet the resource is associated with. This the only parameter to configure private endpoint, VCN details are obtained from the
subnet_id
.Subnet Restrictions:
- For bare metal DB systems and for single node virtual machine DB systems, do not use a subnet that overlaps with 192.168.16.16/28.
- For Exadata and virtual machine 2-node RAC systems, do not use a subnet that overlaps with 192.168.128.0/20.
- For Autonomous Database, setting this will disable public secure access to the database.
- Subscription
Id string - The OCID of the subscription with which resource needs to be associated with. These subnets are used by the Oracle Clusterware private interconnect on the database instance. Specifying an overlapping subnet will cause the private interconnect to malfunction. This restriction applies to both the client subnet and the backup subnet.
- Supported
Regions List<string>To Clone Tos - The list of regions that support the creation of an Autonomous Database clone or an Autonomous Data Guard standby database.
- Switchover
To string - It is applicable only when
is_local_data_guard_enabled
is true. Could be set toPRIMARY
orSTANDBY
. Default value isPRIMARY
. - Switchover
To stringRemote Peer Id - (Updatable) It is applicable only when
dataguard_region_type
androle
are set, andis_dedicated
is false. For Autonomous Database Serverless instances, Data Guard associations have designated primary and standby regions, and these region types do not change when the database changes roles. It takes the OCID of the remote peer to switchover to and the API is called from the remote region. - Dictionary<string, string>
- System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- Time
Created string - The date and time the Autonomous Database was created.
- Time
Data stringGuard Role Changed - The date and time the Autonomous Data Guard role was switched for the Autonomous Database. For databases that have standbys in both the primary Data Guard region and a remote Data Guard standby region, this is the latest timestamp of either the database using the "primary" role in the primary Data Guard region, or database located in the remote Data Guard standby region.
- Time
Deletion stringOf Free Autonomous Database - The date and time the Always Free database will be automatically deleted because of inactivity. If the database is in the STOPPED state and without activity until this time, it will be deleted.
- Time
Disaster stringRecovery Role Changed - The date and time the Disaster Recovery role was switched for the standby Autonomous Database.
- Time
Local stringData Guard Enabled - The date and time that Autonomous Data Guard was enabled for an Autonomous Database where the standby was provisioned in the same region as the primary database.
- Time
Maintenance stringBegin - The date and time when maintenance will begin.
- Time
Maintenance stringEnd - The date and time when maintenance will end.
- Time
Of stringAuto Refresh Start - The the date and time that auto-refreshing will begin for an Autonomous Database refreshable clone. This value controls only the start time for the first refresh operation. Subsequent (ongoing) refresh operations have start times controlled by the value of the
autoRefreshFrequencyInSeconds
parameter. - Time
Of stringJoining Resource Pool - Time
Of stringLast Failover - The timestamp of the last failover operation.
- Time
Of stringLast Refresh - The date and time when last refresh happened.
- Time
Of stringLast Refresh Point - The refresh point timestamp (UTC). The refresh point is the time to which the database was most recently refreshed. Data created after the refresh point is not included in the refresh.
- Time
Of stringLast Switchover - The timestamp of the last switchover operation for the Autonomous Database.
- Time
Of stringNext Refresh - The date and time of next refresh.
- Time
Reclamation stringOf Free Autonomous Database - The date and time the Always Free database will be stopped because of inactivity. If this time is reached without any database activity, the database will automatically be put into the STOPPED state.
- Time
Undeleted string - Time
Until stringReconnect Clone Enabled - The time and date as an RFC3339 formatted string, e.g., 2022-01-01T12:00:00.000Z, to set the limit for a refreshable clone to be reconnected to its source database.
- Timestamp string
- The timestamp specified for the point-in-time clone of the source Autonomous Database. The timestamp must be in the past.
- Total
Backup doubleStorage Size In Gbs - The backup storage to the database.
- Use
Latest boolAvailable Backup Time Stamp - Clone from latest available backup timestamp.
- Used
Data intStorage Size In Gbs - The storage space consumed by Autonomous Database in GBs.
- Used
Data intStorage Size In Tbs - The amount of storage that has been used, in terabytes.
- Vault
Id string - The OCID of the Oracle Cloud Infrastructure vault.
- Whitelisted
Ips List<string> (Updatable) The client IP access control list (ACL). This feature is available for autonomous databases on shared Exadata infrastructure and on Exadata Cloud@Customer. Only clients connecting from an IP address included in the ACL may access the Autonomous Database instance.
For Autonomous Database Serverless instances, this is an array of CIDR (Classless Inter-Domain Routing) notations for a subnet or VCN OCID. Use a semicolon (;) as a deliminator between the VCN-specific subnets or IPs. Example:
["1.1.1.1","1.1.1.0/24","ocid1.vcn.oc1.sea.<unique_id>","ocid1.vcn.oc1.sea.<unique_id1>;1.1.1.1","ocid1.vcn.oc1.sea.<unique_id2>;1.1.0.0/16"]
For Exadata Cloud@Customer, this is an array of IP addresses or CIDR (Classless Inter-Domain Routing) notations. Example:["1.1.1.1","1.1.1.0/24","1.1.2.25"]
For an update operation, if you want to delete all the IPs in the ACL, use an array with a single empty string entry.
This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, isMTLSConnectionRequired, openMode, permissionLevel, dbWorkload, dbVersion, isRefreshable, dbName, scheduledOperations, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier. To remove all whitelisted IPs, set the field to a list with an empty string
[""]
.
- Actual
Used float64Data Storage Size In Tbs - The current amount of storage in use for user and system data, in terabytes (TB).
- Admin
Password string - (Updatable) The password must be between 12 and 30 characters long, and must contain at least 1 uppercase, 1 lowercase, and 1 numeric character. It cannot contain the double quote symbol (") or the username "admin", regardless of casing. The password is mandatory if source value is "BACKUP_FROM_ID", "BACKUP_FROM_TIMESTAMP", "DATABASE" or "NONE".
- Allocated
Storage float64Size In Tbs - The amount of storage currently allocated for the database tables and billed for, rounded up. When auto-scaling is not enabled, this value is equal to the
dataStorageSizeInTBs
value. You can compare this value to theactualUsedDataStorageSizeInTBs
value to determine if a manual shrink operation is appropriate for your allocated storage. - Apex
Details []AutonomousDatabase Apex Detail Args - Information about Oracle APEX Application Development.
- Are
Primary boolWhitelisted Ips Used - (Updatable) This field will be null if the Autonomous Database is not Data Guard enabled or Access Control is disabled. It's value would be
TRUE
if Autonomous Database is Data Guard enabled and Access Control is enabled and if the Autonomous Database uses primary IP access control list (ACL) for standby. It's value would beFALSE
if Autonomous Database is Data Guard enabled and Access Control is enabled and if the Autonomous Database uses different IP access control list (ACL) for standby compared to primary. - Auto
Refresh intFrequency In Seconds - (Updatable) The frequency a refreshable clone is refreshed after auto-refresh is enabled. The minimum is 1 hour. The maximum is 7 days. The date and time that auto-refresh is enabled is controlled by the
timeOfAutoRefreshStart
parameter. - Auto
Refresh intPoint Lag In Seconds - (Updatable) The time, in seconds, the data of the refreshable clone lags the primary database at the point of refresh. The minimum is 0 minutes (0 mins means refresh to the latest available timestamp). The maximum is 7 days. The lag time increases after refreshing until the next data refresh happens.
- Autonomous
Container stringDatabase Id - The Autonomous Container Database OCID.
- Autonomous
Database stringBackup Id - The OCID of the source Autonomous Database Backup that you will clone to create a new Autonomous Database.
- Autonomous
Database stringId - The OCID of the source Autonomous Database that you will clone to create a new Autonomous Database.
- Autonomous
Maintenance stringSchedule Type - The maintenance schedule type of the Autonomous Database Serverless instances. The EARLY maintenance schedule of this Autonomous Database follows a schedule that applies patches prior to the REGULAR schedule.The REGULAR maintenance schedule of this Autonomous Database follows the normal cycle.
- Availability
Domain string - The availability domain of a local Autonomous Data Guard standby database of an Autonomous Database Serverless instance.
- Available
Upgrade []stringVersions - List of Oracle Database versions available for a database upgrade. If there are no version upgrades available, this list is empty.
- Backup
Configs []AutonomousDatabase Backup Config Args - Autonomous Database configuration details for storing manual backups in the Object Storage service.
- Backup
Retention intPeriod In Days - (Updatable) Retention period, in days, for backups.
- Byol
Compute float64Count Limit - Character
Set string The character set for the autonomous database. The default is AL32UTF8. Allowed values for an Autonomous Database on Serverless infrastructure as returned by List Autonomous Database Character Sets
For an Autonomous Database on dedicated infrastructure, the allowed values are:
AL32UTF8, AR8ADOS710, AR8ADOS720, AR8APTEC715, AR8ARABICMACS, AR8ASMO8X, AR8ISO8859P6, AR8MSWIN1256, AR8MUSSAD768, AR8NAFITHA711, AR8NAFITHA721, AR8SAKHR706, AR8SAKHR707, AZ8ISO8859P9E, BG8MSWIN, BG8PC437S, BLT8CP921, BLT8ISO8859P13, BLT8MSWIN1257, BLT8PC775, BN8BSCII, CDN8PC863, CEL8ISO8859P14, CL8ISO8859P5, CL8ISOIR111, CL8KOI8R, CL8KOI8U, CL8MACCYRILLICS, CL8MSWIN1251, EE8ISO8859P2, EE8MACCES, EE8MACCROATIANS, EE8MSWIN1250, EE8PC852, EL8DEC, EL8ISO8859P7, EL8MACGREEKS, EL8MSWIN1253, EL8PC437S, EL8PC851, EL8PC869, ET8MSWIN923, HU8ABMOD, HU8CWI2, IN8ISCII, IS8PC861, IW8ISO8859P8, IW8MACHEBREWS, IW8MSWIN1255, IW8PC1507, JA16EUC, JA16EUCTILDE, JA16SJIS, JA16SJISTILDE, JA16VMS, KO16KSC5601, KO16KSCCS, KO16MSWIN949, LA8ISO6937, LA8PASSPORT, LT8MSWIN921, LT8PC772, LT8PC774, LV8PC1117, LV8PC8LR, LV8RST104090, N8PC865, NE8ISO8859P10, NEE8ISO8859P4, RU8BESTA, RU8PC855, RU8PC866, SE8ISO8859P3, TH8MACTHAIS, TH8TISASCII, TR8DEC, TR8MACTURKISHS, TR8MSWIN1254, TR8PC857, US7ASCII, US8PC437, UTF8, VN8MSWIN1258, VN8VN3, WE8DEC, WE8DG, WE8ISO8859P1, WE8ISO8859P15, WE8ISO8859P9, WE8MACROMAN8S, WE8MSWIN1252, WE8NCR4970, WE8NEXTSTEP, WE8PC850, WE8PC858, WE8PC860, WE8ROMAN8, ZHS16CGB231280, ZHS16GBK, ZHT16BIG5, ZHT16CCDC, ZHT16DBT, ZHT16HKSCS, ZHT16MSWIN950, ZHT32EUC, ZHT32SOPS, ZHT32TRIS
- Clone
Type string - The Autonomous Database clone type. This parameter is not used to create a refreshable clone type, and for refreshable clones one must use the (source=CLONE_TO_REFRESHABLE) parameter.
FULL
- This option creates a new database that includes all source database data.METADATA
- This option creates a new database that includes the source database schema and select metadata, but not the source database data.
- Cluster
Placement stringGroup Id - The OCID of the cluster placement group of the Autonomous Serverless Database.
- Compartment
Id string - (Updatable) The OCID of the compartment of the Autonomous Database.
- Compute
Count float64 - (Updatable) The compute amount available to the database. Minimum and maximum values depend on the compute model and whether the database is an Autonomous Database Serverless instance or an Autonomous Database on Dedicated Exadata Infrastructure. For an Autonomous Database Serverless instance, the 'ECPU' compute model requires a minimum value of one, for databases in the elastic resource pool and minimum value of two, otherwise. Required when using the
computeModel
parameter. When usingcpuCoreCount
parameter, it is an error to specify computeCount to a non-null value. ProvidingcomputeModel
andcomputeCount
is the preferred method for both OCPU and ECPU. - Compute
Model string - (Updatable) The compute model of the Autonomous Database. This is required if using the
computeCount
parameter. If usingcpuCoreCount
then it is an error to specifycomputeModel
to a non-null value. ECPU compute model is the recommended model and OCPU compute model is legacy. - Connection
Strings []AutonomousDatabase Connection String Args - The connection string used to connect to the Autonomous Database. The username for the Service Console is ADMIN. Use the password you entered when creating the Autonomous Database for the password value.
- Connection
Urls []AutonomousDatabase Connection Url Args - The URLs for accessing Oracle Application Express (APEX) and SQL Developer Web with a browser from a Compute instance within your VCN or that has a direct connection to your VCN. Note that these URLs are provided by the console only for databases on dedicated Exadata infrastructure. Example:
{"sqlDevWebUrl": "https://<hostname>/ords...", "apexUrl", "https://<hostname>/ords..."}
- Cpu
Core intCount - (Updatable) The number of CPU cores to be made available to the database. For Autonomous Databases on dedicated Exadata infrastructure, the maximum number of cores is determined by the infrastructure shape. See Characteristics of Infrastructure Shapes for shape details.
Note: This parameter cannot be used with the
ocpuCount
parameter. This input is ignored for Always Free resources.- The data type must be an integer.
- The minimum number of cores for all types of autonomous database is 1
- The maximum number of cores is as follows:
- Autonomous Database Serverless instances: The maximum number of cores is 128.
- Autonomous Databases on dedicated Exadata infrastructure: The maximum number of cores is determined by the infrastructure shape. See Characteristics of Infrastructure Shapes for shape details.
- Providing
computeModel
andcomputeCount
is the preferred method for setting CPUs for both OCPU and ECPU.
- Customer
Contacts []AutonomousDatabase Customer Contact Args - (Updatable) Customer Contacts.
- Data
Safe stringStatus - (Updatable) Status of the Data Safe registration for this Autonomous Database. Could be REGISTERED or NOT_REGISTERED.
- Data
Storage intSize In Gb (Updatable) The size, in gigabytes, of the data volume that will be created and attached to the database. This storage can later be scaled up if needed. The maximum storage value is determined by the infrastructure shape. See Characteristics of Infrastructure Shapes for shape details.
Notes
- This parameter is only supported for dedicated Exadata infrastructure.
- This parameter cannot be used with the
dataStorageSizeInTBs
parameter.
- Data
Storage intSize In Tbs (Updatable) The size, in terabytes, of the data volume that will be created and attached to the database. This storage can later be scaled up if needed. For Autonomous Databases on dedicated Exadata infrastructure, the maximum storage value is determined by the infrastructure shape. See Characteristics of Infrastructure Shapes for shape details. A full Exadata service is allocated when the Autonomous Database size is set to the upper limit (384 TB).
Note: This parameter cannot be used with the
dataStorageSizeInGBs
parameter. This input is ignored for Always Free resources.- Database
Edition string - (Updatable) The Oracle Database Edition that applies to the Autonomous databases. It can be set to
ENTERPRISE_EDITION
orSTANDARD_EDITION
. - Database
Management stringStatus - Status of Database Management for this Autonomous Database.
- Dataguard
Region stringType - Deprecated (Optional) The Autonomous Data Guard region type of the Autonomous Database. For Autonomous Database Serverless instances, Data Guard associations have designated primary (
PRIMARY_DG_REGION
) and standby (REMOTE_STANDBY_DG_REGION
) regions, and these region types do not change when the database changes roles. The standby regions in Data Guard associations can be the same region designated as the primary region, or they can be remote regions. Certain database administrative operations may be available only in the primary region of the Data Guard association, and cannot be performed when the database using the "primary" role is operating in a remote Data Guard standby region. - Db
Name string - The database name. The name must begin with an alphabetic character and can contain a maximum of 14 alphanumeric characters. Special characters are not permitted. The database name must be unique in the tenancy. It is required in all cases except when creating a cross-region Autonomous Data Guard standby instance or a cross-region disaster recovery standby instance.
- Db
Tools []AutonomousDetails Database Db Tools Detail Args (Updatable) The list of database tools details.
This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, whitelistedIps, isMTLSConnectionRequired, openMode, permissionLevel, dbWorkload, privateEndpointLabel, nsgIds, dbVersion, isRefreshable, dbName, scheduledOperations, isLocalDataGuardEnabled, or isFreeTier.
- Db
Version string - (Updatable) A valid Oracle Database version for Autonomous Database.
db_workload
AJD and APEX are only supported fordb_version
19c
and above. - Db
Workload string (Updatable) The Autonomous Database workload type. The following values are valid:
- OLTP - indicates an Autonomous Transaction Processing database
- DW - indicates an Autonomous Data Warehouse database
- AJD - indicates an Autonomous JSON Database
- APEX - indicates an Autonomous Database with the Oracle APEX Application Development workload type.
This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, isMTLSConnectionRequired, privateEndpointLabel, nsgIds, dbVersion, isRefreshable, dbName, scheduledOperations, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier. *Note:
db_workload
can only be updated from AJD to OLTP or from a free OLTP to AJD.- map[string]string
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- Disaster
Recovery stringRegion Type - Deprecated The disaster recovery (DR) region type of the Autonomous Database. For Serverless Autonomous Databases, DR associations have designated primary (
PRIMARY
) and standby (REMOTE
) regions. These region types do not change when the database changes roles. The standby region in DR associations can be the same region as the primary region, or they can be in a remote regions. Some database administration operations may be available only in the primary region of the DR association, and cannot be performed when the database using the primary role is operating in a remote region. - Disaster
Recovery stringType - Indicates the disaster recovery (DR) type of the standby Autonomous Database Serverless instance. Autonomous Data Guard (ADG) DR type provides business critical DR with a faster recovery time objective (RTO) during failover or switchover. Backup-based DR type provides lower cost DR with a slower RTO during failover or switchover.
- Display
Name string - (Updatable) The user-friendly name for the Autonomous Database. The name does not have to be unique.
- Encryption
Key AutonomousDatabase Encryption Key Args - (Updatable) Details of the Autonomous Database encryption key.
- Encryption
Key []AutonomousHistory Entries Database Encryption Key History Entry Args - Key History Entry.
- Failed
Data intRecovery In Seconds - Indicates the number of seconds of data loss for a Data Guard failover.
- map[string]string
- (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example:
{"Department": "Finance"}
- In
Memory intArea In Gbs - The area assigned to In-Memory tables in Autonomous Database.
- In
Memory intPercentage - (Updatable) The percentage of the System Global Area(SGA) assigned to In-Memory tables in Autonomous Database. This property is applicable only to Autonomous Databases on the Exadata Cloud@Customer platform.
- Infrastructure
Type string - The infrastructure type this resource belongs to.
- Is
Access boolControl Enabled (Updatable) Indicates if the database-level access control is enabled. If disabled, database access is defined by the network security rules. If enabled, database access is restricted to the IP addresses defined by the rules specified with the
whitelistedIps
property. While specifyingwhitelistedIps
rules is optional, if database-level access control is enabled and no rules are specified, the database will become inaccessible. The rules can be added later using theUpdateAutonomousDatabase
API operation or edit option in console. When creating a database clone, the desired access control setting should be specified. By default, database-level access control will be disabled for the clone.This property is applicable only to Autonomous Databases on the Exadata Cloud@Customer platform. For Autonomous Database Serverless instances,
whitelistedIps
is used.- Is
Auto boolScaling Enabled - (Updatable) Indicates if auto scaling is enabled for the Autonomous Database CPU core count. The default value is
TRUE
. - Is
Auto boolScaling For Storage Enabled - (Updatable) Indicates if auto scaling is enabled for the Autonomous Database storage. The default value is
FALSE
. - Is
Data boolGuard Enabled - (Updatable) Deprecated. Indicates whether the Autonomous Database has local (in-region) Data Guard enabled. Not applicable to cross-region Autonomous Data Guard associations, or to Autonomous Databases using dedicated Exadata infrastructure or Exadata Cloud@Customer infrastructure.
- Is
Dedicated bool - True if the database is on dedicated Exadata infrastructure.
- Is
Dev boolTier - (Updatable) Autonomous Database for Developers are free Autonomous Databases that developers can use to build and test new applications.With Autonomous these database instancess instances, you can try new Autonomous Database features for free and apply them to ongoing or new development projects. Developer database comes with limited resources and is, therefore, not suitable for large-scale testing and production deployments. When you need more compute or storage resources, you can transition to a paid database licensing by cloning your developer database into a regular Autonomous Database. See Autonomous Database documentation for more details.
- Is
Free boolTier - (Updatable) Indicates if this is an Always Free resource. The default value is false. Note that Always Free Autonomous Databases have 1 CPU and 20GB of memory. For Always Free databases, memory and CPU cannot be scaled. When
db_workload
isAJD
orAPEX
it cannot betrue
. - Is
Local boolData Guard Enabled - (Updatable) Indicates whether the Autonomous Database has local (in-region) Data Guard enabled. It takes boolean values. Not applicable to cross-region Autonomous Data Guard associations, or to Autonomous Databases using dedicated Exadata infrastructure or Exadata Cloud@Customer infrastructure.
- Is
Mtls boolConnection Required - (Updatable) Indicates whether the Autonomous Database requires mTLS connections.
- Is
Preview bool - Indicates if the Autonomous Database version is a preview version.
- Is
Preview boolVersion With Service Terms Accepted - If set to
TRUE
, indicates that an Autonomous Database preview version is being provisioned, and that the preview version's terms of service have been accepted. Note that preview version software is only available for databases on Autonomous Database Serverless. - Is
Reconnect boolClone Enabled - Indicates if the refreshable clone can be reconnected to its source database.
- Is
Refreshable boolClone - (Updatable) True for creating a refreshable clone and False for detaching the clone from source Autonomous Database. Detaching is one time operation and clone becomes a regular Autonomous Database.
- Is
Remote boolData Guard Enabled - Indicates whether the Autonomous Database has Cross Region Data Guard enabled. It takes boolean values. Not applicable to Autonomous Databases using dedicated Exadata infrastructure or Exadata Cloud@Customer infrastructure.
- Is
Replicate boolAutomatic Backups - If true, 7 days worth of backups are replicated across regions for Cross-Region ADB or Backup-Based DR between Primary and Standby. If false, the backups taken on the Primary are not replicated to the Standby database.
- Is
Shrink boolOnly (Updatable) An optional property when enabled triggers the Shrinking of Autonomous Database once. To trigger Shrinking of ADB once again, this flag needs to be disabled and re-enabled again. It should not be passed during create database operation. It is only applicable on Serverless databases i.e. where
is_dedicated
is false.** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- Key
History []AutonomousEntries Database Key History Entry Args - Key History Entry.
- Key
Store stringId - The OCID of the key store of Oracle Vault. This is used in Autonomous Databases on Serverless instances and dedicated Exadata infrastructure.
- Key
Store stringWallet Name - The wallet name for Oracle Key Vault.
- Key
Version stringId - The OCID of the key version that is used in rotate key operations.
- Kms
Key stringId - The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
- Kms
Key stringLifecycle Details - KMS key lifecycle details.
- Kms
Key stringVersion Id - The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation. Autonomous Database Serverless does not use key versions, hence is not applicable for Autonomous Database Serverless instances.
- License
Model string - (Updatable) The Oracle license model that applies to the Oracle Autonomous Database. Bring your own license (BYOL) allows you to apply your current on-premises Oracle software licenses to equivalent, highly automated Oracle PaaS and IaaS services in the cloud. License Included allows you to subscribe to new Oracle Database software licenses and the Database service. Note that when provisioning an Autonomous Database on dedicated Exadata infrastructure, this attribute must be null because the attribute is already set at the Autonomous Exadata Infrastructure level. When using shared Exadata infrastructure, if a value is not specified, the system will supply the value of
BRING_YOUR_OWN_LICENSE
. It is a required field whendb_workload
is AJD and needs to be set toLICENSE_INCLUDED
as AJD does not support defaultlicense_model
valueBRING_YOUR_OWN_LICENSE
. - Lifecycle
Details string - Additional information about the current lifecycle state.
- Local
Adg intAuto Failover Max Data Loss Limit - Parameter that allows users to select an acceptable maximum data loss limit in seconds, up to which Automatic Failover will be triggered when necessary for a Local Autonomous Data Guard
- Local
Disaster stringRecovery Type - Indicates the local disaster recovery (DR) type of the Serverless Autonomous Database. Autonomous Data Guard (
ADG
) DR type provides business critical DR with a faster recovery time objective (RTO) during failover or switchover. Backup-based (BACKUP_BASED
) DR type provides lower cost DR with a slower RTO during failover or switchover. - Local
Standby []AutonomousDbs Database Local Standby Db Args - Autonomous Data Guard local (same region) standby database details.
- Long
Term []AutonomousBackup Schedules Database Long Term Backup Schedule Args - Details for the long-term backup schedule.
- Max
Cpu intCore Count - (Updatable) Deprecated. The number of Max OCPU cores to be made available to the autonomous database with auto scaling of cpu enabled.
- Memory
Per intOracle Compute Unit In Gbs - The amount of memory (in GBs) enabled per OCPU or ECPU. See Compute Models in Autonomous Database on Dedicated Exadata Infrastructure for more details. This parameter is not used for Autonomous database Serverless.
- Ncharacter
Set string - The national character set for the autonomous database. The default is AL16UTF16. Allowed values are: AL16UTF16 or UTF8.
- Net
Services stringArchitecture - Enabling SHARED server architecture enables a database server to allow many client processes to share very few server processes, thereby increasing the number of supported users.
- Next
Long stringTerm Backup Time Stamp - The date and time when the next long-term backup would be created.
- Nsg
Ids []string - (Updatable) The list of OCIDs for the network security groups (NSGs) to which this resource belongs. Setting this to an empty list removes all resources from all NSGs. For more information about NSGs, see Security Rules. NsgIds restrictions:
- A network security group (NSG) is optional for Autonomous Databases with private access. The nsgIds list can be empty.
- Ocpu
Count float64 (Updatable) The number of OCPU cores to be made available to the database.
- Providing
computeModel
andcomputeCount
is the preferred method for setting CPUs for both OCPU and ECPU. The following points apply: - For Autonomous Databases on dedicated Exadata infrastructure, to provision less than 1 core, enter a fractional value in an increment of 0.1. For example, you can provision 0.3 or 0.4 cores, but not 0.35 cores. (Note that fractional OCPU values are not supported for Autonomous Databasese on shared Exadata infrastructure.)
- To provision 1 or more cores, you must enter an integer between 1 and the maximum number of cores available for the infrastructure shape. For example, you can provision 2 cores or 3 cores, but not 2.5 cores. This applies to Autonomous Databases on both shared and dedicated Exadata infrastructure.
For Autonomous Databases on dedicated Exadata infrastructure, the maximum number of cores is determined by the infrastructure shape. See Characteristics of Infrastructure Shapes for shape details.
Note: This parameter cannot be used with the
cpuCoreCount
parameter.- Providing
- Open
Mode string - Indicates the Autonomous Database mode. The database can be opened in
READ_ONLY
orREAD_WRITE
mode. - Operations
Insights stringStatus - (Updatable) Status of Operations Insights for this Autonomous Database. Values supported are
ENABLED
andNOT_ENABLED
- Peer
Db []stringIds - The list of OCIDs of standby databases located in Autonomous Data Guard remote regions that are associated with the source database. Note that for Autonomous Database Serverless instances, standby databases located in the same region as the source primary database do not have OCIDs.
- Permission
Level string - The Autonomous Database permission level. Restricted mode allows access only by admin users.
- Private
Endpoint string - The private endpoint for the resource. This parameter is not used in Autonomous Databases using Serverless infrastructure and Exadata Cloud@Customer infrastructure.
- Private
Endpoint stringIp - The private endpoint Ip address for the resource.
- Private
Endpoint stringLabel - (Updatable) (Optional) (Updatable) The resource's private endpoint label.
- Setting the endpoint label to a non-empty string creates a private endpoint database.
- Resetting the endpoint label to an empty string, after the creation of the private endpoint database, changes the private endpoint database to a public endpoint database.
- Setting the endpoint label to a non-empty string value, updates to a new private endpoint database, when the database is disabled and re-enabled.
- Provisionable
Cpuses []float64 - An array of CPU values that an Autonomous Database can be scaled to.
- Public
Connection []AutonomousUrls Database Public Connection Url Args - The Public URLs of Private Endpoint database for accessing Oracle Application Express (APEX) and SQL Developer Web with a browser from a Compute instance within your VCN or that has a direct connection to your VCN.
- Public
Endpoint string - The public endpoint for the private endpoint enabled resource.
- Refreshable
Mode string - (Updatable) The refresh mode of the clone. AUTOMATIC indicates that the clone is automatically being refreshed with data from the source Autonomous Database.
- Refreshable
Status string - The refresh status of the clone. REFRESHING indicates that the clone is currently being refreshed with data from the source Autonomous Database.
- Remote
Disaster []AutonomousRecovery Configurations Database Remote Disaster Recovery Configuration Args - Configurations of a Disaster Recovery.
- Remote
Disaster stringRecovery Type - Indicates the cross-region disaster recovery (DR) type of the standby Autonomous Database Serverless instance. Autonomous Data Guard (ADG) DR type provides business critical DR with a faster recovery time objective (RTO) during failover or switchover. Backup-based DR type provides lower cost DR with a slower RTO during failover or switchover.
- Resource
Pool stringLeader Id - (Updatable) The unique identifier for leader autonomous database OCID OCID.
- Resource
Pool AutonomousSummary Database Resource Pool Summary Args - (Updatable) The configuration details for resource pool
- Role string
- The Data Guard role of the Autonomous Container Database or Autonomous Database, if Autonomous Data Guard is enabled.
- Rotate
Key boolTrigger - (Updatable) An optional property when flipped triggers rotation of KMS key. It is only applicable on dedicated databases i.e. where
is_dedicated
is true. - Scheduled
Operations []AutonomousDatabase Scheduled Operation Args (Updatable) The list of scheduled operations. Consists of values such as dayOfWeek, scheduledStartTime, scheduledStopTime.
This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, whitelistedIps, isMTLSConnectionRequired, openMode, permissionLevel, dbWorkload, privateEndpointLabel, nsgIds, dbVersion, isRefreshable, dbName, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier.
- Secret
Id string (Updatable) The Oracle Cloud Infrastructure vault secret [/Content/General/Concepts/identifiers.htm]OCID.
This cannot be used in conjunction with adminPassword.
- Secret
Version intNumber - (Updatable) The version of the vault secret. If no version is specified, the latest version will be used.
- Security
Attributes map[string]string - (Updatable) Security Attributes for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "audit"}}}
- Service
Console stringUrl - The URL of the Service Console for the Autonomous Database.
- Shrink
Adb intTrigger - Source string
The source of the database:
- Use
NONE
for creating a new Autonomous Database. - Use
DATABASE
for creating a new Autonomous Database by cloning an existing running Autonomous Database from the latest timestamp, also provide the source database OCID in thesource_id
parameter. - Use
CROSS_REGION_DATAGUARD
to create a standby Data Guard database in another region, also provide the remote primary database OCID in thesource_id
parameter. - Use
CLONE_TO_REFRESHABLE
for creating a refreshable clone.
For Autonomous Database Serverless instances, the following cloning options are available:
- Use
BACKUP_FROM_ID
for creating a new Autonomous Database by cloning from a specified backup. Also provide the backup OCID in theautonomous_database_backup_id
parameter. - Use
BACKUP_FROM_TIMESTAMP
for creating a point-in-time Autonomous Database clone using backups. Also provide the backup timestamp in thetimestamp
parameter. For more information, see Cloning and Moving an Autonomous Database.
- Use
- Source
Id string - The OCID of the source Autonomous Database that will be used to create a new standby database for the Data Guard association.
- Standby
Dbs []AutonomousDatabase Standby Db Args - Deprecated Autonomous Data Guard standby database details.
- Standby
Whitelisted []stringIps (Updatable) The client IP access control list (ACL). This feature is available for [Autonomous Database Serverless] (https://docs.oracle.com/en/cloud/paas/autonomous-database/index.html) and on Exadata Cloud@Customer. Only clients connecting from an IP address included in the ACL may access the Autonomous Database instance. If
arePrimaryWhitelistedIpsUsed
is 'TRUE' then Autonomous Database uses this primary's IP access control list (ACL) for the disaster recovery peer calledstandbywhitelistedips
.For Autonomous Database Serverless instances, this is an array of CIDR (Classless Inter-Domain Routing) notations for a subnet or VCN OCID. Use a semicolon (;) as a deliminator between the VCN-specific subnets or IPs. Example:
["1.1.1.1","1.1.1.0/24","ocid1.vcn.oc1.sea.<unique_id>","ocid1.vcn.oc1.sea.<unique_id1>;1.1.1.1","ocid1.vcn.oc1.sea.<unique_id2>;1.1.0.0/16"]
For Exadata Cloud@Customer, this is an array of IP addresses or CIDR (Classless Inter-Domain Routing) notations. Example:["1.1.1.1","1.1.1.0/24","1.1.2.25"]
For an update operation, if you want to delete all the IPs in the ACL, use an array with a single empty string entry.
If
arePrimaryWhitelistedIpsUsed
is 'TRUE' then Autonomous Database useswhitelisted_ips
primary's IP access control list (ACL) asstandbywhitelistedips
for the disaster recovery peer.This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, isMTLSConnectionRequired, openMode, permissionLevel, dbWorkload, dbVersion, isRefreshable, dbName, scheduledOperations, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier.
- State string
- The current state of the Autonomous Database.
- Subnet
Id string (Updatable) The OCID of the subnet the resource is associated with. This the only parameter to configure private endpoint, VCN details are obtained from the
subnet_id
.Subnet Restrictions:
- For bare metal DB systems and for single node virtual machine DB systems, do not use a subnet that overlaps with 192.168.16.16/28.
- For Exadata and virtual machine 2-node RAC systems, do not use a subnet that overlaps with 192.168.128.0/20.
- For Autonomous Database, setting this will disable public secure access to the database.
- Subscription
Id string - The OCID of the subscription with which resource needs to be associated with. These subnets are used by the Oracle Clusterware private interconnect on the database instance. Specifying an overlapping subnet will cause the private interconnect to malfunction. This restriction applies to both the client subnet and the backup subnet.
- Supported
Regions []stringTo Clone Tos - The list of regions that support the creation of an Autonomous Database clone or an Autonomous Data Guard standby database.
- Switchover
To string - It is applicable only when
is_local_data_guard_enabled
is true. Could be set toPRIMARY
orSTANDBY
. Default value isPRIMARY
. - Switchover
To stringRemote Peer Id - (Updatable) It is applicable only when
dataguard_region_type
androle
are set, andis_dedicated
is false. For Autonomous Database Serverless instances, Data Guard associations have designated primary and standby regions, and these region types do not change when the database changes roles. It takes the OCID of the remote peer to switchover to and the API is called from the remote region. - map[string]string
- System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- Time
Created string - The date and time the Autonomous Database was created.
- Time
Data stringGuard Role Changed - The date and time the Autonomous Data Guard role was switched for the Autonomous Database. For databases that have standbys in both the primary Data Guard region and a remote Data Guard standby region, this is the latest timestamp of either the database using the "primary" role in the primary Data Guard region, or database located in the remote Data Guard standby region.
- Time
Deletion stringOf Free Autonomous Database - The date and time the Always Free database will be automatically deleted because of inactivity. If the database is in the STOPPED state and without activity until this time, it will be deleted.
- Time
Disaster stringRecovery Role Changed - The date and time the Disaster Recovery role was switched for the standby Autonomous Database.
- Time
Local stringData Guard Enabled - The date and time that Autonomous Data Guard was enabled for an Autonomous Database where the standby was provisioned in the same region as the primary database.
- Time
Maintenance stringBegin - The date and time when maintenance will begin.
- Time
Maintenance stringEnd - The date and time when maintenance will end.
- Time
Of stringAuto Refresh Start - The the date and time that auto-refreshing will begin for an Autonomous Database refreshable clone. This value controls only the start time for the first refresh operation. Subsequent (ongoing) refresh operations have start times controlled by the value of the
autoRefreshFrequencyInSeconds
parameter. - Time
Of stringJoining Resource Pool - Time
Of stringLast Failover - The timestamp of the last failover operation.
- Time
Of stringLast Refresh - The date and time when last refresh happened.
- Time
Of stringLast Refresh Point - The refresh point timestamp (UTC). The refresh point is the time to which the database was most recently refreshed. Data created after the refresh point is not included in the refresh.
- Time
Of stringLast Switchover - The timestamp of the last switchover operation for the Autonomous Database.
- Time
Of stringNext Refresh - The date and time of next refresh.
- Time
Reclamation stringOf Free Autonomous Database - The date and time the Always Free database will be stopped because of inactivity. If this time is reached without any database activity, the database will automatically be put into the STOPPED state.
- Time
Undeleted string - Time
Until stringReconnect Clone Enabled - The time and date as an RFC3339 formatted string, e.g., 2022-01-01T12:00:00.000Z, to set the limit for a refreshable clone to be reconnected to its source database.
- Timestamp string
- The timestamp specified for the point-in-time clone of the source Autonomous Database. The timestamp must be in the past.
- Total
Backup float64Storage Size In Gbs - The backup storage to the database.
- Use
Latest boolAvailable Backup Time Stamp - Clone from latest available backup timestamp.
- Used
Data intStorage Size In Gbs - The storage space consumed by Autonomous Database in GBs.
- Used
Data intStorage Size In Tbs - The amount of storage that has been used, in terabytes.
- Vault
Id string - The OCID of the Oracle Cloud Infrastructure vault.
- Whitelisted
Ips []string (Updatable) The client IP access control list (ACL). This feature is available for autonomous databases on shared Exadata infrastructure and on Exadata Cloud@Customer. Only clients connecting from an IP address included in the ACL may access the Autonomous Database instance.
For Autonomous Database Serverless instances, this is an array of CIDR (Classless Inter-Domain Routing) notations for a subnet or VCN OCID. Use a semicolon (;) as a deliminator between the VCN-specific subnets or IPs. Example:
["1.1.1.1","1.1.1.0/24","ocid1.vcn.oc1.sea.<unique_id>","ocid1.vcn.oc1.sea.<unique_id1>;1.1.1.1","ocid1.vcn.oc1.sea.<unique_id2>;1.1.0.0/16"]
For Exadata Cloud@Customer, this is an array of IP addresses or CIDR (Classless Inter-Domain Routing) notations. Example:["1.1.1.1","1.1.1.0/24","1.1.2.25"]
For an update operation, if you want to delete all the IPs in the ACL, use an array with a single empty string entry.
This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, isMTLSConnectionRequired, openMode, permissionLevel, dbWorkload, dbVersion, isRefreshable, dbName, scheduledOperations, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier. To remove all whitelisted IPs, set the field to a list with an empty string
[""]
.
- actual
Used DoubleData Storage Size In Tbs - The current amount of storage in use for user and system data, in terabytes (TB).
- admin
Password String - (Updatable) The password must be between 12 and 30 characters long, and must contain at least 1 uppercase, 1 lowercase, and 1 numeric character. It cannot contain the double quote symbol (") or the username "admin", regardless of casing. The password is mandatory if source value is "BACKUP_FROM_ID", "BACKUP_FROM_TIMESTAMP", "DATABASE" or "NONE".
- allocated
Storage DoubleSize In Tbs - The amount of storage currently allocated for the database tables and billed for, rounded up. When auto-scaling is not enabled, this value is equal to the
dataStorageSizeInTBs
value. You can compare this value to theactualUsedDataStorageSizeInTBs
value to determine if a manual shrink operation is appropriate for your allocated storage. - apex
Details List<AutonomousApex Detail> - Information about Oracle APEX Application Development.
- are
Primary BooleanWhitelisted Ips Used - (Updatable) This field will be null if the Autonomous Database is not Data Guard enabled or Access Control is disabled. It's value would be
TRUE
if Autonomous Database is Data Guard enabled and Access Control is enabled and if the Autonomous Database uses primary IP access control list (ACL) for standby. It's value would beFALSE
if Autonomous Database is Data Guard enabled and Access Control is enabled and if the Autonomous Database uses different IP access control list (ACL) for standby compared to primary. - auto
Refresh IntegerFrequency In Seconds - (Updatable) The frequency a refreshable clone is refreshed after auto-refresh is enabled. The minimum is 1 hour. The maximum is 7 days. The date and time that auto-refresh is enabled is controlled by the
timeOfAutoRefreshStart
parameter. - auto
Refresh IntegerPoint Lag In Seconds - (Updatable) The time, in seconds, the data of the refreshable clone lags the primary database at the point of refresh. The minimum is 0 minutes (0 mins means refresh to the latest available timestamp). The maximum is 7 days. The lag time increases after refreshing until the next data refresh happens.
- autonomous
Container StringDatabase Id - The Autonomous Container Database OCID.
- autonomous
Database StringBackup Id - The OCID of the source Autonomous Database Backup that you will clone to create a new Autonomous Database.
- autonomous
Database StringId - The OCID of the source Autonomous Database that you will clone to create a new Autonomous Database.
- autonomous
Maintenance StringSchedule Type - The maintenance schedule type of the Autonomous Database Serverless instances. The EARLY maintenance schedule of this Autonomous Database follows a schedule that applies patches prior to the REGULAR schedule.The REGULAR maintenance schedule of this Autonomous Database follows the normal cycle.
- availability
Domain String - The availability domain of a local Autonomous Data Guard standby database of an Autonomous Database Serverless instance.
- available
Upgrade List<String>Versions - List of Oracle Database versions available for a database upgrade. If there are no version upgrades available, this list is empty.
- backup
Configs List<AutonomousBackup Config> - Autonomous Database configuration details for storing manual backups in the Object Storage service.
- backup
Retention IntegerPeriod In Days - (Updatable) Retention period, in days, for backups.
- byol
Compute DoubleCount Limit - character
Set String The character set for the autonomous database. The default is AL32UTF8. Allowed values for an Autonomous Database on Serverless infrastructure as returned by List Autonomous Database Character Sets
For an Autonomous Database on dedicated infrastructure, the allowed values are:
AL32UTF8, AR8ADOS710, AR8ADOS720, AR8APTEC715, AR8ARABICMACS, AR8ASMO8X, AR8ISO8859P6, AR8MSWIN1256, AR8MUSSAD768, AR8NAFITHA711, AR8NAFITHA721, AR8SAKHR706, AR8SAKHR707, AZ8ISO8859P9E, BG8MSWIN, BG8PC437S, BLT8CP921, BLT8ISO8859P13, BLT8MSWIN1257, BLT8PC775, BN8BSCII, CDN8PC863, CEL8ISO8859P14, CL8ISO8859P5, CL8ISOIR111, CL8KOI8R, CL8KOI8U, CL8MACCYRILLICS, CL8MSWIN1251, EE8ISO8859P2, EE8MACCES, EE8MACCROATIANS, EE8MSWIN1250, EE8PC852, EL8DEC, EL8ISO8859P7, EL8MACGREEKS, EL8MSWIN1253, EL8PC437S, EL8PC851, EL8PC869, ET8MSWIN923, HU8ABMOD, HU8CWI2, IN8ISCII, IS8PC861, IW8ISO8859P8, IW8MACHEBREWS, IW8MSWIN1255, IW8PC1507, JA16EUC, JA16EUCTILDE, JA16SJIS, JA16SJISTILDE, JA16VMS, KO16KSC5601, KO16KSCCS, KO16MSWIN949, LA8ISO6937, LA8PASSPORT, LT8MSWIN921, LT8PC772, LT8PC774, LV8PC1117, LV8PC8LR, LV8RST104090, N8PC865, NE8ISO8859P10, NEE8ISO8859P4, RU8BESTA, RU8PC855, RU8PC866, SE8ISO8859P3, TH8MACTHAIS, TH8TISASCII, TR8DEC, TR8MACTURKISHS, TR8MSWIN1254, TR8PC857, US7ASCII, US8PC437, UTF8, VN8MSWIN1258, VN8VN3, WE8DEC, WE8DG, WE8ISO8859P1, WE8ISO8859P15, WE8ISO8859P9, WE8MACROMAN8S, WE8MSWIN1252, WE8NCR4970, WE8NEXTSTEP, WE8PC850, WE8PC858, WE8PC860, WE8ROMAN8, ZHS16CGB231280, ZHS16GBK, ZHT16BIG5, ZHT16CCDC, ZHT16DBT, ZHT16HKSCS, ZHT16MSWIN950, ZHT32EUC, ZHT32SOPS, ZHT32TRIS
- clone
Type String - The Autonomous Database clone type. This parameter is not used to create a refreshable clone type, and for refreshable clones one must use the (source=CLONE_TO_REFRESHABLE) parameter.
FULL
- This option creates a new database that includes all source database data.METADATA
- This option creates a new database that includes the source database schema and select metadata, but not the source database data.
- cluster
Placement StringGroup Id - The OCID of the cluster placement group of the Autonomous Serverless Database.
- compartment
Id String - (Updatable) The OCID of the compartment of the Autonomous Database.
- compute
Count Double - (Updatable) The compute amount available to the database. Minimum and maximum values depend on the compute model and whether the database is an Autonomous Database Serverless instance or an Autonomous Database on Dedicated Exadata Infrastructure. For an Autonomous Database Serverless instance, the 'ECPU' compute model requires a minimum value of one, for databases in the elastic resource pool and minimum value of two, otherwise. Required when using the
computeModel
parameter. When usingcpuCoreCount
parameter, it is an error to specify computeCount to a non-null value. ProvidingcomputeModel
andcomputeCount
is the preferred method for both OCPU and ECPU. - compute
Model String - (Updatable) The compute model of the Autonomous Database. This is required if using the
computeCount
parameter. If usingcpuCoreCount
then it is an error to specifycomputeModel
to a non-null value. ECPU compute model is the recommended model and OCPU compute model is legacy. - connection
Strings List<AutonomousConnection String> - The connection string used to connect to the Autonomous Database. The username for the Service Console is ADMIN. Use the password you entered when creating the Autonomous Database for the password value.
- connection
Urls List<AutonomousConnection Url> - The URLs for accessing Oracle Application Express (APEX) and SQL Developer Web with a browser from a Compute instance within your VCN or that has a direct connection to your VCN. Note that these URLs are provided by the console only for databases on dedicated Exadata infrastructure. Example:
{"sqlDevWebUrl": "https://<hostname>/ords...", "apexUrl", "https://<hostname>/ords..."}
- cpu
Core IntegerCount - (Updatable) The number of CPU cores to be made available to the database. For Autonomous Databases on dedicated Exadata infrastructure, the maximum number of cores is determined by the infrastructure shape. See Characteristics of Infrastructure Shapes for shape details.
Note: This parameter cannot be used with the
ocpuCount
parameter. This input is ignored for Always Free resources.- The data type must be an integer.
- The minimum number of cores for all types of autonomous database is 1
- The maximum number of cores is as follows:
- Autonomous Database Serverless instances: The maximum number of cores is 128.
- Autonomous Databases on dedicated Exadata infrastructure: The maximum number of cores is determined by the infrastructure shape. See Characteristics of Infrastructure Shapes for shape details.
- Providing
computeModel
andcomputeCount
is the preferred method for setting CPUs for both OCPU and ECPU.
- customer
Contacts List<AutonomousCustomer Contact> - (Updatable) Customer Contacts.
- data
Safe StringStatus - (Updatable) Status of the Data Safe registration for this Autonomous Database. Could be REGISTERED or NOT_REGISTERED.
- data
Storage IntegerSize In Gb (Updatable) The size, in gigabytes, of the data volume that will be created and attached to the database. This storage can later be scaled up if needed. The maximum storage value is determined by the infrastructure shape. See Characteristics of Infrastructure Shapes for shape details.
Notes
- This parameter is only supported for dedicated Exadata infrastructure.
- This parameter cannot be used with the
dataStorageSizeInTBs
parameter.
- data
Storage IntegerSize In Tbs (Updatable) The size, in terabytes, of the data volume that will be created and attached to the database. This storage can later be scaled up if needed. For Autonomous Databases on dedicated Exadata infrastructure, the maximum storage value is determined by the infrastructure shape. See Characteristics of Infrastructure Shapes for shape details. A full Exadata service is allocated when the Autonomous Database size is set to the upper limit (384 TB).
Note: This parameter cannot be used with the
dataStorageSizeInGBs
parameter. This input is ignored for Always Free resources.- database
Edition String - (Updatable) The Oracle Database Edition that applies to the Autonomous databases. It can be set to
ENTERPRISE_EDITION
orSTANDARD_EDITION
. - database
Management StringStatus - Status of Database Management for this Autonomous Database.
- dataguard
Region StringType - Deprecated (Optional) The Autonomous Data Guard region type of the Autonomous Database. For Autonomous Database Serverless instances, Data Guard associations have designated primary (
PRIMARY_DG_REGION
) and standby (REMOTE_STANDBY_DG_REGION
) regions, and these region types do not change when the database changes roles. The standby regions in Data Guard associations can be the same region designated as the primary region, or they can be remote regions. Certain database administrative operations may be available only in the primary region of the Data Guard association, and cannot be performed when the database using the "primary" role is operating in a remote Data Guard standby region. - db
Name String - The database name. The name must begin with an alphabetic character and can contain a maximum of 14 alphanumeric characters. Special characters are not permitted. The database name must be unique in the tenancy. It is required in all cases except when creating a cross-region Autonomous Data Guard standby instance or a cross-region disaster recovery standby instance.
- db
Tools List<AutonomousDetails Db Tools Detail> (Updatable) The list of database tools details.
This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, whitelistedIps, isMTLSConnectionRequired, openMode, permissionLevel, dbWorkload, privateEndpointLabel, nsgIds, dbVersion, isRefreshable, dbName, scheduledOperations, isLocalDataGuardEnabled, or isFreeTier.
- db
Version String - (Updatable) A valid Oracle Database version for Autonomous Database.
db_workload
AJD and APEX are only supported fordb_version
19c
and above. - db
Workload String (Updatable) The Autonomous Database workload type. The following values are valid:
- OLTP - indicates an Autonomous Transaction Processing database
- DW - indicates an Autonomous Data Warehouse database
- AJD - indicates an Autonomous JSON Database
- APEX - indicates an Autonomous Database with the Oracle APEX Application Development workload type.
This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, isMTLSConnectionRequired, privateEndpointLabel, nsgIds, dbVersion, isRefreshable, dbName, scheduledOperations, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier. *Note:
db_workload
can only be updated from AJD to OLTP or from a free OLTP to AJD.- Map<String,String>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- disaster
Recovery StringRegion Type - Deprecated The disaster recovery (DR) region type of the Autonomous Database. For Serverless Autonomous Databases, DR associations have designated primary (
PRIMARY
) and standby (REMOTE
) regions. These region types do not change when the database changes roles. The standby region in DR associations can be the same region as the primary region, or they can be in a remote regions. Some database administration operations may be available only in the primary region of the DR association, and cannot be performed when the database using the primary role is operating in a remote region. - disaster
Recovery StringType - Indicates the disaster recovery (DR) type of the standby Autonomous Database Serverless instance. Autonomous Data Guard (ADG) DR type provides business critical DR with a faster recovery time objective (RTO) during failover or switchover. Backup-based DR type provides lower cost DR with a slower RTO during failover or switchover.
- display
Name String - (Updatable) The user-friendly name for the Autonomous Database. The name does not have to be unique.
- encryption
Key AutonomousEncryption Key - (Updatable) Details of the Autonomous Database encryption key.
- encryption
Key List<AutonomousHistory Entries Encryption Key History Entry> - Key History Entry.
- failed
Data IntegerRecovery In Seconds - Indicates the number of seconds of data loss for a Data Guard failover.
- Map<String,String>
- (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example:
{"Department": "Finance"}
- in
Memory IntegerArea In Gbs - The area assigned to In-Memory tables in Autonomous Database.
- in
Memory IntegerPercentage - (Updatable) The percentage of the System Global Area(SGA) assigned to In-Memory tables in Autonomous Database. This property is applicable only to Autonomous Databases on the Exadata Cloud@Customer platform.
- infrastructure
Type String - The infrastructure type this resource belongs to.
- is
Access BooleanControl Enabled (Updatable) Indicates if the database-level access control is enabled. If disabled, database access is defined by the network security rules. If enabled, database access is restricted to the IP addresses defined by the rules specified with the
whitelistedIps
property. While specifyingwhitelistedIps
rules is optional, if database-level access control is enabled and no rules are specified, the database will become inaccessible. The rules can be added later using theUpdateAutonomousDatabase
API operation or edit option in console. When creating a database clone, the desired access control setting should be specified. By default, database-level access control will be disabled for the clone.This property is applicable only to Autonomous Databases on the Exadata Cloud@Customer platform. For Autonomous Database Serverless instances,
whitelistedIps
is used.- is
Auto BooleanScaling Enabled - (Updatable) Indicates if auto scaling is enabled for the Autonomous Database CPU core count. The default value is
TRUE
. - is
Auto BooleanScaling For Storage Enabled - (Updatable) Indicates if auto scaling is enabled for the Autonomous Database storage. The default value is
FALSE
. - is
Data BooleanGuard Enabled - (Updatable) Deprecated. Indicates whether the Autonomous Database has local (in-region) Data Guard enabled. Not applicable to cross-region Autonomous Data Guard associations, or to Autonomous Databases using dedicated Exadata infrastructure or Exadata Cloud@Customer infrastructure.
- is
Dedicated Boolean - True if the database is on dedicated Exadata infrastructure.
- is
Dev BooleanTier - (Updatable) Autonomous Database for Developers are free Autonomous Databases that developers can use to build and test new applications.With Autonomous these database instancess instances, you can try new Autonomous Database features for free and apply them to ongoing or new development projects. Developer database comes with limited resources and is, therefore, not suitable for large-scale testing and production deployments. When you need more compute or storage resources, you can transition to a paid database licensing by cloning your developer database into a regular Autonomous Database. See Autonomous Database documentation for more details.
- is
Free BooleanTier - (Updatable) Indicates if this is an Always Free resource. The default value is false. Note that Always Free Autonomous Databases have 1 CPU and 20GB of memory. For Always Free databases, memory and CPU cannot be scaled. When
db_workload
isAJD
orAPEX
it cannot betrue
. - is
Local BooleanData Guard Enabled - (Updatable) Indicates whether the Autonomous Database has local (in-region) Data Guard enabled. It takes boolean values. Not applicable to cross-region Autonomous Data Guard associations, or to Autonomous Databases using dedicated Exadata infrastructure or Exadata Cloud@Customer infrastructure.
- is
Mtls BooleanConnection Required - (Updatable) Indicates whether the Autonomous Database requires mTLS connections.
- is
Preview Boolean - Indicates if the Autonomous Database version is a preview version.
- is
Preview BooleanVersion With Service Terms Accepted - If set to
TRUE
, indicates that an Autonomous Database preview version is being provisioned, and that the preview version's terms of service have been accepted. Note that preview version software is only available for databases on Autonomous Database Serverless. - is
Reconnect BooleanClone Enabled - Indicates if the refreshable clone can be reconnected to its source database.
- is
Refreshable BooleanClone - (Updatable) True for creating a refreshable clone and False for detaching the clone from source Autonomous Database. Detaching is one time operation and clone becomes a regular Autonomous Database.
- is
Remote BooleanData Guard Enabled - Indicates whether the Autonomous Database has Cross Region Data Guard enabled. It takes boolean values. Not applicable to Autonomous Databases using dedicated Exadata infrastructure or Exadata Cloud@Customer infrastructure.
- is
Replicate BooleanAutomatic Backups - If true, 7 days worth of backups are replicated across regions for Cross-Region ADB or Backup-Based DR between Primary and Standby. If false, the backups taken on the Primary are not replicated to the Standby database.
- is
Shrink BooleanOnly (Updatable) An optional property when enabled triggers the Shrinking of Autonomous Database once. To trigger Shrinking of ADB once again, this flag needs to be disabled and re-enabled again. It should not be passed during create database operation. It is only applicable on Serverless databases i.e. where
is_dedicated
is false.** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- key
History List<AutonomousEntries Key History Entry> - Key History Entry.
- key
Store StringId - The OCID of the key store of Oracle Vault. This is used in Autonomous Databases on Serverless instances and dedicated Exadata infrastructure.
- key
Store StringWallet Name - The wallet name for Oracle Key Vault.
- key
Version StringId - The OCID of the key version that is used in rotate key operations.
- kms
Key StringId - The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
- kms
Key StringLifecycle Details - KMS key lifecycle details.
- kms
Key StringVersion Id - The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation. Autonomous Database Serverless does not use key versions, hence is not applicable for Autonomous Database Serverless instances.
- license
Model String - (Updatable) The Oracle license model that applies to the Oracle Autonomous Database. Bring your own license (BYOL) allows you to apply your current on-premises Oracle software licenses to equivalent, highly automated Oracle PaaS and IaaS services in the cloud. License Included allows you to subscribe to new Oracle Database software licenses and the Database service. Note that when provisioning an Autonomous Database on dedicated Exadata infrastructure, this attribute must be null because the attribute is already set at the Autonomous Exadata Infrastructure level. When using shared Exadata infrastructure, if a value is not specified, the system will supply the value of
BRING_YOUR_OWN_LICENSE
. It is a required field whendb_workload
is AJD and needs to be set toLICENSE_INCLUDED
as AJD does not support defaultlicense_model
valueBRING_YOUR_OWN_LICENSE
. - lifecycle
Details String - Additional information about the current lifecycle state.
- local
Adg IntegerAuto Failover Max Data Loss Limit - Parameter that allows users to select an acceptable maximum data loss limit in seconds, up to which Automatic Failover will be triggered when necessary for a Local Autonomous Data Guard
- local
Disaster StringRecovery Type - Indicates the local disaster recovery (DR) type of the Serverless Autonomous Database. Autonomous Data Guard (
ADG
) DR type provides business critical DR with a faster recovery time objective (RTO) during failover or switchover. Backup-based (BACKUP_BASED
) DR type provides lower cost DR with a slower RTO during failover or switchover. - local
Standby List<AutonomousDbs Local Standby Db> - Autonomous Data Guard local (same region) standby database details.
- long
Term List<AutonomousBackup Schedules Long Term Backup Schedule> - Details for the long-term backup schedule.
- max
Cpu IntegerCore Count - (Updatable) Deprecated. The number of Max OCPU cores to be made available to the autonomous database with auto scaling of cpu enabled.
- memory
Per IntegerOracle Compute Unit In Gbs - The amount of memory (in GBs) enabled per OCPU or ECPU. See Compute Models in Autonomous Database on Dedicated Exadata Infrastructure for more details. This parameter is not used for Autonomous database Serverless.
- ncharacter
Set String - The national character set for the autonomous database. The default is AL16UTF16. Allowed values are: AL16UTF16 or UTF8.
- net
Services StringArchitecture - Enabling SHARED server architecture enables a database server to allow many client processes to share very few server processes, thereby increasing the number of supported users.
- next
Long StringTerm Backup Time Stamp - The date and time when the next long-term backup would be created.
- nsg
Ids List<String> - (Updatable) The list of OCIDs for the network security groups (NSGs) to which this resource belongs. Setting this to an empty list removes all resources from all NSGs. For more information about NSGs, see Security Rules. NsgIds restrictions:
- A network security group (NSG) is optional for Autonomous Databases with private access. The nsgIds list can be empty.
- ocpu
Count Double (Updatable) The number of OCPU cores to be made available to the database.
- Providing
computeModel
andcomputeCount
is the preferred method for setting CPUs for both OCPU and ECPU. The following points apply: - For Autonomous Databases on dedicated Exadata infrastructure, to provision less than 1 core, enter a fractional value in an increment of 0.1. For example, you can provision 0.3 or 0.4 cores, but not 0.35 cores. (Note that fractional OCPU values are not supported for Autonomous Databasese on shared Exadata infrastructure.)
- To provision 1 or more cores, you must enter an integer between 1 and the maximum number of cores available for the infrastructure shape. For example, you can provision 2 cores or 3 cores, but not 2.5 cores. This applies to Autonomous Databases on both shared and dedicated Exadata infrastructure.
For Autonomous Databases on dedicated Exadata infrastructure, the maximum number of cores is determined by the infrastructure shape. See Characteristics of Infrastructure Shapes for shape details.
Note: This parameter cannot be used with the
cpuCoreCount
parameter.- Providing
- open
Mode String - Indicates the Autonomous Database mode. The database can be opened in
READ_ONLY
orREAD_WRITE
mode. - operations
Insights StringStatus - (Updatable) Status of Operations Insights for this Autonomous Database. Values supported are
ENABLED
andNOT_ENABLED
- peer
Db List<String>Ids - The list of OCIDs of standby databases located in Autonomous Data Guard remote regions that are associated with the source database. Note that for Autonomous Database Serverless instances, standby databases located in the same region as the source primary database do not have OCIDs.
- permission
Level String - The Autonomous Database permission level. Restricted mode allows access only by admin users.
- private
Endpoint String - The private endpoint for the resource. This parameter is not used in Autonomous Databases using Serverless infrastructure and Exadata Cloud@Customer infrastructure.
- private
Endpoint StringIp - The private endpoint Ip address for the resource.
- private
Endpoint StringLabel - (Updatable) (Optional) (Updatable) The resource's private endpoint label.
- Setting the endpoint label to a non-empty string creates a private endpoint database.
- Resetting the endpoint label to an empty string, after the creation of the private endpoint database, changes the private endpoint database to a public endpoint database.
- Setting the endpoint label to a non-empty string value, updates to a new private endpoint database, when the database is disabled and re-enabled.
- provisionable
Cpuses List<Double> - An array of CPU values that an Autonomous Database can be scaled to.
- public
Connection List<AutonomousUrls Public Connection Url> - The Public URLs of Private Endpoint database for accessing Oracle Application Express (APEX) and SQL Developer Web with a browser from a Compute instance within your VCN or that has a direct connection to your VCN.
- public
Endpoint String - The public endpoint for the private endpoint enabled resource.
- refreshable
Mode String - (Updatable) The refresh mode of the clone. AUTOMATIC indicates that the clone is automatically being refreshed with data from the source Autonomous Database.
- refreshable
Status String - The refresh status of the clone. REFRESHING indicates that the clone is currently being refreshed with data from the source Autonomous Database.
- remote
Disaster List<AutonomousRecovery Configurations Remote Disaster Recovery Configuration> - Configurations of a Disaster Recovery.
- remote
Disaster StringRecovery Type - Indicates the cross-region disaster recovery (DR) type of the standby Autonomous Database Serverless instance. Autonomous Data Guard (ADG) DR type provides business critical DR with a faster recovery time objective (RTO) during failover or switchover. Backup-based DR type provides lower cost DR with a slower RTO during failover or switchover.
- resource
Pool StringLeader Id - (Updatable) The unique identifier for leader autonomous database OCID OCID.
- resource
Pool AutonomousSummary Resource Pool Summary - (Updatable) The configuration details for resource pool
- role String
- The Data Guard role of the Autonomous Container Database or Autonomous Database, if Autonomous Data Guard is enabled.
- rotate
Key BooleanTrigger - (Updatable) An optional property when flipped triggers rotation of KMS key. It is only applicable on dedicated databases i.e. where
is_dedicated
is true. - scheduled
Operations List<AutonomousScheduled Operation> (Updatable) The list of scheduled operations. Consists of values such as dayOfWeek, scheduledStartTime, scheduledStopTime.
This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, whitelistedIps, isMTLSConnectionRequired, openMode, permissionLevel, dbWorkload, privateEndpointLabel, nsgIds, dbVersion, isRefreshable, dbName, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier.
- secret
Id String (Updatable) The Oracle Cloud Infrastructure vault secret [/Content/General/Concepts/identifiers.htm]OCID.
This cannot be used in conjunction with adminPassword.
- secret
Version IntegerNumber - (Updatable) The version of the vault secret. If no version is specified, the latest version will be used.
- security
Attributes Map<String,String> - (Updatable) Security Attributes for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "audit"}}}
- service
Console StringUrl - The URL of the Service Console for the Autonomous Database.
- shrink
Adb IntegerTrigger - source String
The source of the database:
- Use
NONE
for creating a new Autonomous Database. - Use
DATABASE
for creating a new Autonomous Database by cloning an existing running Autonomous Database from the latest timestamp, also provide the source database OCID in thesource_id
parameter. - Use
CROSS_REGION_DATAGUARD
to create a standby Data Guard database in another region, also provide the remote primary database OCID in thesource_id
parameter. - Use
CLONE_TO_REFRESHABLE
for creating a refreshable clone.
For Autonomous Database Serverless instances, the following cloning options are available:
- Use
BACKUP_FROM_ID
for creating a new Autonomous Database by cloning from a specified backup. Also provide the backup OCID in theautonomous_database_backup_id
parameter. - Use
BACKUP_FROM_TIMESTAMP
for creating a point-in-time Autonomous Database clone using backups. Also provide the backup timestamp in thetimestamp
parameter. For more information, see Cloning and Moving an Autonomous Database.
- Use
- source
Id String - The OCID of the source Autonomous Database that will be used to create a new standby database for the Data Guard association.
- standby
Dbs List<AutonomousStandby Db> - Deprecated Autonomous Data Guard standby database details.
- standby
Whitelisted List<String>Ips (Updatable) The client IP access control list (ACL). This feature is available for [Autonomous Database Serverless] (https://docs.oracle.com/en/cloud/paas/autonomous-database/index.html) and on Exadata Cloud@Customer. Only clients connecting from an IP address included in the ACL may access the Autonomous Database instance. If
arePrimaryWhitelistedIpsUsed
is 'TRUE' then Autonomous Database uses this primary's IP access control list (ACL) for the disaster recovery peer calledstandbywhitelistedips
.For Autonomous Database Serverless instances, this is an array of CIDR (Classless Inter-Domain Routing) notations for a subnet or VCN OCID. Use a semicolon (;) as a deliminator between the VCN-specific subnets or IPs. Example:
["1.1.1.1","1.1.1.0/24","ocid1.vcn.oc1.sea.<unique_id>","ocid1.vcn.oc1.sea.<unique_id1>;1.1.1.1","ocid1.vcn.oc1.sea.<unique_id2>;1.1.0.0/16"]
For Exadata Cloud@Customer, this is an array of IP addresses or CIDR (Classless Inter-Domain Routing) notations. Example:["1.1.1.1","1.1.1.0/24","1.1.2.25"]
For an update operation, if you want to delete all the IPs in the ACL, use an array with a single empty string entry.
If
arePrimaryWhitelistedIpsUsed
is 'TRUE' then Autonomous Database useswhitelisted_ips
primary's IP access control list (ACL) asstandbywhitelistedips
for the disaster recovery peer.This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, isMTLSConnectionRequired, openMode, permissionLevel, dbWorkload, dbVersion, isRefreshable, dbName, scheduledOperations, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier.
- state String
- The current state of the Autonomous Database.
- subnet
Id String (Updatable) The OCID of the subnet the resource is associated with. This the only parameter to configure private endpoint, VCN details are obtained from the
subnet_id
.Subnet Restrictions:
- For bare metal DB systems and for single node virtual machine DB systems, do not use a subnet that overlaps with 192.168.16.16/28.
- For Exadata and virtual machine 2-node RAC systems, do not use a subnet that overlaps with 192.168.128.0/20.
- For Autonomous Database, setting this will disable public secure access to the database.
- subscription
Id String - The OCID of the subscription with which resource needs to be associated with. These subnets are used by the Oracle Clusterware private interconnect on the database instance. Specifying an overlapping subnet will cause the private interconnect to malfunction. This restriction applies to both the client subnet and the backup subnet.
- supported
Regions List<String>To Clone Tos - The list of regions that support the creation of an Autonomous Database clone or an Autonomous Data Guard standby database.
- switchover
To String - It is applicable only when
is_local_data_guard_enabled
is true. Could be set toPRIMARY
orSTANDBY
. Default value isPRIMARY
. - switchover
To StringRemote Peer Id - (Updatable) It is applicable only when
dataguard_region_type
androle
are set, andis_dedicated
is false. For Autonomous Database Serverless instances, Data Guard associations have designated primary and standby regions, and these region types do not change when the database changes roles. It takes the OCID of the remote peer to switchover to and the API is called from the remote region. - Map<String,String>
- System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- time
Created String - The date and time the Autonomous Database was created.
- time
Data StringGuard Role Changed - The date and time the Autonomous Data Guard role was switched for the Autonomous Database. For databases that have standbys in both the primary Data Guard region and a remote Data Guard standby region, this is the latest timestamp of either the database using the "primary" role in the primary Data Guard region, or database located in the remote Data Guard standby region.
- time
Deletion StringOf Free Autonomous Database - The date and time the Always Free database will be automatically deleted because of inactivity. If the database is in the STOPPED state and without activity until this time, it will be deleted.
- time
Disaster StringRecovery Role Changed - The date and time the Disaster Recovery role was switched for the standby Autonomous Database.
- time
Local StringData Guard Enabled - The date and time that Autonomous Data Guard was enabled for an Autonomous Database where the standby was provisioned in the same region as the primary database.
- time
Maintenance StringBegin - The date and time when maintenance will begin.
- time
Maintenance StringEnd - The date and time when maintenance will end.
- time
Of StringAuto Refresh Start - The the date and time that auto-refreshing will begin for an Autonomous Database refreshable clone. This value controls only the start time for the first refresh operation. Subsequent (ongoing) refresh operations have start times controlled by the value of the
autoRefreshFrequencyInSeconds
parameter. - time
Of StringJoining Resource Pool - time
Of StringLast Failover - The timestamp of the last failover operation.
- time
Of StringLast Refresh - The date and time when last refresh happened.
- time
Of StringLast Refresh Point - The refresh point timestamp (UTC). The refresh point is the time to which the database was most recently refreshed. Data created after the refresh point is not included in the refresh.
- time
Of StringLast Switchover - The timestamp of the last switchover operation for the Autonomous Database.
- time
Of StringNext Refresh - The date and time of next refresh.
- time
Reclamation StringOf Free Autonomous Database - The date and time the Always Free database will be stopped because of inactivity. If this time is reached without any database activity, the database will automatically be put into the STOPPED state.
- time
Undeleted String - time
Until StringReconnect Clone Enabled - The time and date as an RFC3339 formatted string, e.g., 2022-01-01T12:00:00.000Z, to set the limit for a refreshable clone to be reconnected to its source database.
- timestamp String
- The timestamp specified for the point-in-time clone of the source Autonomous Database. The timestamp must be in the past.
- total
Backup DoubleStorage Size In Gbs - The backup storage to the database.
- use
Latest BooleanAvailable Backup Time Stamp - Clone from latest available backup timestamp.
- used
Data IntegerStorage Size In Gbs - The storage space consumed by Autonomous Database in GBs.
- used
Data IntegerStorage Size In Tbs - The amount of storage that has been used, in terabytes.
- vault
Id String - The OCID of the Oracle Cloud Infrastructure vault.
- whitelisted
Ips List<String> (Updatable) The client IP access control list (ACL). This feature is available for autonomous databases on shared Exadata infrastructure and on Exadata Cloud@Customer. Only clients connecting from an IP address included in the ACL may access the Autonomous Database instance.
For Autonomous Database Serverless instances, this is an array of CIDR (Classless Inter-Domain Routing) notations for a subnet or VCN OCID. Use a semicolon (;) as a deliminator between the VCN-specific subnets or IPs. Example:
["1.1.1.1","1.1.1.0/24","ocid1.vcn.oc1.sea.<unique_id>","ocid1.vcn.oc1.sea.<unique_id1>;1.1.1.1","ocid1.vcn.oc1.sea.<unique_id2>;1.1.0.0/16"]
For Exadata Cloud@Customer, this is an array of IP addresses or CIDR (Classless Inter-Domain Routing) notations. Example:["1.1.1.1","1.1.1.0/24","1.1.2.25"]
For an update operation, if you want to delete all the IPs in the ACL, use an array with a single empty string entry.
This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, isMTLSConnectionRequired, openMode, permissionLevel, dbWorkload, dbVersion, isRefreshable, dbName, scheduledOperations, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier. To remove all whitelisted IPs, set the field to a list with an empty string
[""]
.
- actual
Used numberData Storage Size In Tbs - The current amount of storage in use for user and system data, in terabytes (TB).
- admin
Password string - (Updatable) The password must be between 12 and 30 characters long, and must contain at least 1 uppercase, 1 lowercase, and 1 numeric character. It cannot contain the double quote symbol (") or the username "admin", regardless of casing. The password is mandatory if source value is "BACKUP_FROM_ID", "BACKUP_FROM_TIMESTAMP", "DATABASE" or "NONE".
- allocated
Storage numberSize In Tbs - The amount of storage currently allocated for the database tables and billed for, rounded up. When auto-scaling is not enabled, this value is equal to the
dataStorageSizeInTBs
value. You can compare this value to theactualUsedDataStorageSizeInTBs
value to determine if a manual shrink operation is appropriate for your allocated storage. - apex
Details AutonomousDatabase Apex Detail[] - Information about Oracle APEX Application Development.
- are
Primary booleanWhitelisted Ips Used - (Updatable) This field will be null if the Autonomous Database is not Data Guard enabled or Access Control is disabled. It's value would be
TRUE
if Autonomous Database is Data Guard enabled and Access Control is enabled and if the Autonomous Database uses primary IP access control list (ACL) for standby. It's value would beFALSE
if Autonomous Database is Data Guard enabled and Access Control is enabled and if the Autonomous Database uses different IP access control list (ACL) for standby compared to primary. - auto
Refresh numberFrequency In Seconds - (Updatable) The frequency a refreshable clone is refreshed after auto-refresh is enabled. The minimum is 1 hour. The maximum is 7 days. The date and time that auto-refresh is enabled is controlled by the
timeOfAutoRefreshStart
parameter. - auto
Refresh numberPoint Lag In Seconds - (Updatable) The time, in seconds, the data of the refreshable clone lags the primary database at the point of refresh. The minimum is 0 minutes (0 mins means refresh to the latest available timestamp). The maximum is 7 days. The lag time increases after refreshing until the next data refresh happens.
- autonomous
Container stringDatabase Id - The Autonomous Container Database OCID.
- autonomous
Database stringBackup Id - The OCID of the source Autonomous Database Backup that you will clone to create a new Autonomous Database.
- autonomous
Database stringId - The OCID of the source Autonomous Database that you will clone to create a new Autonomous Database.