@Generated(value="OracleSDKGenerator",
comments="API Version: 20160918")
public class CreateAutonomousDatabaseBase
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
Details to create an Oracle Autonomous Database.
**Notes:** - To specify OCPU core count, you must use either ocpuCount or cpuCoreCount. You cannot use both parameters at the same time. For Autonomous Database
Serverless instances, ocpuCount is not used. - To specify a storage allocation, you must
use either dataStorageSizeInGBs or dataStorageSizeInTBs. - See the individual
parameter discriptions for more information on the OCPU and storage value parameters.
**Warning:** Oracle recommends that you avoid using any confidential information when you
supply string values using the API.
Note: Objects should always be created or deserialized using the Builder. This model
distinguishes fields that are null because they are unset from fields that are explicitly
set to null. This is done in the setter methods of the Builder, which maintain a
set of all explicitly set fields called Builder#__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set
fields into account. The constructor, on the other hand, does not take the explicitly set fields
into account (since the constructor cannot distinguish explicit null from unset null).
| Modifier and Type | Class and Description |
|---|---|
static class |
CreateAutonomousDatabaseBase.AutonomousMaintenanceScheduleType
The maintenance schedule type of the Autonomous Database Serverless.
|
static class |
CreateAutonomousDatabaseBase.ComputeModel
The compute model of the Autonomous Database.
|
static class |
CreateAutonomousDatabaseBase.DbWorkload
The Autonomous Database workload type.
|
static class |
CreateAutonomousDatabaseBase.LicenseModel
The Oracle license model that applies to the Oracle Autonomous Database.
|
static class |
CreateAutonomousDatabaseBase.Source
The source of the database: Use
NONE for creating a new Autonomous Database. |
EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME| Modifier | Constructor and Description |
|---|---|
protected |
CreateAutonomousDatabaseBase(String subscriptionId,
String compartmentId,
String characterSet,
String ncharacterSet,
String dbName,
Integer cpuCoreCount,
Integer backupRetentionPeriodInDays,
CreateAutonomousDatabaseBase.ComputeModel computeModel,
Float computeCount,
Float ocpuCount,
CreateAutonomousDatabaseBase.DbWorkload dbWorkload,
Integer dataStorageSizeInTBs,
Integer dataStorageSizeInGBs,
Boolean isFreeTier,
String kmsKeyId,
String vaultId,
AutonomousDatabaseEncryptionKeyDetails encryptionKey,
String adminPassword,
String displayName,
CreateAutonomousDatabaseBase.LicenseModel licenseModel,
Float byolComputeCountLimit,
Boolean isPreviewVersionWithServiceTermsAccepted,
Boolean isAutoScalingEnabled,
Boolean isDevTier,
Boolean isDedicated,
String autonomousContainerDatabaseId,
Integer inMemoryPercentage,
Boolean isAccessControlEnabled,
List<String> whitelistedIps,
Boolean arePrimaryWhitelistedIpsUsed,
List<String> standbyWhitelistedIps,
Boolean isDataGuardEnabled,
Boolean isLocalDataGuardEnabled,
String subnetId,
List<String> nsgIds,
String privateEndpointLabel,
Map<String,String> freeformTags,
Map<String,Map<String,Object>> definedTags,
Map<String,Map<String,Object>> securityAttributes,
String privateEndpointIp,
String dbVersion,
List<CustomerContact> customerContacts,
Boolean isMtlsConnectionRequired,
String resourcePoolLeaderId,
ResourcePoolSummary resourcePoolSummary,
CreateAutonomousDatabaseBase.AutonomousMaintenanceScheduleType autonomousMaintenanceScheduleType,
List<ScheduledOperationDetails> scheduledOperations,
Boolean isAutoScalingForStorageEnabled,
AutonomousDatabaseSummary.DatabaseEdition databaseEdition,
List<DatabaseTool> dbToolsDetails,
String secretId,
Integer secretVersionNumber)
Deprecated.
|
| Modifier and Type | Method and Description |
|---|---|
boolean |
equals(Object o) |
String |
getAdminPassword()
Important The
adminPassword or secretId must be specified for all
Autonomous Databases except for refreshable clones. |
Boolean |
getArePrimaryWhitelistedIpsUsed()
This field will be null if the Autonomous Database is not Data Guard enabled or Access
Control is disabled.
|
String |
getAutonomousContainerDatabaseId()
The Autonomous Container Database
OCID.
|
CreateAutonomousDatabaseBase.AutonomousMaintenanceScheduleType |
getAutonomousMaintenanceScheduleType()
The maintenance schedule type of the Autonomous Database Serverless.
|
Integer |
getBackupRetentionPeriodInDays()
Retention period, in days, for long-term backups
|
Float |
getByolComputeCountLimit()
The maximum number of CPUs allowed with a Bring Your Own License (BYOL), including those used
for auto-scaling, disaster recovery, tools, etc.
|
String |
getCharacterSet()
The character set for the autonomous database.
|
String |
getCompartmentId()
The OCID of the
compartment of the Autonomous Database.
|
Float |
getComputeCount()
The compute amount (CPUs) available to the database.
|
CreateAutonomousDatabaseBase.ComputeModel |
getComputeModel()
The compute model of the Autonomous Database.
|
Integer |
getCpuCoreCount()
The number of CPU cores to be made available to the database.
|
List<CustomerContact> |
getCustomerContacts()
Customer Contacts.
|
AutonomousDatabaseSummary.DatabaseEdition |
getDatabaseEdition()
The Oracle Database Edition that applies to the Autonomous databases.
|
Integer |
getDataStorageSizeInGBs()
The size, in gigabytes, of the data volume that will be created and attached to the database.
|
Integer |
getDataStorageSizeInTBs()
The size, in terabytes, of the data volume that will be created and attached to the database.
|
String |
getDbName()
The database name.
|
List<DatabaseTool> |
getDbToolsDetails()
The list of database tools details.
|
String |
getDbVersion()
A valid Oracle Database version for Autonomous Database.
|
CreateAutonomousDatabaseBase.DbWorkload |
getDbWorkload()
The Autonomous Database workload type.
|
Map<String,Map<String,Object>> |
getDefinedTags()
Defined tags for this resource.
|
String |
getDisplayName()
The user-friendly name for the Autonomous Database.
|
AutonomousDatabaseEncryptionKeyDetails |
getEncryptionKey() |
Map<String,String> |
getFreeformTags()
Free-form tags for this resource.
|
Integer |
getInMemoryPercentage()
The percentage of the System Global Area(SGA) assigned to In-Memory tables in Autonomous
Database.
|
Boolean |
getIsAccessControlEnabled()
Indicates if the database-level access control is enabled.
|
Boolean |
getIsAutoScalingEnabled()
Indicates if auto scaling is enabled for the Autonomous Database CPU core count.
|
Boolean |
getIsAutoScalingForStorageEnabled()
Indicates if auto scaling is enabled for the Autonomous Database storage.
|
Boolean |
getIsDataGuardEnabled()
Deprecated. Indicates whether the Autonomous Database has local (in-region) Data Guard
enabled.
|
Boolean |
getIsDedicated()
True if the database is on dedicated Exadata
infrastructure.
|
Boolean |
getIsDevTier()
Autonomous Database for Developers are fixed-shape Autonomous Databases that developers can
use to build and test new applications.
|
Boolean |
getIsFreeTier()
Indicates if this is an Always Free resource.
|
Boolean |
getIsLocalDataGuardEnabled()
Indicates whether the Autonomous Database has local (in-region) Data Guard enabled.
|
Boolean |
getIsMtlsConnectionRequired()
Specifies if the Autonomous Database requires mTLS connections.
|
Boolean |
getIsPreviewVersionWithServiceTermsAccepted()
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. |
String |
getKmsKeyId()
The OCID of the key container that is used as the master encryption key in database
transparent data encryption (TDE) operations.
|
CreateAutonomousDatabaseBase.LicenseModel |
getLicenseModel()
The Oracle license model that applies to the Oracle Autonomous Database.
|
String |
getNcharacterSet()
The character set for the Autonomous Database.
|
List<String> |
getNsgIds()
The list of OCIDs
for the network security groups (NSGs) to which this resource belongs.
|
Float |
getOcpuCount()
The number of OCPU cores to be made available to the database.
|
String |
getPrivateEndpointIp()
The private endpoint Ip address for the resource.
|
String |
getPrivateEndpointLabel()
The resource’s private endpoint label.
|
String |
getResourcePoolLeaderId()
The unique identifier for leader autonomous database OCID
OCID.
|
ResourcePoolSummary |
getResourcePoolSummary() |
List<ScheduledOperationDetails> |
getScheduledOperations()
The list of scheduled operations.
|
String |
getSecretId()
The OCI vault secret [/Content/General/Concepts/identifiers.htm]OCID.
|
Integer |
getSecretVersionNumber()
The version of the vault secret.
|
Map<String,Map<String,Object>> |
getSecurityAttributes()
Security Attributes for this resource.
|
List<String> |
getStandbyWhitelistedIps()
The client IP access control list (ACL).
|
String |
getSubnetId()
The OCID of the
subnet the resource is associated with.
|
String |
getSubscriptionId()
The OCID of the
subscription with which resource needs to be associated with.
|
String |
getVaultId()
|
List<String> |
getWhitelistedIps()
The client IP access control list (ACL).
|
int |
hashCode() |
String |
toString() |
String |
toString(boolean includeByteArrayContents)
Return a string representation of the object.
|
markPropertyAsExplicitlySet, wasPropertyExplicitlySet@Deprecated @ConstructorProperties(value={"subscriptionId","compartmentId","characterSet","ncharacterSet","dbName","cpuCoreCount","backupRetentionPeriodInDays","computeModel","computeCount","ocpuCount","dbWorkload","dataStorageSizeInTBs","dataStorageSizeInGBs","isFreeTier","kmsKeyId","vaultId","encryptionKey","adminPassword","displayName","licenseModel","byolComputeCountLimit","isPreviewVersionWithServiceTermsAccepted","isAutoScalingEnabled","isDevTier","isDedicated","autonomousContainerDatabaseId","inMemoryPercentage","isAccessControlEnabled","whitelistedIps","arePrimaryWhitelistedIpsUsed","standbyWhitelistedIps","isDataGuardEnabled","isLocalDataGuardEnabled","subnetId","nsgIds","privateEndpointLabel","freeformTags","definedTags","securityAttributes","privateEndpointIp","dbVersion","customerContacts","isMtlsConnectionRequired","resourcePoolLeaderId","resourcePoolSummary","autonomousMaintenanceScheduleType","scheduledOperations","isAutoScalingForStorageEnabled","databaseEdition","dbToolsDetails","secretId","secretVersionNumber"}) protected CreateAutonomousDatabaseBase(String subscriptionId, String compartmentId, String characterSet, String ncharacterSet, String dbName, Integer cpuCoreCount, Integer backupRetentionPeriodInDays, CreateAutonomousDatabaseBase.ComputeModel computeModel, Float computeCount, Float ocpuCount, CreateAutonomousDatabaseBase.DbWorkload dbWorkload, Integer dataStorageSizeInTBs, Integer dataStorageSizeInGBs, Boolean isFreeTier, String kmsKeyId, String vaultId, AutonomousDatabaseEncryptionKeyDetails encryptionKey, String adminPassword, String displayName, CreateAutonomousDatabaseBase.LicenseModel licenseModel, Float byolComputeCountLimit, Boolean isPreviewVersionWithServiceTermsAccepted, Boolean isAutoScalingEnabled, Boolean isDevTier, Boolean isDedicated, String autonomousContainerDatabaseId, Integer inMemoryPercentage, Boolean isAccessControlEnabled, List<String> whitelistedIps, Boolean arePrimaryWhitelistedIpsUsed, List<String> standbyWhitelistedIps, Boolean isDataGuardEnabled, Boolean isLocalDataGuardEnabled, String subnetId, List<String> nsgIds, String privateEndpointLabel, Map<String,String> freeformTags, Map<String,Map<String,Object>> definedTags, Map<String,Map<String,Object>> securityAttributes, String privateEndpointIp, String dbVersion, List<CustomerContact> customerContacts, Boolean isMtlsConnectionRequired, String resourcePoolLeaderId, ResourcePoolSummary resourcePoolSummary, CreateAutonomousDatabaseBase.AutonomousMaintenanceScheduleType autonomousMaintenanceScheduleType, List<ScheduledOperationDetails> scheduledOperations, Boolean isAutoScalingForStorageEnabled, AutonomousDatabaseSummary.DatabaseEdition databaseEdition, List<DatabaseTool> dbToolsDetails, String secretId, Integer secretVersionNumber)
public String getSubscriptionId()
The OCID of the subscription with which resource needs to be associated with.
public String getCompartmentId()
The OCID of the compartment of the Autonomous Database.
public String getCharacterSet()
The character set for the autonomous database. The default is AL32UTF8. Allowed values for an Autonomous Database Serverless instance as 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
public String getNcharacterSet()
The character set for the Autonomous Database. The default is AL32UTF8. Use List Autonomous Database Character Sets to list the allowed values for an Autonomous Database Serverless instance. For an Autonomous Database on dedicated Exadata infrastructure, the allowed values are: AL16UTF16 or UTF8.
public String getDbName()
The database name. The name must begin with an alphabetic character and can contain a maximum of 30 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.
public Integer getCpuCoreCount()
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.
public Integer getBackupRetentionPeriodInDays()
Retention period, in days, for long-term backups
public CreateAutonomousDatabaseBase.ComputeModel getComputeModel()
The compute model of the Autonomous Database. This is required if using the computeCount parameter. If using cpuCoreCount then it is an error to specify computeModel to a non-null value. ECPU compute model is the recommended model and OCPU
compute model is legacy.
public Float getComputeCount()
The compute amount (CPUs) 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 using cpuCoreCount parameter, it is an error to
specify computeCount to a non-null value. Providing computeModel and computeCount is the preferred method for both OCPU and ECPU.
public Float getOcpuCount()
The number of OCPU cores to be made available to the database.
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 Database Serverless instances.) - 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 an Autonomous Database Serverless instance or an Autonomous Database on Dedicated Exadata Infrastructure. - For Autonomous Database Serverless instances, this parameter is not used.
For Autonomous Databases on Dedicated Exadata infrastructure, the maximum number of cores is determined by the infrastructure shape. See [Characteristics of Infrastructure Shapes](https://www.oracle.com/pls/topic/lookup?ctx=en/cloud/paas/autonomous-database&id=ATPFG-GUID-B0F033C1-CC5A-42F0-B2E7-3CECFEDA1FD1) for shape details.
*Note:** This parameter cannot be used with the cpuCoreCount parameter.
public CreateAutonomousDatabaseBase.DbWorkload getDbWorkload()
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.
public Integer getDataStorageSizeInTBs()
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.
public Integer getDataStorageSizeInGBs()
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.
public Boolean getIsFreeTier()
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.
This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, isMTLSConnectionRequired, openMode, permissionLevel, privateEndpointLabel, nsgIds, dbVersion, isRefreshable, dbName, scheduledOperations, dbToolsDetails, or isLocalDataGuardEnabled
public String getKmsKeyId()
The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
public String getVaultId()
The OCID of the
Oracle Cloud Infrastructure
vault.
This parameter and secretId are required for Customer Managed Keys.
public AutonomousDatabaseEncryptionKeyDetails getEncryptionKey()
public String getAdminPassword()
Important The adminPassword or secretId must be specified for all
Autonomous Databases except for refreshable clones. 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.
This cannot be used in conjunction with with OCI vault secrets (secretId).
public String getDisplayName()
The user-friendly name for the Autonomous Database. The name does not have to be unique.
public CreateAutonomousDatabaseBase.LicenseModel getLicenseModel()
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 services in the cloud. License Included allows you to
subscribe to new Oracle Database software licenses and the Oracle Database service. Note that
when provisioning an Autonomous Database on dedicated Exadata
infrastructure, this
attribute must be null. It is already set at the Autonomous Exadata Infrastructure level.
When provisioning an [Autonomous Database Serverless]
(https://docs.oracle.com/en/cloud/paas/autonomous-database/index.html) database, if a value
is not specified, the system defaults the value to BRING_YOUR_OWN_LICENSE. Bring your
own license (BYOL) also allows you to select the DB edition using the optional parameter.
This cannot be updated in parallel with any of the following: cpuCoreCount, computeCount, dataStorageSizeInTBs, adminPassword, isMTLSConnectionRequired, dbWorkload, privateEndpointLabel, nsgIds, dbVersion, dbName, scheduledOperations, dbToolsDetails, or isFreeTier.
public Float getByolComputeCountLimit()
The maximum number of CPUs allowed with a Bring Your Own License (BYOL), including those used for auto-scaling, disaster recovery, tools, etc. Any CPU usage above this limit is considered as License Included and billed.
public Boolean getIsPreviewVersionWithServiceTermsAccepted()
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 Autonomous Database Serverless instances
(https://docs.oracle.com/en/cloud/paas/autonomous-database/serverless/).
public Boolean getIsAutoScalingEnabled()
Indicates if auto scaling is enabled for the Autonomous Database CPU core count. The default
value is TRUE.
public Boolean getIsDevTier()
Autonomous Database for Developers are fixed-shape Autonomous Databases that developers can use to build and test new applications. On Serverless, these are low-cost and billed per instance, on Dedicated and Cloud@Customer there is no additional cost to create Developer databases. Developer databases come with limited resources and is not intended for large-scale testing and production deployments. When you need more compute or storage resources, you may upgrade to a full paid production database.
public Boolean getIsDedicated()
True if the database is on dedicated Exadata infrastructure.
public String getAutonomousContainerDatabaseId()
The Autonomous Container Database OCID. Used only by Autonomous Database on Dedicated Exadata Infrastructure.
public Integer getInMemoryPercentage()
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.
public Boolean getIsAccessControlEnabled()
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
specifying whitelistedIps 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 the UpdateAutonomousDatabase 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.
public List<String> getWhitelistedIps()
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 called standbywhitelistedips.
For Autonomous Database Serverless, this is an array of CIDR (classless inter-domain
routing) notations for a subnet or VCN OCID (virtual cloud network Oracle Cloud ID). Multiple
IPs and VCN OCIDs should be separate strings separated by commas, but if it’s other
configurations that need multiple pieces of information then its each piece is connected with
semicolon (;) as a delimiter. 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 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.
public Boolean getArePrimaryWhitelistedIpsUsed()
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 be FALSE 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.
public List<String> getStandbyWhitelistedIps()
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 called standbywhitelistedips.
For Autonomous Database Serverless, this is an array of CIDR (classless inter-domain
routing) notations for a subnet or VCN OCID (virtual cloud network Oracle Cloud ID). Multiple
IPs and VCN OCIDs should be separate strings separated by commas, but if it’s other
configurations that need multiple pieces of information then its each piece is connected with
semicolon (;) as a delimiter. 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 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.
public Boolean getIsDataGuardEnabled()
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.
public Boolean getIsLocalDataGuardEnabled()
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.
public String getSubnetId()
The OCID of the subnet the resource is associated with.
*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.
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.
public List<String> getNsgIds()
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.
public String getPrivateEndpointLabel()
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.
This setting cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, isMTLSConnectionRequired, dbWorkload, dbVersion, isRefreshable, dbName, scheduledOperations, dbToolsDetails, or isFreeTier.
public Map<String,String> getFreeformTags()
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"}
public Map<String,Map<String,Object>> getDefinedTags()
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
public Map<String,Map<String,Object>> getSecurityAttributes()
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"}}}
public String getPrivateEndpointIp()
The private endpoint Ip address for the resource.
public String getDbVersion()
A valid Oracle Database version for Autonomous Database.
public List<CustomerContact> getCustomerContacts()
Customer Contacts.
public Boolean getIsMtlsConnectionRequired()
Specifies if the Autonomous Database requires mTLS connections.
This may not be updated in parallel with any of the following: licenseModel, databaseEdition, cpuCoreCount, computeCount, dataStorageSizeInTBs, whitelistedIps, openMode, permissionLevel, db-workload, privateEndpointLabel, nsgIds, customerContacts, dbVersion, scheduledOperations, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier.
Service Change: The default value of the isMTLSConnectionRequired attribute will change from true to false on July 1, 2023 in the following APIs: - CreateAutonomousDatabase - GetAutonomousDatabase - UpdateAutonomousDatabase Details: Prior to the July 1, 2023 change, the isMTLSConnectionRequired attribute default value was true. This applies to Autonomous Database Serverless. Does this impact me? If you use or maintain custom scripts or Terraform scripts referencing the CreateAutonomousDatabase, GetAutonomousDatabase, or UpdateAutonomousDatabase APIs, you want to check, and possibly modify, the scripts for the changed default value of the attribute. Should you choose not to leave your scripts unchanged, the API calls containing this attribute will continue to work, but the default value will switch from true to false. How do I make this change? Using either OCI SDKs or command line tools, update your custom scripts to explicitly set the isMTLSConnectionRequired attribute to true.
public String getResourcePoolLeaderId()
The unique identifier for leader autonomous database OCID OCID.
public ResourcePoolSummary getResourcePoolSummary()
public CreateAutonomousDatabaseBase.AutonomousMaintenanceScheduleType getAutonomousMaintenanceScheduleType()
The maintenance schedule type of the Autonomous Database Serverless. An EARLY maintenance schedule follows a schedule applying patches prior to the REGULAR schedule. A REGULAR maintenance schedule follows the normal cycle
public List<ScheduledOperationDetails> getScheduledOperations()
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.
public Boolean getIsAutoScalingForStorageEnabled()
Indicates if auto scaling is enabled for the Autonomous Database storage. The default value
is FALSE.
public AutonomousDatabaseSummary.DatabaseEdition getDatabaseEdition()
The Oracle Database Edition that applies to the Autonomous databases. This parameter accepts
options STANDARD_EDITION and ENTERPRISE_EDITION.
public List<DatabaseTool> getDbToolsDetails()
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.
public String getSecretId()
The OCI vault secret [/Content/General/Concepts/identifiers.htm]OCID.
This cannot be used in conjunction with adminPassword.
public Integer getSecretVersionNumber()
The version of the vault secret. If no version is specified, the latest version will be used.
public String toString()
toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelpublic String toString(boolean includeByteArrayContents)
Return a string representation of the object.
includeByteArrayContents - true to include the full contents of byte arrayspublic boolean equals(Object o)
equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelpublic int hashCode()
hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelCopyright © 2016–2024. All rights reserved.