Oracle Cloud Infrastructure

Pulumi Official
Package maintained by Pulumi
v0.1.1 published on Tuesday, May 3, 2022 by Pulumi

Database

This resource provides the Database resource in Oracle Cloud Infrastructure Database service.

Creates a new database in the specified Database Home. If the database version is provided, it must match the version of the Database Home. Applies only to Exadata systems.

Example Usage

using Pulumi;
using Oci = Pulumi.Oci;

class MyStack : Stack
{
    public MyStack()
    {
        var testDatabase = new Oci.Database.Database("testDatabase", new Oci.Database.DatabaseArgs
        {
            Database = new Oci.Database.Inputs.DatabaseDatabaseArgs
            {
                AdminPassword = @var.Database_database_admin_password,
                DbName = @var.Database_database_db_name,
                BackupId = oci_database_backup.Test_backup.Id,
                BackupTdePassword = @var.Database_database_backup_tde_password,
                CharacterSet = @var.Database_database_character_set,
                DatabaseSoftwareImageId = oci_database_database_software_image.Test_database_software_image.Id,
                DbBackupConfig = new Oci.Database.Inputs.DatabaseDatabaseDbBackupConfigArgs
                {
                    AutoBackupEnabled = @var.Database_database_db_backup_config_auto_backup_enabled,
                    AutoBackupWindow = @var.Database_database_db_backup_config_auto_backup_window,
                    BackupDestinationDetails = 
                    {
                        new Oci.Database.Inputs.DatabaseDatabaseDbBackupConfigBackupDestinationDetailArgs
                        {
                            Id = @var.Database_database_db_backup_config_backup_destination_details_id,
                            Type = @var.Database_database_db_backup_config_backup_destination_details_type,
                        },
                    },
                    RecoveryWindowInDays = @var.Database_database_db_backup_config_recovery_window_in_days,
                },
                DbUniqueName = @var.Database_database_db_unique_name,
                DbWorkload = @var.Database_database_db_workload,
                DefinedTags = @var.Database_database_defined_tags,
                FreeformTags = @var.Database_database_freeform_tags,
                KmsKeyId = oci_kms_key.Test_key.Id,
                KmsKeyVersionId = oci_kms_key_version.Test_key_version.Id,
                NcharacterSet = @var.Database_database_ncharacter_set,
                PdbName = @var.Database_database_pdb_name,
                SidPrefix = @var.Database_database_sid_prefix,
                TdeWalletPassword = @var.Database_database_tde_wallet_password,
                VaultId = oci_kms_vault.Test_vault.Id,
            },
            DbHomeId = oci_database_db_home.Test_db_home.Id,
            Source = @var.Database_source,
            DbVersion = @var.Database_db_version,
            KmsKeyId = oci_kms_key.Test_key.Id,
            KmsKeyVersionId = oci_kms_key_version.Test_key_version.Id,
        });
    }

}
package main

import (
	"github.com/pulumi/pulumi-oci/sdk/go/oci/Database"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := Database.NewDatabase(ctx, "testDatabase", &Database.DatabaseArgs{
			Database: &database.DatabaseDatabaseArgs{
				AdminPassword:           pulumi.Any(_var.Database_database_admin_password),
				DbName:                  pulumi.Any(_var.Database_database_db_name),
				BackupId:                pulumi.Any(oci_database_backup.Test_backup.Id),
				BackupTdePassword:       pulumi.Any(_var.Database_database_backup_tde_password),
				CharacterSet:            pulumi.Any(_var.Database_database_character_set),
				DatabaseSoftwareImageId: pulumi.Any(oci_database_database_software_image.Test_database_software_image.Id),
				DbBackupConfig: &database.DatabaseDatabaseDbBackupConfigArgs{
					AutoBackupEnabled: pulumi.Any(_var.Database_database_db_backup_config_auto_backup_enabled),
					AutoBackupWindow:  pulumi.Any(_var.Database_database_db_backup_config_auto_backup_window),
					BackupDestinationDetails: database.DatabaseDatabaseDbBackupConfigBackupDestinationDetailArray{
						&database.DatabaseDatabaseDbBackupConfigBackupDestinationDetailArgs{
							Id:   pulumi.Any(_var.Database_database_db_backup_config_backup_destination_details_id),
							Type: pulumi.Any(_var.Database_database_db_backup_config_backup_destination_details_type),
						},
					},
					RecoveryWindowInDays: pulumi.Any(_var.Database_database_db_backup_config_recovery_window_in_days),
				},
				DbUniqueName:      pulumi.Any(_var.Database_database_db_unique_name),
				DbWorkload:        pulumi.Any(_var.Database_database_db_workload),
				DefinedTags:       pulumi.Any(_var.Database_database_defined_tags),
				FreeformTags:      pulumi.Any(_var.Database_database_freeform_tags),
				KmsKeyId:          pulumi.Any(oci_kms_key.Test_key.Id),
				KmsKeyVersionId:   pulumi.Any(oci_kms_key_version.Test_key_version.Id),
				NcharacterSet:     pulumi.Any(_var.Database_database_ncharacter_set),
				PdbName:           pulumi.Any(_var.Database_database_pdb_name),
				SidPrefix:         pulumi.Any(_var.Database_database_sid_prefix),
				TdeWalletPassword: pulumi.Any(_var.Database_database_tde_wallet_password),
				VaultId:           pulumi.Any(oci_kms_vault.Test_vault.Id),
			},
			DbHomeId:        pulumi.Any(oci_database_db_home.Test_db_home.Id),
			Source:          pulumi.Any(_var.Database_source),
			DbVersion:       pulumi.Any(_var.Database_db_version),
			KmsKeyId:        pulumi.Any(oci_kms_key.Test_key.Id),
			KmsKeyVersionId: pulumi.Any(oci_kms_key_version.Test_key_version.Id),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

Coming soon!

import pulumi
import pulumi_oci as oci

test_database = oci.database.Database("testDatabase",
    database=oci.database.DatabaseDatabaseArgs(
        admin_password=var["database_database_admin_password"],
        db_name=var["database_database_db_name"],
        backup_id=oci_database_backup["test_backup"]["id"],
        backup_tde_password=var["database_database_backup_tde_password"],
        character_set=var["database_database_character_set"],
        database_software_image_id=oci_database_database_software_image["test_database_software_image"]["id"],
        db_backup_config=oci.database.DatabaseDatabaseDbBackupConfigArgs(
            auto_backup_enabled=var["database_database_db_backup_config_auto_backup_enabled"],
            auto_backup_window=var["database_database_db_backup_config_auto_backup_window"],
            backup_destination_details=[oci.database.DatabaseDatabaseDbBackupConfigBackupDestinationDetailArgs(
                id=var["database_database_db_backup_config_backup_destination_details_id"],
                type=var["database_database_db_backup_config_backup_destination_details_type"],
            )],
            recovery_window_in_days=var["database_database_db_backup_config_recovery_window_in_days"],
        ),
        db_unique_name=var["database_database_db_unique_name"],
        db_workload=var["database_database_db_workload"],
        defined_tags=var["database_database_defined_tags"],
        freeform_tags=var["database_database_freeform_tags"],
        kms_key_id=oci_kms_key["test_key"]["id"],
        kms_key_version_id=oci_kms_key_version["test_key_version"]["id"],
        ncharacter_set=var["database_database_ncharacter_set"],
        pdb_name=var["database_database_pdb_name"],
        sid_prefix=var["database_database_sid_prefix"],
        tde_wallet_password=var["database_database_tde_wallet_password"],
        vault_id=oci_kms_vault["test_vault"]["id"],
    ),
    db_home_id=oci_database_db_home["test_db_home"]["id"],
    source=var["database_source"],
    db_version=var["database_db_version"],
    kms_key_id=oci_kms_key["test_key"]["id"],
    kms_key_version_id=oci_kms_key_version["test_key_version"]["id"])
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testDatabase = new oci.database.Database("testDatabase", {
    database: {
        adminPassword: _var.database_database_admin_password,
        dbName: _var.database_database_db_name,
        backupId: oci_database_backup.test_backup.id,
        backupTdePassword: _var.database_database_backup_tde_password,
        characterSet: _var.database_database_character_set,
        databaseSoftwareImageId: oci_database_database_software_image.test_database_software_image.id,
        dbBackupConfig: {
            autoBackupEnabled: _var.database_database_db_backup_config_auto_backup_enabled,
            autoBackupWindow: _var.database_database_db_backup_config_auto_backup_window,
            backupDestinationDetails: [{
                id: _var.database_database_db_backup_config_backup_destination_details_id,
                type: _var.database_database_db_backup_config_backup_destination_details_type,
            }],
            recoveryWindowInDays: _var.database_database_db_backup_config_recovery_window_in_days,
        },
        dbUniqueName: _var.database_database_db_unique_name,
        dbWorkload: _var.database_database_db_workload,
        definedTags: _var.database_database_defined_tags,
        freeformTags: _var.database_database_freeform_tags,
        kmsKeyId: oci_kms_key.test_key.id,
        kmsKeyVersionId: oci_kms_key_version.test_key_version.id,
        ncharacterSet: _var.database_database_ncharacter_set,
        pdbName: _var.database_database_pdb_name,
        sidPrefix: _var.database_database_sid_prefix,
        tdeWalletPassword: _var.database_database_tde_wallet_password,
        vaultId: oci_kms_vault.test_vault.id,
    },
    dbHomeId: oci_database_db_home.test_db_home.id,
    source: _var.database_source,
    dbVersion: _var.database_db_version,
    kmsKeyId: oci_kms_key.test_key.id,
    kmsKeyVersionId: oci_kms_key_version.test_key_version.id,
});

Coming soon!

Create a Database Resource

new Database(name: string, args: DatabaseArgs, opts?: CustomResourceOptions);
@overload
def Database(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             database: Optional[_database.DatabaseDatabaseArgs] = None,
             db_home_id: Optional[str] = None,
             db_version: Optional[str] = None,
             kms_key_id: Optional[str] = None,
             kms_key_migration: Optional[bool] = None,
             kms_key_rotation: Optional[int] = None,
             kms_key_version_id: Optional[str] = None,
             source: Optional[str] = None,
             vault_id: Optional[str] = None)
@overload
def Database(resource_name: str,
             args: DatabaseArgs,
             opts: Optional[ResourceOptions] = None)
func NewDatabase(ctx *Context, name string, args DatabaseArgs, opts ...ResourceOption) (*Database, error)
public Database(string name, DatabaseArgs args, CustomResourceOptions? opts = null)
public Database(String name, DatabaseArgs args)
public Database(String name, DatabaseArgs args, CustomResourceOptions options)
type: oci:Database:Database
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string
The unique name of the resource.
args DatabaseArgs
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 DatabaseArgs
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 DatabaseArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args DatabaseArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args DatabaseArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Database Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The Database resource accepts the following input properties:

DatabaseName DatabaseDatabaseArgs

(Updatable) Details for creating a database.

DbHomeId string

The OCID of the Database Home.

Source string

The source of the database: Use NONE for creating a new database. Use DB_BACKUP for creating a new database by restoring from a backup. The default is NONE.

DbVersion string

A valid Oracle Database version. To get a list of supported versions, use the ListDbVersions operation.

KmsKeyId string

The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.

KmsKeyMigration bool

The value to migrate to the kms version from none. Can only use once by setting value to true. You can not switch back to non-kms once you created or migrated.(https://www.oracle.com/security/cloud-security/key-management/faq/)

KmsKeyRotation int

The value to rotate the key version of current kms_key. Just change this value will trigger the rotation.

KmsKeyVersionId string

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.

VaultId string

The OCID of the Oracle Cloud Infrastructure vault.

Database DatabaseDatabaseArgs

(Updatable) Details for creating a database.

DbHomeId string

The OCID of the Database Home.

Source string

The source of the database: Use NONE for creating a new database. Use DB_BACKUP for creating a new database by restoring from a backup. The default is NONE.

DbVersion string

A valid Oracle Database version. To get a list of supported versions, use the ListDbVersions operation.

KmsKeyId string

The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.

KmsKeyMigration bool

The value to migrate to the kms version from none. Can only use once by setting value to true. You can not switch back to non-kms once you created or migrated.(https://www.oracle.com/security/cloud-security/key-management/faq/)

KmsKeyRotation int

The value to rotate the key version of current kms_key. Just change this value will trigger the rotation.

KmsKeyVersionId string

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.

VaultId string

The OCID of the Oracle Cloud Infrastructure vault.

database Args

(Updatable) Details for creating a database.

dbHomeId String

The OCID of the Database Home.

source String

The source of the database: Use NONE for creating a new database. Use DB_BACKUP for creating a new database by restoring from a backup. The default is NONE.

dbVersion String

A valid Oracle Database version. To get a list of supported versions, use the ListDbVersions operation.

kmsKeyId String

The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.

kmsKeyMigration Boolean

The value to migrate to the kms version from none. Can only use once by setting value to true. You can not switch back to non-kms once you created or migrated.(https://www.oracle.com/security/cloud-security/key-management/faq/)

kmsKeyRotation Integer

The value to rotate the key version of current kms_key. Just change this value will trigger the rotation.

kmsKeyVersionId String

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.

vaultId String

The OCID of the Oracle Cloud Infrastructure vault.

database DatabaseDatabaseArgs

(Updatable) Details for creating a database.

dbHomeId string

The OCID of the Database Home.

source string

The source of the database: Use NONE for creating a new database. Use DB_BACKUP for creating a new database by restoring from a backup. The default is NONE.

dbVersion string

A valid Oracle Database version. To get a list of supported versions, use the ListDbVersions operation.

kmsKeyId string

The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.

kmsKeyMigration boolean

The value to migrate to the kms version from none. Can only use once by setting value to true. You can not switch back to non-kms once you created or migrated.(https://www.oracle.com/security/cloud-security/key-management/faq/)

kmsKeyRotation number

The value to rotate the key version of current kms_key. Just change this value will trigger the rotation.

kmsKeyVersionId string

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.

vaultId string

The OCID of the Oracle Cloud Infrastructure vault.

database DatabaseDatabaseArgs

(Updatable) Details for creating a database.

db_home_id str

The OCID of the Database Home.

source str

The source of the database: Use NONE for creating a new database. Use DB_BACKUP for creating a new database by restoring from a backup. The default is NONE.

db_version str

A valid Oracle Database version. To get a list of supported versions, use the ListDbVersions operation.

kms_key_id str

The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.

kms_key_migration bool

The value to migrate to the kms version from none. Can only use once by setting value to true. You can not switch back to non-kms once you created or migrated.(https://www.oracle.com/security/cloud-security/key-management/faq/)

kms_key_rotation int

The value to rotate the key version of current kms_key. Just change this value will trigger the rotation.

kms_key_version_id str

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.

vault_id str

The OCID of the Oracle Cloud Infrastructure vault.

database Property Map

(Updatable) Details for creating a database.

dbHomeId String

The OCID of the Database Home.

source String

The source of the database: Use NONE for creating a new database. Use DB_BACKUP for creating a new database by restoring from a backup. The default is NONE.

dbVersion String

A valid Oracle Database version. To get a list of supported versions, use the ListDbVersions operation.

kmsKeyId String

The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.

kmsKeyMigration Boolean

The value to migrate to the kms version from none. Can only use once by setting value to true. You can not switch back to non-kms once you created or migrated.(https://www.oracle.com/security/cloud-security/key-management/faq/)

kmsKeyRotation Number

The value to rotate the key version of current kms_key. Just change this value will trigger the rotation.

kmsKeyVersionId String

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.

vaultId String

The OCID of the Oracle Cloud Infrastructure vault.

Outputs

All input properties are implicitly available as output properties. Additionally, the Database resource produces the following output properties:

CharacterSet string

The character set for the database. The default is AL32UTF8. Allowed values are:

CompartmentId string

The OCID of the compartment.

ConnectionStrings List<DatabaseConnectionString>

The Connection strings used to connect to the Oracle Database.

DatabaseManagementConfigs List<DatabaseDatabaseManagementConfig>

The configuration of the Database Management service.

DatabaseSoftwareImageId string

The database software image OCID

DbBackupConfigs List<DatabaseDbBackupConfig>

(Updatable) Backup Options To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.

DbName string

The display name of the database to be created from the backup. It must begin with an alphabetic character and can contain a maximum of eight alphanumeric characters. Special characters are not permitted.

DbSystemId string

The OCID of the DB system.

DbUniqueName string

The DB_UNIQUE_NAME of the Oracle Database being backed up.

DbWorkload string

The database workload type.

DefinedTags Dictionary<string, object>

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

FreeformTags Dictionary<string, object>

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

Id string

The provider-assigned unique ID for this managed resource.

IsCdb bool

True if the database is a container database.

LastBackupTimestamp string

The date and time when the latest database backup was created.

LifecycleDetails string

Additional information about the current lifecycle state.

NcharacterSet string

The national character set for the database. The default is AL16UTF16. Allowed values are: AL16UTF16 or UTF8.

PdbName string

The name of the pluggable database. The name must begin with an alphabetic character and can contain a maximum of thirty alphanumeric characters. Special characters are not permitted. Pluggable database should not be same as database name.

SidPrefix string

Specifies a prefix for the Oracle SID of the database to be created.

SourceDatabasePointInTimeRecoveryTimestamp string

Point in time recovery timeStamp of the source database at which cloned database system is cloned from the source database system, as described in RFC 3339

State string

The current state of the database.

TimeCreated string

The date and time the database was created.

VmClusterId string

The OCID of the VM cluster.

CharacterSet string

The character set for the database. The default is AL32UTF8. Allowed values are:

CompartmentId string

The OCID of the compartment.

ConnectionStrings []DatabaseConnectionString

The Connection strings used to connect to the Oracle Database.

DatabaseManagementConfigs []DatabaseDatabaseManagementConfig

The configuration of the Database Management service.

DatabaseSoftwareImageId string

The database software image OCID

DbBackupConfigs []DatabaseDbBackupConfig

(Updatable) Backup Options To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.

DbName string

The display name of the database to be created from the backup. It must begin with an alphabetic character and can contain a maximum of eight alphanumeric characters. Special characters are not permitted.

DbSystemId string

The OCID of the DB system.

DbUniqueName string

The DB_UNIQUE_NAME of the Oracle Database being backed up.

DbWorkload string

The database workload type.

DefinedTags map[string]interface{}

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

FreeformTags map[string]interface{}

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

Id string

The provider-assigned unique ID for this managed resource.

IsCdb bool

True if the database is a container database.

LastBackupTimestamp string

The date and time when the latest database backup was created.

LifecycleDetails string

Additional information about the current lifecycle state.

NcharacterSet string

The national character set for the database. The default is AL16UTF16. Allowed values are: AL16UTF16 or UTF8.

PdbName string

The name of the pluggable database. The name must begin with an alphabetic character and can contain a maximum of thirty alphanumeric characters. Special characters are not permitted. Pluggable database should not be same as database name.

SidPrefix string

Specifies a prefix for the Oracle SID of the database to be created.

SourceDatabasePointInTimeRecoveryTimestamp string

Point in time recovery timeStamp of the source database at which cloned database system is cloned from the source database system, as described in RFC 3339

State string

The current state of the database.

TimeCreated string

The date and time the database was created.

VmClusterId string

The OCID of the VM cluster.

characterSet String

The character set for the database. The default is AL32UTF8. Allowed values are:

compartmentId String

The OCID of the compartment.

connectionStrings List<ConnectionString>

The Connection strings used to connect to the Oracle Database.

databaseManagementConfigs List<ManagementConfig>

The configuration of the Database Management service.

databaseSoftwareImageId String

The database software image OCID

dbBackupConfigs List<DbBackupConfig>

(Updatable) Backup Options To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.

dbName String

The display name of the database to be created from the backup. It must begin with an alphabetic character and can contain a maximum of eight alphanumeric characters. Special characters are not permitted.

dbSystemId String

The OCID of the DB system.

dbUniqueName String

The DB_UNIQUE_NAME of the Oracle Database being backed up.

dbWorkload String

The database workload type.

definedTags Map<String,Object>

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

freeformTags Map<String,Object>

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

id String

The provider-assigned unique ID for this managed resource.

isCdb Boolean

True if the database is a container database.

lastBackupTimestamp String

The date and time when the latest database backup was created.

lifecycleDetails String

Additional information about the current lifecycle state.

ncharacterSet String

The national character set for the database. The default is AL16UTF16. Allowed values are: AL16UTF16 or UTF8.

pdbName String

The name of the pluggable database. The name must begin with an alphabetic character and can contain a maximum of thirty alphanumeric characters. Special characters are not permitted. Pluggable database should not be same as database name.

sidPrefix String

Specifies a prefix for the Oracle SID of the database to be created.

sourceDatabasePointInTimeRecoveryTimestamp String

Point in time recovery timeStamp of the source database at which cloned database system is cloned from the source database system, as described in RFC 3339

state String

The current state of the database.

timeCreated String

The date and time the database was created.

vmClusterId String

The OCID of the VM cluster.

characterSet string

The character set for the database. The default is AL32UTF8. Allowed values are:

compartmentId string

The OCID of the compartment.

connectionStrings DatabaseConnectionString[]

The Connection strings used to connect to the Oracle Database.

databaseManagementConfigs DatabaseDatabaseManagementConfig[]

The configuration of the Database Management service.

databaseSoftwareImageId string

The database software image OCID

dbBackupConfigs DatabaseDbBackupConfig[]

(Updatable) Backup Options To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.

dbName string

The display name of the database to be created from the backup. It must begin with an alphabetic character and can contain a maximum of eight alphanumeric characters. Special characters are not permitted.

dbSystemId string

The OCID of the DB system.

dbUniqueName string

The DB_UNIQUE_NAME of the Oracle Database being backed up.

dbWorkload string

The database workload type.

definedTags {[key: string]: any}

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

freeformTags {[key: string]: any}

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

id string

The provider-assigned unique ID for this managed resource.

isCdb boolean

True if the database is a container database.

lastBackupTimestamp string

The date and time when the latest database backup was created.

lifecycleDetails string

Additional information about the current lifecycle state.

ncharacterSet string

The national character set for the database. The default is AL16UTF16. Allowed values are: AL16UTF16 or UTF8.

pdbName string

The name of the pluggable database. The name must begin with an alphabetic character and can contain a maximum of thirty alphanumeric characters. Special characters are not permitted. Pluggable database should not be same as database name.

sidPrefix string

Specifies a prefix for the Oracle SID of the database to be created.

sourceDatabasePointInTimeRecoveryTimestamp string

Point in time recovery timeStamp of the source database at which cloned database system is cloned from the source database system, as described in RFC 3339

state string

The current state of the database.

timeCreated string

The date and time the database was created.

vmClusterId string

The OCID of the VM cluster.

character_set str

The character set for the database. The default is AL32UTF8. Allowed values are:

compartment_id str

The OCID of the compartment.

connection_strings DatabaseConnectionString]

The Connection strings used to connect to the Oracle Database.

database_management_configs DatabaseDatabaseManagementConfig]

The configuration of the Database Management service.

database_software_image_id str

The database software image OCID

db_backup_configs DatabaseDbBackupConfig]

(Updatable) Backup Options To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.

db_name str

The display name of the database to be created from the backup. It must begin with an alphabetic character and can contain a maximum of eight alphanumeric characters. Special characters are not permitted.

db_system_id str

The OCID of the DB system.

db_unique_name str

The DB_UNIQUE_NAME of the Oracle Database being backed up.

db_workload str

The database workload type.

defined_tags Mapping[str, Any]

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

freeform_tags Mapping[str, Any]

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

id str

The provider-assigned unique ID for this managed resource.

is_cdb bool

True if the database is a container database.

last_backup_timestamp str

The date and time when the latest database backup was created.

lifecycle_details str

Additional information about the current lifecycle state.

ncharacter_set str

The national character set for the database. The default is AL16UTF16. Allowed values are: AL16UTF16 or UTF8.

pdb_name str

The name of the pluggable database. The name must begin with an alphabetic character and can contain a maximum of thirty alphanumeric characters. Special characters are not permitted. Pluggable database should not be same as database name.

sid_prefix str

Specifies a prefix for the Oracle SID of the database to be created.

source_database_point_in_time_recovery_timestamp str

Point in time recovery timeStamp of the source database at which cloned database system is cloned from the source database system, as described in RFC 3339

state str

The current state of the database.

time_created str

The date and time the database was created.

vm_cluster_id str

The OCID of the VM cluster.

characterSet String

The character set for the database. The default is AL32UTF8. Allowed values are:

compartmentId String

The OCID of the compartment.

connectionStrings List<Property Map>

The Connection strings used to connect to the Oracle Database.

databaseManagementConfigs List<Property Map>

The configuration of the Database Management service.

databaseSoftwareImageId String

The database software image OCID

dbBackupConfigs List<Property Map>

(Updatable) Backup Options To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.

dbName String

The display name of the database to be created from the backup. It must begin with an alphabetic character and can contain a maximum of eight alphanumeric characters. Special characters are not permitted.

dbSystemId String

The OCID of the DB system.

dbUniqueName String

The DB_UNIQUE_NAME of the Oracle Database being backed up.

dbWorkload String

The database workload type.

definedTags Map<Any>

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

freeformTags Map<Any>

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

id String

The provider-assigned unique ID for this managed resource.

isCdb Boolean

True if the database is a container database.

lastBackupTimestamp String

The date and time when the latest database backup was created.

lifecycleDetails String

Additional information about the current lifecycle state.

ncharacterSet String

The national character set for the database. The default is AL16UTF16. Allowed values are: AL16UTF16 or UTF8.

pdbName String

The name of the pluggable database. The name must begin with an alphabetic character and can contain a maximum of thirty alphanumeric characters. Special characters are not permitted. Pluggable database should not be same as database name.

sidPrefix String

Specifies a prefix for the Oracle SID of the database to be created.

sourceDatabasePointInTimeRecoveryTimestamp String

Point in time recovery timeStamp of the source database at which cloned database system is cloned from the source database system, as described in RFC 3339

state String

The current state of the database.

timeCreated String

The date and time the database was created.

vmClusterId String

The OCID of the VM cluster.

Look up an Existing Database Resource

Get an existing Database 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?: DatabaseState, opts?: CustomResourceOptions): Database
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        character_set: Optional[str] = None,
        compartment_id: Optional[str] = None,
        connection_strings: Optional[Sequence[_database.DatabaseConnectionStringArgs]] = None,
        database: Optional[_database.DatabaseDatabaseArgs] = None,
        database_management_configs: Optional[Sequence[_database.DatabaseDatabaseManagementConfigArgs]] = None,
        database_software_image_id: Optional[str] = None,
        db_backup_configs: Optional[Sequence[_database.DatabaseDbBackupConfigArgs]] = None,
        db_home_id: Optional[str] = None,
        db_name: Optional[str] = None,
        db_system_id: Optional[str] = None,
        db_unique_name: Optional[str] = None,
        db_version: Optional[str] = None,
        db_workload: Optional[str] = None,
        defined_tags: Optional[Mapping[str, Any]] = None,
        freeform_tags: Optional[Mapping[str, Any]] = None,
        is_cdb: Optional[bool] = None,
        kms_key_id: Optional[str] = None,
        kms_key_migration: Optional[bool] = None,
        kms_key_rotation: Optional[int] = None,
        kms_key_version_id: Optional[str] = None,
        last_backup_timestamp: Optional[str] = None,
        lifecycle_details: Optional[str] = None,
        ncharacter_set: Optional[str] = None,
        pdb_name: Optional[str] = None,
        sid_prefix: Optional[str] = None,
        source: Optional[str] = None,
        source_database_point_in_time_recovery_timestamp: Optional[str] = None,
        state: Optional[str] = None,
        time_created: Optional[str] = None,
        vault_id: Optional[str] = None,
        vm_cluster_id: Optional[str] = None) -> Database
func GetDatabase(ctx *Context, name string, id IDInput, state *DatabaseState, opts ...ResourceOption) (*Database, error)
public static Database Get(string name, Input<string> id, DatabaseState? state, CustomResourceOptions? opts = null)
public static Database get(String name, Output<String> id, DatabaseState 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.
The following state arguments are supported:
CharacterSet string

The character set for the database. The default is AL32UTF8. Allowed values are:

CompartmentId string

The OCID of the compartment.

ConnectionStrings List<DatabaseConnectionStringArgs>

The Connection strings used to connect to the Oracle Database.

DatabaseManagementConfigs List<DatabaseDatabaseManagementConfigArgs>

The configuration of the Database Management service.

DatabaseName DatabaseDatabaseArgs

(Updatable) Details for creating a database.

DatabaseSoftwareImageId string

The database software image OCID

DbBackupConfigs List<DatabaseDbBackupConfigArgs>

(Updatable) Backup Options To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.

DbHomeId string

The OCID of the Database Home.

DbName string

The display name of the database to be created from the backup. It must begin with an alphabetic character and can contain a maximum of eight alphanumeric characters. Special characters are not permitted.

DbSystemId string

The OCID of the DB system.

DbUniqueName string

The DB_UNIQUE_NAME of the Oracle Database being backed up.

DbVersion string

A valid Oracle Database version. To get a list of supported versions, use the ListDbVersions operation.

DbWorkload string

The database workload type.

DefinedTags Dictionary<string, object>

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

FreeformTags Dictionary<string, object>

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

IsCdb bool

True if the database is a container database.

KmsKeyId string

The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.

KmsKeyMigration bool

The value to migrate to the kms version from none. Can only use once by setting value to true. You can not switch back to non-kms once you created or migrated.(https://www.oracle.com/security/cloud-security/key-management/faq/)

KmsKeyRotation int

The value to rotate the key version of current kms_key. Just change this value will trigger the rotation.

KmsKeyVersionId string

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.

LastBackupTimestamp string

The date and time when the latest database backup was created.

LifecycleDetails string

Additional information about the current lifecycle state.

NcharacterSet string

The national character set for the database. The default is AL16UTF16. Allowed values are: AL16UTF16 or UTF8.

PdbName string

The name of the pluggable database. The name must begin with an alphabetic character and can contain a maximum of thirty alphanumeric characters. Special characters are not permitted. Pluggable database should not be same as database name.

SidPrefix string

Specifies a prefix for the Oracle SID of the database to be created.

Source string

The source of the database: Use NONE for creating a new database. Use DB_BACKUP for creating a new database by restoring from a backup. The default is NONE.

SourceDatabasePointInTimeRecoveryTimestamp string

Point in time recovery timeStamp of the source database at which cloned database system is cloned from the source database system, as described in RFC 3339

State string

The current state of the database.

TimeCreated string

The date and time the database was created.

VaultId string

The OCID of the Oracle Cloud Infrastructure vault.

VmClusterId string

The OCID of the VM cluster.

CharacterSet string

The character set for the database. The default is AL32UTF8. Allowed values are:

CompartmentId string

The OCID of the compartment.

ConnectionStrings []DatabaseConnectionStringArgs

The Connection strings used to connect to the Oracle Database.

Database DatabaseDatabaseArgs

(Updatable) Details for creating a database.

DatabaseManagementConfigs []DatabaseDatabaseManagementConfigArgs

The configuration of the Database Management service.

DatabaseSoftwareImageId string

The database software image OCID

DbBackupConfigs []DatabaseDbBackupConfigArgs

(Updatable) Backup Options To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.

DbHomeId string

The OCID of the Database Home.

DbName string

The display name of the database to be created from the backup. It must begin with an alphabetic character and can contain a maximum of eight alphanumeric characters. Special characters are not permitted.

DbSystemId string

The OCID of the DB system.

DbUniqueName string

The DB_UNIQUE_NAME of the Oracle Database being backed up.

DbVersion string

A valid Oracle Database version. To get a list of supported versions, use the ListDbVersions operation.

DbWorkload string

The database workload type.

DefinedTags map[string]interface{}

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

FreeformTags map[string]interface{}

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

IsCdb bool

True if the database is a container database.

KmsKeyId string

The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.

KmsKeyMigration bool

The value to migrate to the kms version from none. Can only use once by setting value to true. You can not switch back to non-kms once you created or migrated.(https://www.oracle.com/security/cloud-security/key-management/faq/)

KmsKeyRotation int

The value to rotate the key version of current kms_key. Just change this value will trigger the rotation.

KmsKeyVersionId string

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.

LastBackupTimestamp string

The date and time when the latest database backup was created.

LifecycleDetails string

Additional information about the current lifecycle state.

NcharacterSet string

The national character set for the database. The default is AL16UTF16. Allowed values are: AL16UTF16 or UTF8.

PdbName string

The name of the pluggable database. The name must begin with an alphabetic character and can contain a maximum of thirty alphanumeric characters. Special characters are not permitted. Pluggable database should not be same as database name.

SidPrefix string

Specifies a prefix for the Oracle SID of the database to be created.

Source string

The source of the database: Use NONE for creating a new database. Use DB_BACKUP for creating a new database by restoring from a backup. The default is NONE.

SourceDatabasePointInTimeRecoveryTimestamp string

Point in time recovery timeStamp of the source database at which cloned database system is cloned from the source database system, as described in RFC 3339

State string

The current state of the database.

TimeCreated string

The date and time the database was created.

VaultId string

The OCID of the Oracle Cloud Infrastructure vault.

VmClusterId string

The OCID of the VM cluster.

characterSet String

The character set for the database. The default is AL32UTF8. Allowed values are:

compartmentId String

The OCID of the compartment.

connectionStrings List<ConnectionStringArgs>

The Connection strings used to connect to the Oracle Database.

database Args

(Updatable) Details for creating a database.

databaseManagementConfigs List<ManagementConfigArgs>

The configuration of the Database Management service.

databaseSoftwareImageId String

The database software image OCID

dbBackupConfigs List<DbBackupConfigArgs>

(Updatable) Backup Options To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.

dbHomeId String

The OCID of the Database Home.

dbName String

The display name of the database to be created from the backup. It must begin with an alphabetic character and can contain a maximum of eight alphanumeric characters. Special characters are not permitted.

dbSystemId String

The OCID of the DB system.

dbUniqueName String

The DB_UNIQUE_NAME of the Oracle Database being backed up.

dbVersion String

A valid Oracle Database version. To get a list of supported versions, use the ListDbVersions operation.

dbWorkload String

The database workload type.

definedTags Map<String,Object>

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

freeformTags Map<String,Object>

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

isCdb Boolean

True if the database is a container database.

kmsKeyId String

The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.

kmsKeyMigration Boolean

The value to migrate to the kms version from none. Can only use once by setting value to true. You can not switch back to non-kms once you created or migrated.(https://www.oracle.com/security/cloud-security/key-management/faq/)

kmsKeyRotation Integer

The value to rotate the key version of current kms_key. Just change this value will trigger the rotation.

kmsKeyVersionId String

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.

lastBackupTimestamp String

The date and time when the latest database backup was created.

lifecycleDetails String

Additional information about the current lifecycle state.

ncharacterSet String

The national character set for the database. The default is AL16UTF16. Allowed values are: AL16UTF16 or UTF8.

pdbName String

The name of the pluggable database. The name must begin with an alphabetic character and can contain a maximum of thirty alphanumeric characters. Special characters are not permitted. Pluggable database should not be same as database name.

sidPrefix String

Specifies a prefix for the Oracle SID of the database to be created.

source String

The source of the database: Use NONE for creating a new database. Use DB_BACKUP for creating a new database by restoring from a backup. The default is NONE.

sourceDatabasePointInTimeRecoveryTimestamp String

Point in time recovery timeStamp of the source database at which cloned database system is cloned from the source database system, as described in RFC 3339

state String

The current state of the database.

timeCreated String

The date and time the database was created.

vaultId String

The OCID of the Oracle Cloud Infrastructure vault.

vmClusterId String

The OCID of the VM cluster.

characterSet string

The character set for the database. The default is AL32UTF8. Allowed values are:

compartmentId string

The OCID of the compartment.

connectionStrings DatabaseConnectionStringArgs[]

The Connection strings used to connect to the Oracle Database.

database DatabaseDatabaseArgs

(Updatable) Details for creating a database.

databaseManagementConfigs DatabaseDatabaseManagementConfigArgs[]

The configuration of the Database Management service.

databaseSoftwareImageId string

The database software image OCID

dbBackupConfigs DatabaseDbBackupConfigArgs[]

(Updatable) Backup Options To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.

dbHomeId string

The OCID of the Database Home.

dbName string

The display name of the database to be created from the backup. It must begin with an alphabetic character and can contain a maximum of eight alphanumeric characters. Special characters are not permitted.

dbSystemId string

The OCID of the DB system.

dbUniqueName string

The DB_UNIQUE_NAME of the Oracle Database being backed up.

dbVersion string

A valid Oracle Database version. To get a list of supported versions, use the ListDbVersions operation.

dbWorkload string

The database workload type.

definedTags {[key: string]: any}

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

freeformTags {[key: string]: any}

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

isCdb boolean

True if the database is a container database.

kmsKeyId string

The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.

kmsKeyMigration boolean

The value to migrate to the kms version from none. Can only use once by setting value to true. You can not switch back to non-kms once you created or migrated.(https://www.oracle.com/security/cloud-security/key-management/faq/)

kmsKeyRotation number

The value to rotate the key version of current kms_key. Just change this value will trigger the rotation.

kmsKeyVersionId string

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.

lastBackupTimestamp string

The date and time when the latest database backup was created.

lifecycleDetails string

Additional information about the current lifecycle state.

ncharacterSet string

The national character set for the database. The default is AL16UTF16. Allowed values are: AL16UTF16 or UTF8.

pdbName string

The name of the pluggable database. The name must begin with an alphabetic character and can contain a maximum of thirty alphanumeric characters. Special characters are not permitted. Pluggable database should not be same as database name.

sidPrefix string

Specifies a prefix for the Oracle SID of the database to be created.

source string

The source of the database: Use NONE for creating a new database. Use DB_BACKUP for creating a new database by restoring from a backup. The default is NONE.

sourceDatabasePointInTimeRecoveryTimestamp string

Point in time recovery timeStamp of the source database at which cloned database system is cloned from the source database system, as described in RFC 3339

state string

The current state of the database.

timeCreated string

The date and time the database was created.

vaultId string

The OCID of the Oracle Cloud Infrastructure vault.

vmClusterId string

The OCID of the VM cluster.

character_set str

The character set for the database. The default is AL32UTF8. Allowed values are:

compartment_id str

The OCID of the compartment.

connection_strings DatabaseConnectionStringArgs]

The Connection strings used to connect to the Oracle Database.

database DatabaseDatabaseArgs

(Updatable) Details for creating a database.

database_management_configs DatabaseDatabaseManagementConfigArgs]

The configuration of the Database Management service.

database_software_image_id str

The database software image OCID

db_backup_configs DatabaseDbBackupConfigArgs]

(Updatable) Backup Options To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.

db_home_id str

The OCID of the Database Home.

db_name str

The display name of the database to be created from the backup. It must begin with an alphabetic character and can contain a maximum of eight alphanumeric characters. Special characters are not permitted.

db_system_id str

The OCID of the DB system.

db_unique_name str

The DB_UNIQUE_NAME of the Oracle Database being backed up.

db_version str

A valid Oracle Database version. To get a list of supported versions, use the ListDbVersions operation.

db_workload str

The database workload type.

defined_tags Mapping[str, Any]

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

freeform_tags Mapping[str, Any]

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

is_cdb bool

True if the database is a container database.

kms_key_id str

The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.

kms_key_migration bool

The value to migrate to the kms version from none. Can only use once by setting value to true. You can not switch back to non-kms once you created or migrated.(https://www.oracle.com/security/cloud-security/key-management/faq/)

kms_key_rotation int

The value to rotate the key version of current kms_key. Just change this value will trigger the rotation.

kms_key_version_id str

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.

last_backup_timestamp str

The date and time when the latest database backup was created.

lifecycle_details str

Additional information about the current lifecycle state.

ncharacter_set str

The national character set for the database. The default is AL16UTF16. Allowed values are: AL16UTF16 or UTF8.

pdb_name str

The name of the pluggable database. The name must begin with an alphabetic character and can contain a maximum of thirty alphanumeric characters. Special characters are not permitted. Pluggable database should not be same as database name.

sid_prefix str

Specifies a prefix for the Oracle SID of the database to be created.

source str

The source of the database: Use NONE for creating a new database. Use DB_BACKUP for creating a new database by restoring from a backup. The default is NONE.

source_database_point_in_time_recovery_timestamp str

Point in time recovery timeStamp of the source database at which cloned database system is cloned from the source database system, as described in RFC 3339

state str

The current state of the database.

time_created str

The date and time the database was created.

vault_id str

The OCID of the Oracle Cloud Infrastructure vault.

vm_cluster_id str

The OCID of the VM cluster.

characterSet String

The character set for the database. The default is AL32UTF8. Allowed values are:

compartmentId String

The OCID of the compartment.

connectionStrings List<Property Map>

The Connection strings used to connect to the Oracle Database.

database Property Map

(Updatable) Details for creating a database.

databaseManagementConfigs List<Property Map>

The configuration of the Database Management service.

databaseSoftwareImageId String

The database software image OCID

dbBackupConfigs List<Property Map>

(Updatable) Backup Options To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.

dbHomeId String

The OCID of the Database Home.

dbName String

The display name of the database to be created from the backup. It must begin with an alphabetic character and can contain a maximum of eight alphanumeric characters. Special characters are not permitted.

dbSystemId String

The OCID of the DB system.

dbUniqueName String

The DB_UNIQUE_NAME of the Oracle Database being backed up.

dbVersion String

A valid Oracle Database version. To get a list of supported versions, use the ListDbVersions operation.

dbWorkload String

The database workload type.

definedTags Map<Any>

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

freeformTags Map<Any>

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

isCdb Boolean

True if the database is a container database.

kmsKeyId String

The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.

kmsKeyMigration Boolean

The value to migrate to the kms version from none. Can only use once by setting value to true. You can not switch back to non-kms once you created or migrated.(https://www.oracle.com/security/cloud-security/key-management/faq/)

kmsKeyRotation Number

The value to rotate the key version of current kms_key. Just change this value will trigger the rotation.

kmsKeyVersionId String

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.

lastBackupTimestamp String

The date and time when the latest database backup was created.

lifecycleDetails String

Additional information about the current lifecycle state.

ncharacterSet String

The national character set for the database. The default is AL16UTF16. Allowed values are: AL16UTF16 or UTF8.

pdbName String

The name of the pluggable database. The name must begin with an alphabetic character and can contain a maximum of thirty alphanumeric characters. Special characters are not permitted. Pluggable database should not be same as database name.

sidPrefix String

Specifies a prefix for the Oracle SID of the database to be created.

source String

The source of the database: Use NONE for creating a new database. Use DB_BACKUP for creating a new database by restoring from a backup. The default is NONE.

sourceDatabasePointInTimeRecoveryTimestamp String

Point in time recovery timeStamp of the source database at which cloned database system is cloned from the source database system, as described in RFC 3339

state String

The current state of the database.

timeCreated String

The date and time the database was created.

vaultId String

The OCID of the Oracle Cloud Infrastructure vault.

vmClusterId String

The OCID of the VM cluster.

Supporting Types

DatabaseConnectionString

AllConnectionStrings Dictionary<string, object>

All connection strings to use to connect to the Database.

CdbDefault string

Host name based CDB Connection String.

CdbIpDefault string

IP based CDB Connection String.

AllConnectionStrings map[string]interface{}

All connection strings to use to connect to the Database.

CdbDefault string

Host name based CDB Connection String.

CdbIpDefault string

IP based CDB Connection String.

allConnectionStrings Map<String,Object>

All connection strings to use to connect to the Database.

cdbDefault String

Host name based CDB Connection String.

cdbIpDefault String

IP based CDB Connection String.

allConnectionStrings {[key: string]: any}

All connection strings to use to connect to the Database.

cdbDefault string

Host name based CDB Connection String.

cdbIpDefault string

IP based CDB Connection String.

all_connection_strings Mapping[str, Any]

All connection strings to use to connect to the Database.

cdb_default str

Host name based CDB Connection String.

cdb_ip_default str

IP based CDB Connection String.

allConnectionStrings Map<Any>

All connection strings to use to connect to the Database.

cdbDefault String

Host name based CDB Connection String.

cdbIpDefault String

IP based CDB Connection String.

DatabaseDatabase

AdminPassword string

A strong password for SYS, SYSTEM, PDB Admin and TDE Wallet. The password must be at least nine characters and contain at least two uppercase, two lowercase, two numbers, and two special characters. The special characters must be _, #, or -.

DbName string

The display name of the database to be created from the backup. It must begin with an alphabetic character and can contain a maximum of eight alphanumeric characters. Special characters are not permitted.

BackupId string

The backup OCID.

BackupTdePassword string

The password to open the TDE wallet.

CharacterSet string

The character set for the database. The default is AL32UTF8. Allowed values are:

DatabaseSoftwareImageId string

The database software image OCID

DbBackupConfig DatabaseDatabaseDbBackupConfig

(Updatable) Backup Options To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.

DbUniqueName string

The DB_UNIQUE_NAME of the Oracle Database being backed up.

DbWorkload string

The database workload type.

DefinedTags Dictionary<string, object>

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

FreeformTags Dictionary<string, object>

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

KmsKeyId string

The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.

KmsKeyVersionId string

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.

NcharacterSet string

The national character set for the database. The default is AL16UTF16. Allowed values are: AL16UTF16 or UTF8.

PdbName string

The name of the pluggable database. The name must begin with an alphabetic character and can contain a maximum of thirty alphanumeric characters. Special characters are not permitted. Pluggable database should not be same as database name.

SidPrefix string

Specifies a prefix for the Oracle SID of the database to be created.

TdeWalletPassword string

The optional password to open the TDE wallet. The password must be at least nine characters and contain at least two uppercase, two lowercase, two numeric, and two special characters. The special characters must be _, #, or -.

VaultId string

The OCID of the Oracle Cloud Infrastructure vault.

AdminPassword string

A strong password for SYS, SYSTEM, PDB Admin and TDE Wallet. The password must be at least nine characters and contain at least two uppercase, two lowercase, two numbers, and two special characters. The special characters must be _, #, or -.

DbName string

The display name of the database to be created from the backup. It must begin with an alphabetic character and can contain a maximum of eight alphanumeric characters. Special characters are not permitted.

BackupId string

The backup OCID.

BackupTdePassword string

The password to open the TDE wallet.

CharacterSet string

The character set for the database. The default is AL32UTF8. Allowed values are:

DatabaseSoftwareImageId string

The database software image OCID

DbBackupConfig DatabaseDatabaseDbBackupConfig

(Updatable) Backup Options To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.

DbUniqueName string

The DB_UNIQUE_NAME of the Oracle Database being backed up.

DbWorkload string

The database workload type.

DefinedTags map[string]interface{}

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

FreeformTags map[string]interface{}

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

KmsKeyId string

The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.

KmsKeyVersionId string

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.

NcharacterSet string

The national character set for the database. The default is AL16UTF16. Allowed values are: AL16UTF16 or UTF8.

PdbName string

The name of the pluggable database. The name must begin with an alphabetic character and can contain a maximum of thirty alphanumeric characters. Special characters are not permitted. Pluggable database should not be same as database name.

SidPrefix string

Specifies a prefix for the Oracle SID of the database to be created.

TdeWalletPassword string

The optional password to open the TDE wallet. The password must be at least nine characters and contain at least two uppercase, two lowercase, two numeric, and two special characters. The special characters must be _, #, or -.

VaultId string

The OCID of the Oracle Cloud Infrastructure vault.

adminPassword String

A strong password for SYS, SYSTEM, PDB Admin and TDE Wallet. The password must be at least nine characters and contain at least two uppercase, two lowercase, two numbers, and two special characters. The special characters must be _, #, or -.

dbName String

The display name of the database to be created from the backup. It must begin with an alphabetic character and can contain a maximum of eight alphanumeric characters. Special characters are not permitted.

backupId String

The backup OCID.

backupTdePassword String

The password to open the TDE wallet.

characterSet String

The character set for the database. The default is AL32UTF8. Allowed values are:

databaseSoftwareImageId String

The database software image OCID

dbBackupConfig DbBackupConfig

(Updatable) Backup Options To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.

dbUniqueName String

The DB_UNIQUE_NAME of the Oracle Database being backed up.

dbWorkload String

The database workload type.

definedTags Map<String,Object>

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

freeformTags Map<String,Object>

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

kmsKeyId String

The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.

kmsKeyVersionId String

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.

ncharacterSet String

The national character set for the database. The default is AL16UTF16. Allowed values are: AL16UTF16 or UTF8.

pdbName String

The name of the pluggable database. The name must begin with an alphabetic character and can contain a maximum of thirty alphanumeric characters. Special characters are not permitted. Pluggable database should not be same as database name.

sidPrefix String

Specifies a prefix for the Oracle SID of the database to be created.

tdeWalletPassword String

The optional password to open the TDE wallet. The password must be at least nine characters and contain at least two uppercase, two lowercase, two numeric, and two special characters. The special characters must be _, #, or -.

vaultId String

The OCID of the Oracle Cloud Infrastructure vault.

adminPassword string

A strong password for SYS, SYSTEM, PDB Admin and TDE Wallet. The password must be at least nine characters and contain at least two uppercase, two lowercase, two numbers, and two special characters. The special characters must be _, #, or -.

dbName string

The display name of the database to be created from the backup. It must begin with an alphabetic character and can contain a maximum of eight alphanumeric characters. Special characters are not permitted.

backupId string

The backup OCID.

backupTdePassword string

The password to open the TDE wallet.

characterSet string

The character set for the database. The default is AL32UTF8. Allowed values are:

databaseSoftwareImageId string

The database software image OCID

dbBackupConfig DatabaseDatabaseDbBackupConfig

(Updatable) Backup Options To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.

dbUniqueName string

The DB_UNIQUE_NAME of the Oracle Database being backed up.

dbWorkload string

The database workload type.

definedTags {[key: string]: any}

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

freeformTags {[key: string]: any}

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

kmsKeyId string

The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.

kmsKeyVersionId string

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.

ncharacterSet string

The national character set for the database. The default is AL16UTF16. Allowed values are: AL16UTF16 or UTF8.

pdbName string

The name of the pluggable database. The name must begin with an alphabetic character and can contain a maximum of thirty alphanumeric characters. Special characters are not permitted. Pluggable database should not be same as database name.

sidPrefix string

Specifies a prefix for the Oracle SID of the database to be created.

tdeWalletPassword string

The optional password to open the TDE wallet. The password must be at least nine characters and contain at least two uppercase, two lowercase, two numeric, and two special characters. The special characters must be _, #, or -.

vaultId string

The OCID of the Oracle Cloud Infrastructure vault.

admin_password str

A strong password for SYS, SYSTEM, PDB Admin and TDE Wallet. The password must be at least nine characters and contain at least two uppercase, two lowercase, two numbers, and two special characters. The special characters must be _, #, or -.

db_name str

The display name of the database to be created from the backup. It must begin with an alphabetic character and can contain a maximum of eight alphanumeric characters. Special characters are not permitted.

backup_id str

The backup OCID.

backup_tde_password str

The password to open the TDE wallet.

character_set str

The character set for the database. The default is AL32UTF8. Allowed values are:

database_software_image_id str

The database software image OCID

db_backup_config DatabaseDatabaseDbBackupConfig

(Updatable) Backup Options To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.

db_unique_name str

The DB_UNIQUE_NAME of the Oracle Database being backed up.

db_workload str

The database workload type.

defined_tags Mapping[str, Any]

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

freeform_tags Mapping[str, Any]

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

kms_key_id str

The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.

kms_key_version_id str

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.

ncharacter_set str

The national character set for the database. The default is AL16UTF16. Allowed values are: AL16UTF16 or UTF8.

pdb_name str

The name of the pluggable database. The name must begin with an alphabetic character and can contain a maximum of thirty alphanumeric characters. Special characters are not permitted. Pluggable database should not be same as database name.

sid_prefix str

Specifies a prefix for the Oracle SID of the database to be created.

tde_wallet_password str

The optional password to open the TDE wallet. The password must be at least nine characters and contain at least two uppercase, two lowercase, two numeric, and two special characters. The special characters must be _, #, or -.

vault_id str

The OCID of the Oracle Cloud Infrastructure vault.

adminPassword String

A strong password for SYS, SYSTEM, PDB Admin and TDE Wallet. The password must be at least nine characters and contain at least two uppercase, two lowercase, two numbers, and two special characters. The special characters must be _, #, or -.

dbName String

The display name of the database to be created from the backup. It must begin with an alphabetic character and can contain a maximum of eight alphanumeric characters. Special characters are not permitted.

backupId String

The backup OCID.

backupTdePassword String

The password to open the TDE wallet.

characterSet String

The character set for the database. The default is AL32UTF8. Allowed values are:

databaseSoftwareImageId String

The database software image OCID

dbBackupConfig Property Map

(Updatable) Backup Options To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.

dbUniqueName String

The DB_UNIQUE_NAME of the Oracle Database being backed up.

dbWorkload String

The database workload type.

definedTags Map<Any>

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

freeformTags Map<Any>

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

kmsKeyId String

The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.

kmsKeyVersionId String

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.

ncharacterSet String

The national character set for the database. The default is AL16UTF16. Allowed values are: AL16UTF16 or UTF8.

pdbName String

The name of the pluggable database. The name must begin with an alphabetic character and can contain a maximum of thirty alphanumeric characters. Special characters are not permitted. Pluggable database should not be same as database name.

sidPrefix String

Specifies a prefix for the Oracle SID of the database to be created.

tdeWalletPassword String

The optional password to open the TDE wallet. The password must be at least nine characters and contain at least two uppercase, two lowercase, two numeric, and two special characters. The special characters must be _, #, or -.

vaultId String

The OCID of the Oracle Cloud Infrastructure vault.

DatabaseDatabaseDbBackupConfig

AutoBackupEnabled bool

(Updatable) If set to true, configures automatic backups. If you previously used RMAN or dbcli to configure backups and then you switch to using the Console or the API for backups, a new backup configuration is created and associated with your database. This means that you can no longer rely on your previously configured unmanaged backups to work.

AutoBackupWindow string

(Updatable) Time window selected for initiating automatic backup for the database system. There are twelve available two-hour time windows. If no option is selected, a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example: SLOT_TWO

BackupDestinationDetails List<DatabaseDatabaseDbBackupConfigBackupDestinationDetail>

Backup destination details.

RecoveryWindowInDays int

(Updatable) Number of days between the current and the earliest point of recoverability covered by automatic backups. This value applies to automatic backups only. After a new automatic backup has been created, Oracle removes old automatic backups that are created before the window. When the value is updated, it is applied to all existing automatic backups.

AutoBackupEnabled bool

(Updatable) If set to true, configures automatic backups. If you previously used RMAN or dbcli to configure backups and then you switch to using the Console or the API for backups, a new backup configuration is created and associated with your database. This means that you can no longer rely on your previously configured unmanaged backups to work.

AutoBackupWindow string

(Updatable) Time window selected for initiating automatic backup for the database system. There are twelve available two-hour time windows. If no option is selected, a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example: SLOT_TWO

BackupDestinationDetails []DatabaseDatabaseDbBackupConfigBackupDestinationDetail

Backup destination details.

RecoveryWindowInDays int

(Updatable) Number of days between the current and the earliest point of recoverability covered by automatic backups. This value applies to automatic backups only. After a new automatic backup has been created, Oracle removes old automatic backups that are created before the window. When the value is updated, it is applied to all existing automatic backups.

autoBackupEnabled Boolean

(Updatable) If set to true, configures automatic backups. If you previously used RMAN or dbcli to configure backups and then you switch to using the Console or the API for backups, a new backup configuration is created and associated with your database. This means that you can no longer rely on your previously configured unmanaged backups to work.

autoBackupWindow String

(Updatable) Time window selected for initiating automatic backup for the database system. There are twelve available two-hour time windows. If no option is selected, a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example: SLOT_TWO

backupDestinationDetails List<DbBackupConfigBackupDestinationDetail>

Backup destination details.

recoveryWindowInDays Integer

(Updatable) Number of days between the current and the earliest point of recoverability covered by automatic backups. This value applies to automatic backups only. After a new automatic backup has been created, Oracle removes old automatic backups that are created before the window. When the value is updated, it is applied to all existing automatic backups.

autoBackupEnabled boolean

(Updatable) If set to true, configures automatic backups. If you previously used RMAN or dbcli to configure backups and then you switch to using the Console or the API for backups, a new backup configuration is created and associated with your database. This means that you can no longer rely on your previously configured unmanaged backups to work.

autoBackupWindow string

(Updatable) Time window selected for initiating automatic backup for the database system. There are twelve available two-hour time windows. If no option is selected, a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example: SLOT_TWO

backupDestinationDetails DatabaseDatabaseDbBackupConfigBackupDestinationDetail[]

Backup destination details.

recoveryWindowInDays number

(Updatable) Number of days between the current and the earliest point of recoverability covered by automatic backups. This value applies to automatic backups only. After a new automatic backup has been created, Oracle removes old automatic backups that are created before the window. When the value is updated, it is applied to all existing automatic backups.

auto_backup_enabled bool

(Updatable) If set to true, configures automatic backups. If you previously used RMAN or dbcli to configure backups and then you switch to using the Console or the API for backups, a new backup configuration is created and associated with your database. This means that you can no longer rely on your previously configured unmanaged backups to work.

auto_backup_window str

(Updatable) Time window selected for initiating automatic backup for the database system. There are twelve available two-hour time windows. If no option is selected, a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example: SLOT_TWO

backup_destination_details DatabaseDatabaseDbBackupConfigBackupDestinationDetail]

Backup destination details.

recovery_window_in_days int

(Updatable) Number of days between the current and the earliest point of recoverability covered by automatic backups. This value applies to automatic backups only. After a new automatic backup has been created, Oracle removes old automatic backups that are created before the window. When the value is updated, it is applied to all existing automatic backups.

autoBackupEnabled Boolean

(Updatable) If set to true, configures automatic backups. If you previously used RMAN or dbcli to configure backups and then you switch to using the Console or the API for backups, a new backup configuration is created and associated with your database. This means that you can no longer rely on your previously configured unmanaged backups to work.

autoBackupWindow String

(Updatable) Time window selected for initiating automatic backup for the database system. There are twelve available two-hour time windows. If no option is selected, a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example: SLOT_TWO

backupDestinationDetails List<Property Map>

Backup destination details.

recoveryWindowInDays Number

(Updatable) Number of days between the current and the earliest point of recoverability covered by automatic backups. This value applies to automatic backups only. After a new automatic backup has been created, Oracle removes old automatic backups that are created before the window. When the value is updated, it is applied to all existing automatic backups.

DatabaseDatabaseDbBackupConfigBackupDestinationDetail

Id string

The OCID of the backup destination.

Type string

Type of the database backup destination.

VpcUser string
Id string

The OCID of the backup destination.

Type string

Type of the database backup destination.

VpcUser string
id String

The OCID of the backup destination.

type String

Type of the database backup destination.

vpcUser String
id string

The OCID of the backup destination.

type string

Type of the database backup destination.

vpcUser string
id str

The OCID of the backup destination.

type str

Type of the database backup destination.

vpc_user str
id String

The OCID of the backup destination.

type String

Type of the database backup destination.

vpcUser String

DatabaseDatabaseManagementConfig

ManagementStatus string

The status of the Database Management service.

ManagementType string

The Database Management type.

ManagementStatus string

The status of the Database Management service.

ManagementType string

The Database Management type.

managementStatus String

The status of the Database Management service.

managementType String

The Database Management type.

managementStatus string

The status of the Database Management service.

managementType string

The Database Management type.

management_status str

The status of the Database Management service.

management_type str

The Database Management type.

managementStatus String

The status of the Database Management service.

managementType String

The Database Management type.

DatabaseDbBackupConfig

AutoBackupEnabled bool

(Updatable) If set to true, configures automatic backups. If you previously used RMAN or dbcli to configure backups and then you switch to using the Console or the API for backups, a new backup configuration is created and associated with your database. This means that you can no longer rely on your previously configured unmanaged backups to work.

AutoBackupWindow string

(Updatable) Time window selected for initiating automatic backup for the database system. There are twelve available two-hour time windows. If no option is selected, a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example: SLOT_TWO

BackupDestinationDetails List<DatabaseDbBackupConfigBackupDestinationDetail>

Backup destination details.

RecoveryWindowInDays int

(Updatable) Number of days between the current and the earliest point of recoverability covered by automatic backups. This value applies to automatic backups only. After a new automatic backup has been created, Oracle removes old automatic backups that are created before the window. When the value is updated, it is applied to all existing automatic backups.

AutoBackupEnabled bool

(Updatable) If set to true, configures automatic backups. If you previously used RMAN or dbcli to configure backups and then you switch to using the Console or the API for backups, a new backup configuration is created and associated with your database. This means that you can no longer rely on your previously configured unmanaged backups to work.

AutoBackupWindow string

(Updatable) Time window selected for initiating automatic backup for the database system. There are twelve available two-hour time windows. If no option is selected, a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example: SLOT_TWO

BackupDestinationDetails []DatabaseDbBackupConfigBackupDestinationDetail

Backup destination details.

RecoveryWindowInDays int

(Updatable) Number of days between the current and the earliest point of recoverability covered by automatic backups. This value applies to automatic backups only. After a new automatic backup has been created, Oracle removes old automatic backups that are created before the window. When the value is updated, it is applied to all existing automatic backups.

autoBackupEnabled Boolean

(Updatable) If set to true, configures automatic backups. If you previously used RMAN or dbcli to configure backups and then you switch to using the Console or the API for backups, a new backup configuration is created and associated with your database. This means that you can no longer rely on your previously configured unmanaged backups to work.

autoBackupWindow String

(Updatable) Time window selected for initiating automatic backup for the database system. There are twelve available two-hour time windows. If no option is selected, a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example: SLOT_TWO

backupDestinationDetails List<DbBackupConfigBackupDestinationDetail>

Backup destination details.

recoveryWindowInDays Integer

(Updatable) Number of days between the current and the earliest point of recoverability covered by automatic backups. This value applies to automatic backups only. After a new automatic backup has been created, Oracle removes old automatic backups that are created before the window. When the value is updated, it is applied to all existing automatic backups.

autoBackupEnabled boolean

(Updatable) If set to true, configures automatic backups. If you previously used RMAN or dbcli to configure backups and then you switch to using the Console or the API for backups, a new backup configuration is created and associated with your database. This means that you can no longer rely on your previously configured unmanaged backups to work.

autoBackupWindow string

(Updatable) Time window selected for initiating automatic backup for the database system. There are twelve available two-hour time windows. If no option is selected, a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example: SLOT_TWO

backupDestinationDetails DatabaseDbBackupConfigBackupDestinationDetail[]

Backup destination details.

recoveryWindowInDays number

(Updatable) Number of days between the current and the earliest point of recoverability covered by automatic backups. This value applies to automatic backups only. After a new automatic backup has been created, Oracle removes old automatic backups that are created before the window. When the value is updated, it is applied to all existing automatic backups.

auto_backup_enabled bool

(Updatable) If set to true, configures automatic backups. If you previously used RMAN or dbcli to configure backups and then you switch to using the Console or the API for backups, a new backup configuration is created and associated with your database. This means that you can no longer rely on your previously configured unmanaged backups to work.

auto_backup_window str

(Updatable) Time window selected for initiating automatic backup for the database system. There are twelve available two-hour time windows. If no option is selected, a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example: SLOT_TWO

backup_destination_details DatabaseDbBackupConfigBackupDestinationDetail]

Backup destination details.

recovery_window_in_days int

(Updatable) Number of days between the current and the earliest point of recoverability covered by automatic backups. This value applies to automatic backups only. After a new automatic backup has been created, Oracle removes old automatic backups that are created before the window. When the value is updated, it is applied to all existing automatic backups.

autoBackupEnabled Boolean

(Updatable) If set to true, configures automatic backups. If you previously used RMAN or dbcli to configure backups and then you switch to using the Console or the API for backups, a new backup configuration is created and associated with your database. This means that you can no longer rely on your previously configured unmanaged backups to work.

autoBackupWindow String

(Updatable) Time window selected for initiating automatic backup for the database system. There are twelve available two-hour time windows. If no option is selected, a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example: SLOT_TWO

backupDestinationDetails List<Property Map>

Backup destination details.

recoveryWindowInDays Number

(Updatable) Number of days between the current and the earliest point of recoverability covered by automatic backups. This value applies to automatic backups only. After a new automatic backup has been created, Oracle removes old automatic backups that are created before the window. When the value is updated, it is applied to all existing automatic backups.

DatabaseDbBackupConfigBackupDestinationDetail

Id string

The OCID of the backup destination.

Type string

Type of the database backup destination.

VpcUser string
Id string

The OCID of the backup destination.

Type string

Type of the database backup destination.

VpcUser string
id String

The OCID of the backup destination.

type String

Type of the database backup destination.

vpcUser String
id string

The OCID of the backup destination.

type string

Type of the database backup destination.

vpcUser string
id str

The OCID of the backup destination.

type str

Type of the database backup destination.

vpc_user str
id String

The OCID of the backup destination.

type String

Type of the database backup destination.

vpcUser String

Import

Databases can be imported using the id, e.g.

 $ pulumi import oci:Database/database:Database test_database "id"

Package Details

Repository
https://github.com/pulumi/pulumi-oci
License
Apache-2.0
Notes

This Pulumi package is based on the oci Terraform Provider.