Package com.oracle.bmc.database.model

Class AutonomousDatabase.Builder

    • Constructor Detail

      • Builder

        public Builder()

    • Method Detail

      • compartmentId

        public AutonomousDatabase.Builder compartmentId​(String compartmentId)
        The OCID of the compartment.
        Parameters:
        compartmentId - the value to set
        Returns:
        this builder

      • subscriptionId

        public AutonomousDatabase.Builder subscriptionId​(String subscriptionId)
        The OCID of the subscription with which resource needs to be associated with.
        Parameters:
        subscriptionId - the value to set
        Returns:
        this builder

      • lifecycleDetails

        public AutonomousDatabase.Builder lifecycleDetails​(String lifecycleDetails)
        Information about the current lifecycle state.
        Parameters:
        lifecycleDetails - the value to set
        Returns:
        this builder

      • kmsKeyId

        public AutonomousDatabase.Builder kmsKeyId​(String kmsKeyId)
        The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
        Parameters:
        kmsKeyId - the value to set
        Returns:
        this builder

      • vaultId

        public AutonomousDatabase.Builder vaultId​(String vaultId)
        The OCID of the Oracle Cloud Infrastructure vault.

        This parameter and secretId are required for Customer Managed Keys.

        Parameters:
        vaultId - the value to set
        Returns:
        this builder

      • kmsKeyLifecycleDetails

        public AutonomousDatabase.Builder kmsKeyLifecycleDetails​(String kmsKeyLifecycleDetails)
        KMS key lifecycle details.
        Parameters:
        kmsKeyLifecycleDetails - the value to set
        Returns:
        this builder

      • kmsKeyVersionId

        public AutonomousDatabase.Builder kmsKeyVersionId​(String kmsKeyVersionId)
        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.

        Parameters:
        kmsKeyVersionId - the value to set
        Returns:
        this builder

      • characterSet

        public AutonomousDatabase.Builder characterSet​(String characterSet)
        The character set for the autonomous database.

        The default is AL32UTF8. 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

        Parameters:
        characterSet - the value to set
        Returns:
        this builder

      • ncharacterSet

        public AutonomousDatabase.Builder ncharacterSet​(String ncharacterSet)
        The national character set for the autonomous database.

        The default is AL16UTF16. Allowed values are: AL16UTF16 or UTF8.

        Parameters:
        ncharacterSet - the value to set
        Returns:
        this builder

      • inMemoryPercentage

        public AutonomousDatabase.Builder inMemoryPercentage​(Integer inMemoryPercentage)
        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.

        Parameters:
        inMemoryPercentage - the value to set
        Returns:
        this builder

      • inMemoryAreaInGBs

        public AutonomousDatabase.Builder inMemoryAreaInGBs​(Integer inMemoryAreaInGBs)
        The area assigned to In-Memory tables in Autonomous Database.
        Parameters:
        inMemoryAreaInGBs - the value to set
        Returns:
        this builder

      • nextLongTermBackupTimeStamp

        public AutonomousDatabase.Builder nextLongTermBackupTimeStamp​(Date nextLongTermBackupTimeStamp)
        The date and time when the next long-term backup would be created.
        Parameters:
        nextLongTermBackupTimeStamp - the value to set
        Returns:
        this builder

      • isFreeTier

        public AutonomousDatabase.Builder isFreeTier​(Boolean isFreeTier)
        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

        Parameters:
        isFreeTier - the value to set
        Returns:
        this builder

      • timeReclamationOfFreeAutonomousDatabase

        public AutonomousDatabase.Builder timeReclamationOfFreeAutonomousDatabase​(Date timeReclamationOfFreeAutonomousDatabase)
        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.

        Parameters:
        timeReclamationOfFreeAutonomousDatabase - the value to set
        Returns:
        this builder

      • timeDeletionOfFreeAutonomousDatabase

        public AutonomousDatabase.Builder timeDeletionOfFreeAutonomousDatabase​(Date timeDeletionOfFreeAutonomousDatabase)
        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.

        Parameters:
        timeDeletionOfFreeAutonomousDatabase - the value to set
        Returns:
        this builder

      • cpuCoreCount

        public AutonomousDatabase.Builder cpuCoreCount​(Integer cpuCoreCount)
        The number of CPU cores to be made available to the database.

        When the ECPU is selected, the value for cpuCoreCount is 0. For Autonomous Database 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.

        Parameters:
        cpuCoreCount - the value to set
        Returns:
        this builder

      • localAdgAutoFailoverMaxDataLossLimit

        public AutonomousDatabase.Builder localAdgAutoFailoverMaxDataLossLimit​(Integer localAdgAutoFailoverMaxDataLossLimit)
        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
        Parameters:
        localAdgAutoFailoverMaxDataLossLimit - the value to set
        Returns:
        this builder

      • computeModel

        public AutonomousDatabase.Builder computeModel​(AutonomousDatabase.ComputeModel computeModel)
        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.

        Parameters:
        computeModel - the value to set
        Returns:
        this builder

      • computeCount

        public AutonomousDatabase.Builder computeCount​(Float computeCount)
        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. 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.

        Parameters:
        computeCount - the value to set
        Returns:
        this builder

      • backupRetentionPeriodInDays

        public AutonomousDatabase.Builder backupRetentionPeriodInDays​(Integer backupRetentionPeriodInDays)
        Retention period, in days, for long-term backups
        Parameters:
        backupRetentionPeriodInDays - the value to set
        Returns:
        this builder

      • totalBackupStorageSizeInGBs

        public AutonomousDatabase.Builder totalBackupStorageSizeInGBs​(Double totalBackupStorageSizeInGBs)
        The backup storage to the database.
        Parameters:
        totalBackupStorageSizeInGBs - the value to set
        Returns:
        this builder

      • ocpuCount

        public AutonomousDatabase.Builder ocpuCount​(Float ocpuCount)
        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 cores, 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 serverless and 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://docs.oracle.com/en/cloud/paas/autonomous-database/dedicated/adbde/index.html) for shape details.

        *Note:** This parameter cannot be used with the cpuCoreCount parameter.

        Parameters:
        ocpuCount - the value to set
        Returns:
        this builder

      • provisionableCpus

        public AutonomousDatabase.Builder provisionableCpus​(List<Float> provisionableCpus)
        An array of CPU values that an Autonomous Database can be scaled to.
        Parameters:
        provisionableCpus - the value to set
        Returns:
        this builder

      • dataStorageSizeInTBs

        public AutonomousDatabase.Builder dataStorageSizeInTBs​(Integer dataStorageSizeInTBs)
        The quantity of data in the database, in terabytes.

        The following points apply to Autonomous Databases on Serverless Infrastructure: - This is an integer field whose value remains null when the data size is in GBs and cannot be converted to TBs (by dividing the GB value by 1024) without rounding error. - To get the exact value of data storage size without rounding error, please see dataStorageSizeInGBs of Autonomous Database.

        Parameters:
        dataStorageSizeInTBs - the value to set
        Returns:
        this builder

      • memoryPerOracleComputeUnitInGBs

        public AutonomousDatabase.Builder memoryPerOracleComputeUnitInGBs​(Integer memoryPerOracleComputeUnitInGBs)
        The amount of memory (in GBs) enabled per ECPU or OCPU.
        Parameters:
        memoryPerOracleComputeUnitInGBs - the value to set
        Returns:
        this builder

      • dataStorageSizeInGBs

        public AutonomousDatabase.Builder dataStorageSizeInGBs​(Integer dataStorageSizeInGBs)
        The quantity of data in the database, in gigabytes.

        For Autonomous Transaction Processing databases using ECPUs on Serverless Infrastructure, this value is always populated. In all the other cases, this value will be null and dataStorageSizeInTBs will be populated instead.

        Parameters:
        dataStorageSizeInGBs - the value to set
        Returns:
        this builder

      • usedDataStorageSizeInGBs

        public AutonomousDatabase.Builder usedDataStorageSizeInGBs​(Integer usedDataStorageSizeInGBs)
        The storage space consumed by Autonomous Database in GBs.
        Parameters:
        usedDataStorageSizeInGBs - the value to set
        Returns:
        this builder

      • autonomousContainerDatabaseId

        public AutonomousDatabase.Builder autonomousContainerDatabaseId​(String autonomousContainerDatabaseId)
        The Autonomous Container Database OCID.

        Used only by Autonomous Database on Dedicated Exadata Infrastructure.

        Parameters:
        autonomousContainerDatabaseId - the value to set
        Returns:
        this builder

      • isBackupRetentionLocked

        public AutonomousDatabase.Builder isBackupRetentionLocked​(Boolean isBackupRetentionLocked)
        Indicates if the Autonomous Database is backup retention locked.
        Parameters:
        isBackupRetentionLocked - the value to set
        Returns:
        this builder

      • timeUndeleted

        public AutonomousDatabase.Builder timeUndeleted​(Date timeUndeleted)
        The date and time the Autonomous Database was most recently undeleted.
        Parameters:
        timeUndeleted - the value to set
        Returns:
        this builder

      • timeCreated

        public AutonomousDatabase.Builder timeCreated​(Date timeCreated)
        The date and time the Autonomous Database was created.
        Parameters:
        timeCreated - the value to set
        Returns:
        this builder

      • displayName

        public AutonomousDatabase.Builder displayName​(String displayName)
        The user-friendly name for the Autonomous Database.

        The name does not have to be unique.

        Parameters:
        displayName - the value to set
        Returns:
        this builder

      • serviceConsoleUrl

        public AutonomousDatabase.Builder serviceConsoleUrl​(String serviceConsoleUrl)
        The URL of the Service Console for the Autonomous Database.
        Parameters:
        serviceConsoleUrl - the value to set
        Returns:
        this builder

      • connectionStrings

        public AutonomousDatabase.Builder connectionStrings​(AutonomousDatabaseConnectionStrings connectionStrings)
        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.

        Parameters:
        connectionStrings - the value to set
        Returns:
        this builder

      • publicConnectionUrls

        public AutonomousDatabase.Builder publicConnectionUrls​(AutonomousDatabaseConnectionUrls publicConnectionUrls)
        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.
        Parameters:
        publicConnectionUrls - the value to set
        Returns:
        this builder

      • licenseModel

        public AutonomousDatabase.Builder licenseModel​(AutonomousDatabase.LicenseModel licenseModel)
        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.

        Parameters:
        licenseModel - the value to set
        Returns:
        this builder

      • byolComputeCountLimit

        public AutonomousDatabase.Builder byolComputeCountLimit​(Float byolComputeCountLimit)
        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.

        Parameters:
        byolComputeCountLimit - the value to set
        Returns:
        this builder

      • usedDataStorageSizeInTBs

        public AutonomousDatabase.Builder usedDataStorageSizeInTBs​(Integer usedDataStorageSizeInTBs)
        The amount of storage that has been used for Autonomous Databases in dedicated infrastructure, in terabytes.
        Parameters:
        usedDataStorageSizeInTBs - the value to set
        Returns:
        this builder

      • freeformTags

        public AutonomousDatabase.Builder freeformTags​(Map<String,​String> freeformTags)
        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"}

        Parameters:
        freeformTags - the value to set
        Returns:
        this builder

      • securityAttributes

        public AutonomousDatabase.Builder securityAttributes​(Map<String,​Map<String,​Object>> securityAttributes)
        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”}}}

        Parameters:
        securityAttributes - the value to set
        Returns:
        this builder

      • subnetId

        public AutonomousDatabase.Builder subnetId​(String subnetId)
        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.

        Parameters:
        subnetId - the value to set
        Returns:
        this builder

      • nsgIds

        public AutonomousDatabase.Builder nsgIds​(List<String> nsgIds)
        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.

        Parameters:
        nsgIds - the value to set
        Returns:
        this builder

      • privateEndpoint

        public AutonomousDatabase.Builder privateEndpoint​(String privateEndpoint)
        The private endpoint for the resource.
        Parameters:
        privateEndpoint - the value to set
        Returns:
        this builder

      • publicEndpoint

        public AutonomousDatabase.Builder publicEndpoint​(String publicEndpoint)
        The public endpoint for the private endpoint enabled resource.
        Parameters:
        publicEndpoint - the value to set
        Returns:
        this builder

      • privateEndpointLabel

        public AutonomousDatabase.Builder privateEndpointLabel​(String privateEndpointLabel)
        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.

        Parameters:
        privateEndpointLabel - the value to set
        Returns:
        this builder

      • privateEndpointIp

        public AutonomousDatabase.Builder privateEndpointIp​(String privateEndpointIp)
        The private endpoint Ip address for the resource.
        Parameters:
        privateEndpointIp - the value to set
        Returns:
        this builder

      • dbVersion

        public AutonomousDatabase.Builder dbVersion​(String dbVersion)
        A valid Oracle Database version for Autonomous Database.
        Parameters:
        dbVersion - the value to set
        Returns:
        this builder

      • isPreview

        public AutonomousDatabase.Builder isPreview​(Boolean isPreview)
        Indicates if the Autonomous Database version is a preview version.
        Parameters:
        isPreview - the value to set
        Returns:
        this builder

      • dbWorkload

        public AutonomousDatabase.Builder dbWorkload​(AutonomousDatabase.DbWorkload dbWorkload)
        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.

        Parameters:
        dbWorkload - the value to set
        Returns:
        this builder

      • isDevTier

        public AutonomousDatabase.Builder isDevTier​(Boolean isDevTier)
        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.

        Parameters:
        isDevTier - the value to set
        Returns:
        this builder

      • isAccessControlEnabled

        public AutonomousDatabase.Builder isAccessControlEnabled​(Boolean isAccessControlEnabled)
        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.

        Parameters:
        isAccessControlEnabled - the value to set
        Returns:
        this builder

      • whitelistedIps

        public AutonomousDatabase.Builder whitelistedIps​(List<String> whitelistedIps)
        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\u2019s 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.","ocid1.vcn.oc1.sea.;1.1.1.1","ocid1.vcn.oc1.sea.;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.

        Parameters:
        whitelistedIps - the value to set
        Returns:
        this builder

      • arePrimaryWhitelistedIpsUsed

        public AutonomousDatabase.Builder arePrimaryWhitelistedIpsUsed​(Boolean arePrimaryWhitelistedIpsUsed)
        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.

        Parameters:
        arePrimaryWhitelistedIpsUsed - the value to set
        Returns:
        this builder

      • standbyWhitelistedIps

        public AutonomousDatabase.Builder standbyWhitelistedIps​(List<String> standbyWhitelistedIps)
        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\u2019s 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.","ocid1.vcn.oc1.sea.;1.1.1.1","ocid1.vcn.oc1.sea.;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.

        Parameters:
        standbyWhitelistedIps - the value to set
        Returns:
        this builder

      • isAutoScalingEnabled

        public AutonomousDatabase.Builder isAutoScalingEnabled​(Boolean isAutoScalingEnabled)
        Indicates if auto scaling is enabled for the Autonomous Database CPU core count.

        The default value is TRUE.

        Parameters:
        isAutoScalingEnabled - the value to set
        Returns:
        this builder

      • timeMaintenanceBegin

        public AutonomousDatabase.Builder timeMaintenanceBegin​(Date timeMaintenanceBegin)
        The date and time when maintenance will begin.
        Parameters:
        timeMaintenanceBegin - the value to set
        Returns:
        this builder

      • timeMaintenanceEnd

        public AutonomousDatabase.Builder timeMaintenanceEnd​(Date timeMaintenanceEnd)
        The date and time when maintenance will end.
        Parameters:
        timeMaintenanceEnd - the value to set
        Returns:
        this builder

      • maintenanceTargetComponent

        public AutonomousDatabase.Builder maintenanceTargetComponent​(String maintenanceTargetComponent)
        The component chosen for maintenance.
        Parameters:
        maintenanceTargetComponent - the value to set
        Returns:
        this builder

      • isRefreshableClone

        public AutonomousDatabase.Builder isRefreshableClone​(Boolean isRefreshableClone)
        Indicates if the Autonomous Database is a refreshable clone.

        This cannot be updated in parallel with any of the following: cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, openMode, permissionLevel, dbWorkload, privateEndpointLabel, nsgIds, dbVersion, dbName, scheduledOperations, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier.

        Parameters:
        isRefreshableClone - the value to set
        Returns:
        this builder

      • timeOfLastRefresh

        public AutonomousDatabase.Builder timeOfLastRefresh​(Date timeOfLastRefresh)
        The date and time when last refresh happened.
        Parameters:
        timeOfLastRefresh - the value to set
        Returns:
        this builder

      • timeOfLastRefreshPoint

        public AutonomousDatabase.Builder timeOfLastRefreshPoint​(Date timeOfLastRefreshPoint)
        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.

        Parameters:
        timeOfLastRefreshPoint - the value to set
        Returns:
        this builder

      • timeOfNextRefresh

        public AutonomousDatabase.Builder timeOfNextRefresh​(Date timeOfNextRefresh)
        The date and time of next refresh.
        Parameters:
        timeOfNextRefresh - the value to set
        Returns:
        this builder

      • openMode

        public AutonomousDatabase.Builder openMode​(AutonomousDatabase.OpenMode openMode)
        Indicates the Autonomous Database mode.

        The database can be opened in READ_ONLY or READ_WRITE mode.

        This cannot be updated in parallel with any of the following: cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, isMTLSConnectionRequired, dbVersion, isRefreshable, dbName, scheduledOperations, dbToolsDetails, or isFreeTier.

        Parameters:
        openMode - the value to set
        Returns:
        this builder

      • refreshableStatus

        public AutonomousDatabase.Builder refreshableStatus​(AutonomousDatabase.RefreshableStatus refreshableStatus)
        The refresh status of the clone.

        REFRESHING indicates that the clone is currently being refreshed with data from the source Autonomous Database.

        Parameters:
        refreshableStatus - the value to set
        Returns:
        this builder

      • refreshableMode

        public AutonomousDatabase.Builder refreshableMode​(AutonomousDatabase.RefreshableMode refreshableMode)
        The refresh mode of the clone.

        AUTOMATIC indicates that the clone is automatically being refreshed with data from the source Autonomous Database.

        Parameters:
        refreshableMode - the value to set
        Returns:
        this builder

      • sourceId

        public AutonomousDatabase.Builder sourceId​(String sourceId)
        The OCID of the source Autonomous Database that was cloned to create the current Autonomous Database.
        Parameters:
        sourceId - the value to set
        Returns:
        this builder

      • permissionLevel

        public AutonomousDatabase.Builder permissionLevel​(AutonomousDatabase.PermissionLevel permissionLevel)
        The Autonomous Database permission level.

        Restricted mode allows access only by admin users.

        This cannot be updated in parallel with any of the following: cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, isMTLSConnectionRequired, nsgIds, dbVersion, isRefreshable, dbName, scheduledOperations, dbToolsDetails, or isFreeTier.

        Parameters:
        permissionLevel - the value to set
        Returns:
        this builder

      • timeOfLastSwitchover

        public AutonomousDatabase.Builder timeOfLastSwitchover​(Date timeOfLastSwitchover)
        The timestamp of the last switchover operation for the Autonomous Database.
        Parameters:
        timeOfLastSwitchover - the value to set
        Returns:
        this builder

      • timeOfLastFailover

        public AutonomousDatabase.Builder timeOfLastFailover​(Date timeOfLastFailover)
        The timestamp of the last failover operation.
        Parameters:
        timeOfLastFailover - the value to set
        Returns:
        this builder

      • isDataGuardEnabled

        public AutonomousDatabase.Builder isDataGuardEnabled​(Boolean isDataGuardEnabled)
        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.

        Parameters:
        isDataGuardEnabled - the value to set
        Returns:
        this builder

      • failedDataRecoveryInSeconds

        public AutonomousDatabase.Builder failedDataRecoveryInSeconds​(Integer failedDataRecoveryInSeconds)
        Indicates the number of seconds of data loss for a Data Guard failover.
        Parameters:
        failedDataRecoveryInSeconds - the value to set
        Returns:
        this builder

      • isLocalDataGuardEnabled

        public AutonomousDatabase.Builder isLocalDataGuardEnabled​(Boolean isLocalDataGuardEnabled)
        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.

        Parameters:
        isLocalDataGuardEnabled - the value to set
        Returns:
        this builder

      • isRemoteDataGuardEnabled

        public AutonomousDatabase.Builder isRemoteDataGuardEnabled​(Boolean isRemoteDataGuardEnabled)
        Indicates whether the Autonomous Database has Cross Region Data Guard enabled.

        Not applicable to Autonomous Databases using dedicated Exadata infrastructure or Exadata Cloud@Customer infrastructure.

        Parameters:
        isRemoteDataGuardEnabled - the value to set
        Returns:
        this builder

      • role

        public AutonomousDatabase.Builder role​(AutonomousDatabase.Role role)
        The Data Guard role of the Autonomous Container Database or Autonomous Database, if Autonomous Data Guard is enabled.
        Parameters:
        role - the value to set
        Returns:
        this builder

      • availableUpgradeVersions

        public AutonomousDatabase.Builder availableUpgradeVersions​(List<String> availableUpgradeVersions)
        List of Oracle Database versions available for a database upgrade.

        If there are no version upgrades available, this list is empty.

        Parameters:
        availableUpgradeVersions - the value to set
        Returns:
        this builder

      • keyStoreId

        public AutonomousDatabase.Builder keyStoreId​(String keyStoreId)
        The OCID of the key store of Oracle Vault.
        Parameters:
        keyStoreId - the value to set
        Returns:
        this builder

      • keyStoreWalletName

        public AutonomousDatabase.Builder keyStoreWalletName​(String keyStoreWalletName)
        The wallet name for Oracle Key Vault.
        Parameters:
        keyStoreWalletName - the value to set
        Returns:
        this builder

      • autoRefreshFrequencyInSeconds

        public AutonomousDatabase.Builder autoRefreshFrequencyInSeconds​(Integer autoRefreshFrequencyInSeconds)
        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.

        Parameters:
        autoRefreshFrequencyInSeconds - the value to set
        Returns:
        this builder

      • autoRefreshPointLagInSeconds

        public AutonomousDatabase.Builder autoRefreshPointLagInSeconds​(Integer autoRefreshPointLagInSeconds)
        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.

        Parameters:
        autoRefreshPointLagInSeconds - the value to set
        Returns:
        this builder

      • timeOfAutoRefreshStart

        public AutonomousDatabase.Builder timeOfAutoRefreshStart​(Date timeOfAutoRefreshStart)
        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.

        Parameters:
        timeOfAutoRefreshStart - the value to set
        Returns:
        this builder

      • supportedRegionsToCloneTo

        public AutonomousDatabase.Builder supportedRegionsToCloneTo​(List<String> supportedRegionsToCloneTo)
        The list of regions that support the creation of an Autonomous Database clone or an Autonomous Data Guard standby database.
        Parameters:
        supportedRegionsToCloneTo - the value to set
        Returns:
        this builder

      • timeLocalDataGuardEnabled

        public AutonomousDatabase.Builder timeLocalDataGuardEnabled​(Date timeLocalDataGuardEnabled)
        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.
        Parameters:
        timeLocalDataGuardEnabled - the value to set
        Returns:
        this builder

      • dataguardRegionType

        public AutonomousDatabase.Builder dataguardRegionType​(AutonomousDatabase.DataguardRegionType dataguardRegionType)
        Deprecated. The Autonomous Data Guard region type of the Autonomous Database.

        For Autonomous Database Serverless, Autonomous Data Guard associations have designated primary and standby regions, and these region types do not change when the database changes roles. The standby regions in Autonomous 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 Autonomous Data Guard association, and cannot be performed when the database using the primary role is operating in a remote Autonomous Data Guard standby region.

        Parameters:
        dataguardRegionType - the value to set
        Returns:
        this builder

      • timeDataGuardRoleChanged

        public AutonomousDatabase.Builder timeDataGuardRoleChanged​(Date timeDataGuardRoleChanged)
        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.

        Parameters:
        timeDataGuardRoleChanged - the value to set
        Returns:
        this builder

      • peerDbIds

        public AutonomousDatabase.Builder peerDbIds​(List<String> peerDbIds)
        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.

        Parameters:
        peerDbIds - the value to set
        Returns:
        this builder

      • isMtlsConnectionRequired

        public AutonomousDatabase.Builder isMtlsConnectionRequired​(Boolean isMtlsConnectionRequired)
        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.

        Parameters:
        isMtlsConnectionRequired - the value to set
        Returns:
        this builder

      • timeOfJoiningResourcePool

        public AutonomousDatabase.Builder timeOfJoiningResourcePool​(Date timeOfJoiningResourcePool)
        The time the member joined the resource pool.
        Parameters:
        timeOfJoiningResourcePool - the value to set
        Returns:
        this builder

      • resourcePoolLeaderId

        public AutonomousDatabase.Builder resourcePoolLeaderId​(String resourcePoolLeaderId)
        The unique identifier for leader autonomous database OCID OCID.
        Parameters:
        resourcePoolLeaderId - the value to set
        Returns:
        this builder

      • isReconnectCloneEnabled

        public AutonomousDatabase.Builder isReconnectCloneEnabled​(Boolean isReconnectCloneEnabled)
        Indicates if the refreshable clone can be reconnected to its source database.
        Parameters:
        isReconnectCloneEnabled - the value to set
        Returns:
        this builder

      • timeUntilReconnectCloneEnabled

        public AutonomousDatabase.Builder timeUntilReconnectCloneEnabled​(Date timeUntilReconnectCloneEnabled)
        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.
        Parameters:
        timeUntilReconnectCloneEnabled - the value to set
        Returns:
        this builder

      • autonomousMaintenanceScheduleType

        public AutonomousDatabase.Builder autonomousMaintenanceScheduleType​(AutonomousDatabase.AutonomousMaintenanceScheduleType autonomousMaintenanceScheduleType)
        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

        Parameters:
        autonomousMaintenanceScheduleType - the value to set
        Returns:
        this builder

      • scheduledOperations

        public AutonomousDatabase.Builder scheduledOperations​(List<ScheduledOperationDetails> scheduledOperations)
        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.

        Parameters:
        scheduledOperations - the value to set
        Returns:
        this builder

      • isAutoScalingForStorageEnabled

        public AutonomousDatabase.Builder isAutoScalingForStorageEnabled​(Boolean isAutoScalingForStorageEnabled)
        Indicates if auto scaling is enabled for the Autonomous Database storage.

        The default value is FALSE.

        Parameters:
        isAutoScalingForStorageEnabled - the value to set
        Returns:
        this builder

      • allocatedStorageSizeInTBs

        public AutonomousDatabase.Builder allocatedStorageSizeInTBs​(Double allocatedStorageSizeInTBs)
        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 the actualUsedDataStorageSizeInTBs value to determine if a manual shrink operation is appropriate for your allocated storage.

        *Note:** Auto-scaling does not automatically decrease allocated storage when data is deleted from the database.

        Parameters:
        allocatedStorageSizeInTBs - the value to set
        Returns:
        this builder

      • actualUsedDataStorageSizeInTBs

        public AutonomousDatabase.Builder actualUsedDataStorageSizeInTBs​(Double actualUsedDataStorageSizeInTBs)
        The current amount of storage in use for user and system data, in terabytes (TB).
        Parameters:
        actualUsedDataStorageSizeInTBs - the value to set
        Returns:
        this builder

      • dbToolsDetails

        public AutonomousDatabase.Builder dbToolsDetails​(List<DatabaseTool> dbToolsDetails)
        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.

        Parameters:
        dbToolsDetails - the value to set
        Returns:
        this builder

      • localDisasterRecoveryType

        public AutonomousDatabase.Builder localDisasterRecoveryType​(DisasterRecoveryConfiguration.DisasterRecoveryType localDisasterRecoveryType)
        Indicates the local disaster recovery (DR) type of the 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.

        Parameters:
        localDisasterRecoveryType - the value to set
        Returns:
        this builder

      • disasterRecoveryRegionType

        public AutonomousDatabase.Builder disasterRecoveryRegionType​(AutonomousDatabase.DisasterRecoveryRegionType disasterRecoveryRegionType)
        Deprecated. The disaster recovery (DR) region type of the Autonomous Database.

        For Autonomous Database Serverless instances, DR associations have designated primary and standby 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.

        Parameters:
        disasterRecoveryRegionType - the value to set
        Returns:
        this builder

      • timeDisasterRecoveryRoleChanged

        public AutonomousDatabase.Builder timeDisasterRecoveryRoleChanged​(Date timeDisasterRecoveryRoleChanged)
        The date and time the Disaster Recovery role was switched for the standby Autonomous Database.
        Parameters:
        timeDisasterRecoveryRoleChanged - the value to set
        Returns:
        this builder

      • netServicesArchitecture

        public AutonomousDatabase.Builder netServicesArchitecture​(AutonomousDatabase.NetServicesArchitecture netServicesArchitecture)
        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.
        Parameters:
        netServicesArchitecture - the value to set
        Returns:
        this builder

      • availabilityDomain

        public AutonomousDatabase.Builder availabilityDomain​(String availabilityDomain)
        The availability domain where the Autonomous Database Serverless instance is located.
        Parameters:
        availabilityDomain - the value to set
        Returns:
        this builder

      • clusterPlacementGroupId

        public AutonomousDatabase.Builder clusterPlacementGroupId​(String clusterPlacementGroupId)
        The OCID of the cluster placement group of the Autonomous Serverless Database.
        Parameters:
        clusterPlacementGroupId - the value to set
        Returns:
        this builder

      • cloneTableSpaceList

        public AutonomousDatabase.Builder cloneTableSpaceList​(List<Integer> cloneTableSpaceList)
        A list of the source Autonomous Database’s table space number(s) used to create this partial clone from the backup.
        Parameters:
        cloneTableSpaceList - the value to set
        Returns:
        this builder