Oracle Cloud Infrastructure v2.33.0, May 1 25

Oracle Cloud Infrastructure v2.33.0 published on Thursday, May 1, 2025 by Pulumi

oci.Database.Database

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.33.0 published on Thursday, May 1, 2025 by Pulumi

Create Database Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Database(name: string, args: DatabaseArgs, opts?: CustomResourceOptions);

@overload
def Database(resource_name: str,
             args: DatabaseArgs,
             opts: Optional[ResourceOptions] = None)

@overload
def Database(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             database: Optional[DatabaseDatabaseArgs] = None,
             db_home_id: Optional[str] = None,
             source: Optional[str] = None,
             action_trigger: Optional[int] = None,
             data_guard_action: Optional[str] = None,
             db_version: Optional[str] = None,
             key_store_id: 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,
             vault_id: Optional[str] = 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.

Parameters

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.

Constructor example

The following reference example uses placeholder values for all input properties.

var databaseResource = new Oci.Database.Database("databaseResource", new()
{
    DatabaseName = new Oci.Database.Inputs.DatabaseDatabaseArgs
    {
        AdminPassword = "string",
        BackupId = "string",
        BackupTdePassword = "string",
        CharacterSet = "string",
        DatabaseAdminPassword = "string",
        DatabaseSoftwareImageId = "string",
        DbBackupConfig = new Oci.Database.Inputs.DatabaseDatabaseDbBackupConfigArgs
        {
            AutoBackupEnabled = false,
            AutoBackupWindow = "string",
            AutoFullBackupDay = "string",
            AutoFullBackupWindow = "string",
            BackupDeletionPolicy = "string",
            BackupDestinationDetails = new[]
            {
                new Oci.Database.Inputs.DatabaseDatabaseDbBackupConfigBackupDestinationDetailArgs
                {
                    DbrsPolicyId = "string",
                    Id = "string",
                    Type = "string",
                    VpcUser = "string",
                },
            },
            RecoveryWindowInDays = 0,
            RunImmediateFullBackup = false,
        },
        DbName = "string",
        DbUniqueName = "string",
        DbWorkload = "string",
        DefinedTags = 
        {
            { "string", "string" },
        },
        EncryptionKeyLocationDetails = new Oci.Database.Inputs.DatabaseDatabaseEncryptionKeyLocationDetailsArgs
        {
            HsmPassword = "string",
            ProviderType = "string",
        },
        FreeformTags = 
        {
            { "string", "string" },
        },
        IsActiveDataGuardEnabled = false,
        KmsKeyId = "string",
        KmsKeyVersionId = "string",
        NcharacterSet = "string",
        PdbName = "string",
        PluggableDatabases = new[]
        {
            "string",
        },
        ProtectionMode = "string",
        SidPrefix = "string",
        SourceDatabaseId = "string",
        SourceEncryptionKeyLocationDetails = new Oci.Database.Inputs.DatabaseDatabaseSourceEncryptionKeyLocationDetailsArgs
        {
            HsmPassword = "string",
            ProviderType = "string",
        },
        SourceTdeWalletPassword = "string",
        TdeWalletPassword = "string",
        TransportType = "string",
        VaultId = "string",
    },
    DbHomeId = "string",
    Source = "string",
    ActionTrigger = 0,
    DataGuardAction = "string",
    DbVersion = "string",
    KeyStoreId = "string",
    KmsKeyId = "string",
    KmsKeyMigration = false,
    KmsKeyRotation = 0,
    KmsKeyVersionId = "string",
    VaultId = "string",
});

example, err := database.NewDatabase(ctx, "databaseResource", &database.DatabaseArgs{
	Database: &database.DatabaseDatabaseArgs{
		AdminPassword:           pulumi.String("string"),
		BackupId:                pulumi.String("string"),
		BackupTdePassword:       pulumi.String("string"),
		CharacterSet:            pulumi.String("string"),
		DatabaseAdminPassword:   pulumi.String("string"),
		DatabaseSoftwareImageId: pulumi.String("string"),
		DbBackupConfig: &database.DatabaseDatabaseDbBackupConfigArgs{
			AutoBackupEnabled:    pulumi.Bool(false),
			AutoBackupWindow:     pulumi.String("string"),
			AutoFullBackupDay:    pulumi.String("string"),
			AutoFullBackupWindow: pulumi.String("string"),
			BackupDeletionPolicy: pulumi.String("string"),
			BackupDestinationDetails: database.DatabaseDatabaseDbBackupConfigBackupDestinationDetailArray{
				&database.DatabaseDatabaseDbBackupConfigBackupDestinationDetailArgs{
					DbrsPolicyId: pulumi.String("string"),
					Id:           pulumi.String("string"),
					Type:         pulumi.String("string"),
					VpcUser:      pulumi.String("string"),
				},
			},
			RecoveryWindowInDays:   pulumi.Int(0),
			RunImmediateFullBackup: pulumi.Bool(false),
		},
		DbName:       pulumi.String("string"),
		DbUniqueName: pulumi.String("string"),
		DbWorkload:   pulumi.String("string"),
		DefinedTags: pulumi.StringMap{
			"string": pulumi.String("string"),
		},
		EncryptionKeyLocationDetails: &database.DatabaseDatabaseEncryptionKeyLocationDetailsArgs{
			HsmPassword:  pulumi.String("string"),
			ProviderType: pulumi.String("string"),
		},
		FreeformTags: pulumi.StringMap{
			"string": pulumi.String("string"),
		},
		IsActiveDataGuardEnabled: pulumi.Bool(false),
		KmsKeyId:                 pulumi.String("string"),
		KmsKeyVersionId:          pulumi.String("string"),
		NcharacterSet:            pulumi.String("string"),
		PdbName:                  pulumi.String("string"),
		PluggableDatabases: pulumi.StringArray{
			pulumi.String("string"),
		},
		ProtectionMode:   pulumi.String("string"),
		SidPrefix:        pulumi.String("string"),
		SourceDatabaseId: pulumi.String("string"),
		SourceEncryptionKeyLocationDetails: &database.DatabaseDatabaseSourceEncryptionKeyLocationDetailsArgs{
			HsmPassword:  pulumi.String("string"),
			ProviderType: pulumi.String("string"),
		},
		SourceTdeWalletPassword: pulumi.String("string"),
		TdeWalletPassword:       pulumi.String("string"),
		TransportType:           pulumi.String("string"),
		VaultId:                 pulumi.String("string"),
	},
	DbHomeId:        pulumi.String("string"),
	Source:          pulumi.String("string"),
	ActionTrigger:   pulumi.Int(0),
	DataGuardAction: pulumi.String("string"),
	DbVersion:       pulumi.String("string"),
	KeyStoreId:      pulumi.String("string"),
	KmsKeyId:        pulumi.String("string"),
	KmsKeyMigration: pulumi.Bool(false),
	KmsKeyRotation:  pulumi.Int(0),
	KmsKeyVersionId: pulumi.String("string"),
	VaultId:         pulumi.String("string"),
})

var databaseResource = new Database("databaseResource", DatabaseArgs.builder()
    .database(DatabaseDatabaseArgs.builder()
        .adminPassword("string")
        .backupId("string")
        .backupTdePassword("string")
        .characterSet("string")
        .databaseAdminPassword("string")
        .databaseSoftwareImageId("string")
        .dbBackupConfig(DatabaseDatabaseDbBackupConfigArgs.builder()
            .autoBackupEnabled(false)
            .autoBackupWindow("string")
            .autoFullBackupDay("string")
            .autoFullBackupWindow("string")
            .backupDeletionPolicy("string")
            .backupDestinationDetails(DatabaseDatabaseDbBackupConfigBackupDestinationDetailArgs.builder()
                .dbrsPolicyId("string")
                .id("string")
                .type("string")
                .vpcUser("string")
                .build())
            .recoveryWindowInDays(0)
            .runImmediateFullBackup(false)
            .build())
        .dbName("string")
        .dbUniqueName("string")
        .dbWorkload("string")
        .definedTags(Map.of("string", "string"))
        .encryptionKeyLocationDetails(DatabaseDatabaseEncryptionKeyLocationDetailsArgs.builder()
            .hsmPassword("string")
            .providerType("string")
            .build())
        .freeformTags(Map.of("string", "string"))
        .isActiveDataGuardEnabled(false)
        .kmsKeyId("string")
        .kmsKeyVersionId("string")
        .ncharacterSet("string")
        .pdbName("string")
        .pluggableDatabases("string")
        .protectionMode("string")
        .sidPrefix("string")
        .sourceDatabaseId("string")
        .sourceEncryptionKeyLocationDetails(DatabaseDatabaseSourceEncryptionKeyLocationDetailsArgs.builder()
            .hsmPassword("string")
            .providerType("string")
            .build())
        .sourceTdeWalletPassword("string")
        .tdeWalletPassword("string")
        .transportType("string")
        .vaultId("string")
        .build())
    .dbHomeId("string")
    .source("string")
    .actionTrigger(0)
    .dataGuardAction("string")
    .dbVersion("string")
    .keyStoreId("string")
    .kmsKeyId("string")
    .kmsKeyMigration(false)
    .kmsKeyRotation(0)
    .kmsKeyVersionId("string")
    .vaultId("string")
    .build());

database_resource = oci.database.Database("databaseResource",
    database={
        "admin_password": "string",
        "backup_id": "string",
        "backup_tde_password": "string",
        "character_set": "string",
        "database_admin_password": "string",
        "database_software_image_id": "string",
        "db_backup_config": {
            "auto_backup_enabled": False,
            "auto_backup_window": "string",
            "auto_full_backup_day": "string",
            "auto_full_backup_window": "string",
            "backup_deletion_policy": "string",
            "backup_destination_details": [{
                "dbrs_policy_id": "string",
                "id": "string",
                "type": "string",
                "vpc_user": "string",
            }],
            "recovery_window_in_days": 0,
            "run_immediate_full_backup": False,
        },
        "db_name": "string",
        "db_unique_name": "string",
        "db_workload": "string",
        "defined_tags": {
            "string": "string",
        },
        "encryption_key_location_details": {
            "hsm_password": "string",
            "provider_type": "string",
        },
        "freeform_tags": {
            "string": "string",
        },
        "is_active_data_guard_enabled": False,
        "kms_key_id": "string",
        "kms_key_version_id": "string",
        "ncharacter_set": "string",
        "pdb_name": "string",
        "pluggable_databases": ["string"],
        "protection_mode": "string",
        "sid_prefix": "string",
        "source_database_id": "string",
        "source_encryption_key_location_details": {
            "hsm_password": "string",
            "provider_type": "string",
        },
        "source_tde_wallet_password": "string",
        "tde_wallet_password": "string",
        "transport_type": "string",
        "vault_id": "string",
    },
    db_home_id="string",
    source="string",
    action_trigger=0,
    data_guard_action="string",
    db_version="string",
    key_store_id="string",
    kms_key_id="string",
    kms_key_migration=False,
    kms_key_rotation=0,
    kms_key_version_id="string",
    vault_id="string")

const databaseResource = new oci.database.Database("databaseResource", {
    database: {
        adminPassword: "string",
        backupId: "string",
        backupTdePassword: "string",
        characterSet: "string",
        databaseAdminPassword: "string",
        databaseSoftwareImageId: "string",
        dbBackupConfig: {
            autoBackupEnabled: false,
            autoBackupWindow: "string",
            autoFullBackupDay: "string",
            autoFullBackupWindow: "string",
            backupDeletionPolicy: "string",
            backupDestinationDetails: [{
                dbrsPolicyId: "string",
                id: "string",
                type: "string",
                vpcUser: "string",
            }],
            recoveryWindowInDays: 0,
            runImmediateFullBackup: false,
        },
        dbName: "string",
        dbUniqueName: "string",
        dbWorkload: "string",
        definedTags: {
            string: "string",
        },
        encryptionKeyLocationDetails: {
            hsmPassword: "string",
            providerType: "string",
        },
        freeformTags: {
            string: "string",
        },
        isActiveDataGuardEnabled: false,
        kmsKeyId: "string",
        kmsKeyVersionId: "string",
        ncharacterSet: "string",
        pdbName: "string",
        pluggableDatabases: ["string"],
        protectionMode: "string",
        sidPrefix: "string",
        sourceDatabaseId: "string",
        sourceEncryptionKeyLocationDetails: {
            hsmPassword: "string",
            providerType: "string",
        },
        sourceTdeWalletPassword: "string",
        tdeWalletPassword: "string",
        transportType: "string",
        vaultId: "string",
    },
    dbHomeId: "string",
    source: "string",
    actionTrigger: 0,
    dataGuardAction: "string",
    dbVersion: "string",
    keyStoreId: "string",
    kmsKeyId: "string",
    kmsKeyMigration: false,
    kmsKeyRotation: 0,
    kmsKeyVersionId: "string",
    vaultId: "string",
});

type: oci:Database:Database
properties:
    actionTrigger: 0
    dataGuardAction: string
    database:
        adminPassword: string
        backupId: string
        backupTdePassword: string
        characterSet: string
        databaseAdminPassword: string
        databaseSoftwareImageId: string
        dbBackupConfig:
            autoBackupEnabled: false
            autoBackupWindow: string
            autoFullBackupDay: string
            autoFullBackupWindow: string
            backupDeletionPolicy: string
            backupDestinationDetails:
                - dbrsPolicyId: string
                  id: string
                  type: string
                  vpcUser: string
            recoveryWindowInDays: 0
            runImmediateFullBackup: false
        dbName: string
        dbUniqueName: string
        dbWorkload: string
        definedTags:
            string: string
        encryptionKeyLocationDetails:
            hsmPassword: string
            providerType: string
        freeformTags:
            string: string
        isActiveDataGuardEnabled: false
        kmsKeyId: string
        kmsKeyVersionId: string
        ncharacterSet: string
        pdbName: string
        pluggableDatabases:
            - string
        protectionMode: string
        sidPrefix: string
        sourceDatabaseId: string
        sourceEncryptionKeyLocationDetails:
            hsmPassword: string
            providerType: string
        sourceTdeWalletPassword: string
        tdeWalletPassword: string
        transportType: string
        vaultId: string
    dbHomeId: string
    dbVersion: string
    keyStoreId: string
    kmsKeyId: string
    kmsKeyMigration: false
    kmsKeyRotation: 0
    kmsKeyVersionId: string
    source: string
    vaultId: string

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

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Database resource accepts the following input properties:

DatabaseName DatabaseDatabase

(Updatable) Details for creating a database.

Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.

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. Use DATAGUARD for creating a new STANDBY database for a Data Guard setup. The default is NONE.

ActionTrigger int

(Applicable when source=DATAGUARD) An optional property when incremented triggers Data Guard operations such as Failover, Switchover, Reinstate, Data Guard Configuration Update and Convert Standby Database to Standalone . Could be set to any integer value.

DataGuardAction string

Describes the Data Guard operation to be triggered. Could be set to a string value ('Switchover', 'Failover', 'Reinstate', 'DgConfig', "ConvertToStandalone').

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

DbVersion string

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

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

KeyStoreId string

The OCID of the key store of Oracle Vault.

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

VaultId string

The OCID of the Oracle Cloud Infrastructure vault. This parameter and secretId are required for Customer Managed Keys.

Database DatabaseDatabaseArgs

(Updatable) Details for creating a database.

Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.

DbHomeId string

The OCID of the Database Home.

Source string

ActionTrigger int

DataGuardAction string

Describes the Data Guard operation to be triggered. Could be set to a string value ('Switchover', 'Failover', 'Reinstate', 'DgConfig', "ConvertToStandalone').

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

DbVersion string

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

KeyStoreId string

The OCID of the key store of Oracle Vault.

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

KmsKeyRotation int

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

KmsKeyVersionId string

VaultId string

The OCID of the Oracle Cloud Infrastructure vault. This parameter and secretId are required for Customer Managed Keys.

database DatabaseDatabaseArgs

(Updatable) Details for creating a database.

Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.

dbHomeId String

The OCID of the Database Home.

source String

actionTrigger Integer

dataGuardAction String

Describes the Data Guard operation to be triggered. Could be set to a string value ('Switchover', 'Failover', 'Reinstate', 'DgConfig', "ConvertToStandalone').

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

dbVersion String

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

keyStoreId String

The OCID of the key store of Oracle Vault.

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

kmsKeyRotation Integer

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

kmsKeyVersionId String

vaultId String

The OCID of the Oracle Cloud Infrastructure vault. This parameter and secretId are required for Customer Managed Keys.

database DatabaseDatabase

(Updatable) Details for creating a database.

Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.

dbHomeId string

The OCID of the Database Home.

source string

actionTrigger number

dataGuardAction string

Describes the Data Guard operation to be triggered. Could be set to a string value ('Switchover', 'Failover', 'Reinstate', 'DgConfig', "ConvertToStandalone').

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

dbVersion string

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

keyStoreId string

The OCID of the key store of Oracle Vault.

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

kmsKeyRotation number

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

kmsKeyVersionId string

vaultId string

The OCID of the Oracle Cloud Infrastructure vault. This parameter and secretId are required for Customer Managed Keys.

database DatabaseDatabaseArgs

(Updatable) Details for creating a database.

Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.

db_home_id str

The OCID of the Database Home.

source str

action_trigger int

data_guard_action str

Describes the Data Guard operation to be triggered. Could be set to a string value ('Switchover', 'Failover', 'Reinstate', 'DgConfig', "ConvertToStandalone').

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

db_version str

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

key_store_id str

The OCID of the key store of Oracle Vault.

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

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

vault_id str

The OCID of the Oracle Cloud Infrastructure vault. This parameter and secretId are required for Customer Managed Keys.

database Property Map

(Updatable) Details for creating a database.

Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.

dbHomeId String

The OCID of the Database Home.

source String

actionTrigger Number

dataGuardAction String

Describes the Data Guard operation to be triggered. Could be set to a string value ('Switchover', 'Failover', 'Reinstate', 'DgConfig', "ConvertToStandalone').

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

dbVersion String

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

keyStoreId String

The OCID of the key store of Oracle Vault.

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

kmsKeyRotation Number

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

kmsKeyVersionId String

vaultId String

The OCID of the Oracle Cloud Infrastructure vault. This parameter and secretId are required for Customer Managed Keys.

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.
CompartmentId string: The OCID of the compartment.
ConnectionStrings List<DatabaseConnectionString>: The Connection strings used to connect to the Oracle Database.
DataGuardGroups List<DatabaseDataGuardGroup>: Details of Data Guard setup that the given database is part of. Also includes information about databases part of this Data Guard group and properties for their Data Guard configuration.
DatabaseManagementConfigs List<DatabaseDatabaseManagementConfig>: The configuration of the Database Management service.
DatabaseSoftwareImageId string: The database software image OCID
DbBackupConfigs List<DatabaseDbBackupConfig>: 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 database name.
DbSystemId string: The OCID of the DB system.
DbUniqueName string: A system-generated name for the database to ensure uniqueness within an Oracle Data Guard group (a primary database and its standby databases). The unique name cannot be changed.
DbWorkload string: Deprecated. The dbWorkload field has been deprecated for Exadata Database Service on Dedicated Infrastructure, Exadata Database Service on Cloud@Customer, and Base Database Service. Support for this attribute will end in November 2023. You may choose to update your custom scripts to exclude the dbWorkload attribute. After November 2023 if you pass a value to the dbWorkload attribute, it will be ignored.
DefinedTags Dictionary<string, string>: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
FreeformTags Dictionary<string, string>: 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.
KeyStoreWalletName string: The wallet name for Oracle Key Vault.
LastBackupDurationInSeconds int: The duration when the latest database backup created.
LastBackupTimestamp string: The date and time when the latest database backup was created.
LastFailedBackupTimestamp string: The date and time when the latest database backup failed.
LifecycleDetails string: Additional information about the current lifecycle state.
NcharacterSet string: The national character set for the database.
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.
CompartmentId string: The OCID of the compartment.
ConnectionStrings []DatabaseConnectionString: The Connection strings used to connect to the Oracle Database.
DataGuardGroups []DatabaseDataGuardGroup: Details of Data Guard setup that the given database is part of. Also includes information about databases part of this Data Guard group and properties for their Data Guard configuration.
DatabaseManagementConfigs []DatabaseDatabaseManagementConfig: The configuration of the Database Management service.
DatabaseSoftwareImageId string: The database software image OCID
DbBackupConfigs []DatabaseDbBackupConfig: 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 database name.
DbSystemId string: The OCID of the DB system.
DbUniqueName string: A system-generated name for the database to ensure uniqueness within an Oracle Data Guard group (a primary database and its standby databases). The unique name cannot be changed.
DbWorkload string: Deprecated. The dbWorkload field has been deprecated for Exadata Database Service on Dedicated Infrastructure, Exadata Database Service on Cloud@Customer, and Base Database Service. Support for this attribute will end in November 2023. You may choose to update your custom scripts to exclude the dbWorkload attribute. After November 2023 if you pass a value to the dbWorkload attribute, it will be ignored.
DefinedTags map[string]string: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
FreeformTags map[string]string: 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.
KeyStoreWalletName string: The wallet name for Oracle Key Vault.
LastBackupDurationInSeconds int: The duration when the latest database backup created.
LastBackupTimestamp string: The date and time when the latest database backup was created.
LastFailedBackupTimestamp string: The date and time when the latest database backup failed.
LifecycleDetails string: Additional information about the current lifecycle state.
NcharacterSet string: The national character set for the database.
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.
compartmentId String: The OCID of the compartment.
connectionStrings List<ConnectionString>: The Connection strings used to connect to the Oracle Database.
dataGuardGroups List<DataGuardGroup>: Details of Data Guard setup that the given database is part of. Also includes information about databases part of this Data Guard group and properties for their Data Guard configuration.
databaseManagementConfigs List<ManagementConfig>: The configuration of the Database Management service.
databaseSoftwareImageId String: The database software image OCID
dbBackupConfigs List<DbBackupConfig>: 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 database name.
dbSystemId String: The OCID of the DB system.
dbUniqueName String: A system-generated name for the database to ensure uniqueness within an Oracle Data Guard group (a primary database and its standby databases). The unique name cannot be changed.
dbWorkload String: Deprecated. The dbWorkload field has been deprecated for Exadata Database Service on Dedicated Infrastructure, Exadata Database Service on Cloud@Customer, and Base Database Service. Support for this attribute will end in November 2023. You may choose to update your custom scripts to exclude the dbWorkload attribute. After November 2023 if you pass a value to the dbWorkload attribute, it will be ignored.
definedTags Map<String,String>: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
freeformTags Map<String,String>: 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.
keyStoreWalletName String: The wallet name for Oracle Key Vault.
lastBackupDurationInSeconds Integer: The duration when the latest database backup created.
lastBackupTimestamp String: The date and time when the latest database backup was created.
lastFailedBackupTimestamp String: The date and time when the latest database backup failed.
lifecycleDetails String: Additional information about the current lifecycle state.
ncharacterSet String: The national character set for the database.
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.
compartmentId string: The OCID of the compartment.
connectionStrings DatabaseConnectionString[]: The Connection strings used to connect to the Oracle Database.
dataGuardGroups DatabaseDataGuardGroup[]: Details of Data Guard setup that the given database is part of. Also includes information about databases part of this Data Guard group and properties for their Data Guard configuration.
databaseManagementConfigs DatabaseDatabaseManagementConfig[]: The configuration of the Database Management service.
databaseSoftwareImageId string: The database software image OCID
dbBackupConfigs DatabaseDbBackupConfig[]: 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 database name.
dbSystemId string: The OCID of the DB system.
dbUniqueName string: A system-generated name for the database to ensure uniqueness within an Oracle Data Guard group (a primary database and its standby databases). The unique name cannot be changed.
dbWorkload string: Deprecated. The dbWorkload field has been deprecated for Exadata Database Service on Dedicated Infrastructure, Exadata Database Service on Cloud@Customer, and Base Database Service. Support for this attribute will end in November 2023. You may choose to update your custom scripts to exclude the dbWorkload attribute. After November 2023 if you pass a value to the dbWorkload attribute, it will be ignored.
definedTags {[key: string]: string}: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
freeformTags {[key: string]: string}: 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.
keyStoreWalletName string: The wallet name for Oracle Key Vault.
lastBackupDurationInSeconds number: The duration when the latest database backup created.
lastBackupTimestamp string: The date and time when the latest database backup was created.
lastFailedBackupTimestamp string: The date and time when the latest database backup failed.
lifecycleDetails string: Additional information about the current lifecycle state.
ncharacterSet string: The national character set for the database.
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.
compartment_id str: The OCID of the compartment.
connection_strings Sequence[DatabaseConnectionString]: The Connection strings used to connect to the Oracle Database.
data_guard_groups Sequence[DatabaseDataGuardGroup]: Details of Data Guard setup that the given database is part of. Also includes information about databases part of this Data Guard group and properties for their Data Guard configuration.
database_management_configs Sequence[DatabaseDatabaseManagementConfig]: The configuration of the Database Management service.
database_software_image_id str: The database software image OCID
db_backup_configs Sequence[DatabaseDbBackupConfig]: 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 database name.
db_system_id str: The OCID of the DB system.
db_unique_name str: A system-generated name for the database to ensure uniqueness within an Oracle Data Guard group (a primary database and its standby databases). The unique name cannot be changed.
db_workload str: Deprecated. The dbWorkload field has been deprecated for Exadata Database Service on Dedicated Infrastructure, Exadata Database Service on Cloud@Customer, and Base Database Service. Support for this attribute will end in November 2023. You may choose to update your custom scripts to exclude the dbWorkload attribute. After November 2023 if you pass a value to the dbWorkload attribute, it will be ignored.
defined_tags Mapping[str, str]: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
freeform_tags Mapping[str, str]: 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.
key_store_wallet_name str: The wallet name for Oracle Key Vault.
last_backup_duration_in_seconds int: The duration when the latest database backup created.
last_backup_timestamp str: The date and time when the latest database backup was created.
last_failed_backup_timestamp str: The date and time when the latest database backup failed.
lifecycle_details str: Additional information about the current lifecycle state.
ncharacter_set str: The national character set for the database.
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.
compartmentId String: The OCID of the compartment.
connectionStrings List<Property Map>: The Connection strings used to connect to the Oracle Database.
dataGuardGroups List<Property Map>: Details of Data Guard setup that the given database is part of. Also includes information about databases part of this Data Guard group and properties for their Data Guard configuration.
databaseManagementConfigs List<Property Map>: The configuration of the Database Management service.
databaseSoftwareImageId String: The database software image OCID
dbBackupConfigs List<Property Map>: 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 database name.
dbSystemId String: The OCID of the DB system.
dbUniqueName String: A system-generated name for the database to ensure uniqueness within an Oracle Data Guard group (a primary database and its standby databases). The unique name cannot be changed.
dbWorkload String: Deprecated. The dbWorkload field has been deprecated for Exadata Database Service on Dedicated Infrastructure, Exadata Database Service on Cloud@Customer, and Base Database Service. Support for this attribute will end in November 2023. You may choose to update your custom scripts to exclude the dbWorkload attribute. After November 2023 if you pass a value to the dbWorkload attribute, it will be ignored.
definedTags Map<String>: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
freeformTags Map<String>: 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.
keyStoreWalletName String: The wallet name for Oracle Key Vault.
lastBackupDurationInSeconds Number: The duration when the latest database backup created.
lastBackupTimestamp String: The date and time when the latest database backup was created.
lastFailedBackupTimestamp String: The date and time when the latest database backup failed.
lifecycleDetails String: Additional information about the current lifecycle state.
ncharacterSet String: The national character set for the database.
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 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,
        action_trigger: Optional[int] = None,
        character_set: Optional[str] = None,
        compartment_id: Optional[str] = None,
        connection_strings: Optional[Sequence[DatabaseConnectionStringArgs]] = None,
        data_guard_action: Optional[str] = None,
        data_guard_groups: Optional[Sequence[DatabaseDataGuardGroupArgs]] = None,
        database: Optional[DatabaseDatabaseArgs] = None,
        database_management_configs: Optional[Sequence[DatabaseDatabaseManagementConfigArgs]] = None,
        database_software_image_id: Optional[str] = None,
        db_backup_configs: Optional[Sequence[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, str]] = None,
        freeform_tags: Optional[Mapping[str, str]] = None,
        is_cdb: Optional[bool] = None,
        key_store_id: Optional[str] = None,
        key_store_wallet_name: 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,
        last_backup_duration_in_seconds: Optional[int] = None,
        last_backup_timestamp: Optional[str] = None,
        last_failed_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)

resources:  _:    type: oci:Database:Database    get:      id: ${id}

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:

ActionTrigger int

CharacterSet string

The character set for the database.

CompartmentId string

The OCID of the compartment.

ConnectionStrings List<DatabaseConnectionString>

The Connection strings used to connect to the Oracle Database.

DataGuardAction string

Describes the Data Guard operation to be triggered. Could be set to a string value ('Switchover', 'Failover', 'Reinstate', 'DgConfig', "ConvertToStandalone').

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

DataGuardGroups List<DatabaseDataGuardGroup>

Details of Data Guard setup that the given database is part of. Also includes information about databases part of this Data Guard group and properties for their Data Guard configuration.

DatabaseManagementConfigs List<DatabaseDatabaseManagementConfig>

The configuration of the Database Management service.

DatabaseName DatabaseDatabase

(Updatable) Details for creating a database.

Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.

DatabaseSoftwareImageId string

The database software image OCID

DbBackupConfigs List<DatabaseDbBackupConfig>

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 database name.

DbSystemId string

The OCID of the DB system.

DbUniqueName string

A system-generated name for the database to ensure uniqueness within an Oracle Data Guard group (a primary database and its standby databases). The unique name cannot be changed.

DbVersion string

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

DbWorkload string

Deprecated. The dbWorkload field has been deprecated for Exadata Database Service on Dedicated Infrastructure, Exadata Database Service on Cloud@Customer, and Base Database Service. Support for this attribute will end in November 2023. You may choose to update your custom scripts to exclude the dbWorkload attribute. After November 2023 if you pass a value to the dbWorkload attribute, it will be ignored.

DefinedTags Dictionary<string, string>

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

FreeformTags Dictionary<string, string>

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.

KeyStoreId string

The OCID of the key store of Oracle Vault.

KeyStoreWalletName string

The wallet name for Oracle Key Vault.

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

KmsKeyRotation int

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

KmsKeyVersionId string

LastBackupDurationInSeconds int

The duration when the latest database backup created.

LastBackupTimestamp string

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

LastFailedBackupTimestamp string

The date and time when the latest database backup failed.

LifecycleDetails string

Additional information about the current lifecycle state.

NcharacterSet string

The national character set for the database.

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

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. This parameter and secretId are required for Customer Managed Keys.

VmClusterId string

The OCID of the VM cluster.

ActionTrigger int

CharacterSet string

The character set for the database.

CompartmentId string

The OCID of the compartment.

ConnectionStrings []DatabaseConnectionStringArgs

The Connection strings used to connect to the Oracle Database.

DataGuardAction string

Describes the Data Guard operation to be triggered. Could be set to a string value ('Switchover', 'Failover', 'Reinstate', 'DgConfig', "ConvertToStandalone').

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

DataGuardGroups []DatabaseDataGuardGroupArgs

Details of Data Guard setup that the given database is part of. Also includes information about databases part of this Data Guard group and properties for their Data Guard configuration.

Database DatabaseDatabaseArgs

(Updatable) Details for creating a database.

Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.

DatabaseManagementConfigs []DatabaseDatabaseManagementConfigArgs

The configuration of the Database Management service.

DatabaseSoftwareImageId string

The database software image OCID

DbBackupConfigs []DatabaseDbBackupConfigArgs

DbHomeId string

The OCID of the Database Home.

DbName string

The database name.

DbSystemId string

The OCID of the DB system.

DbUniqueName string

A system-generated name for the database to ensure uniqueness within an Oracle Data Guard group (a primary database and its standby databases). The unique name cannot be changed.

DbVersion string

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

DbWorkload string

DefinedTags map[string]string

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

FreeformTags map[string]string

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.

KeyStoreId string

The OCID of the key store of Oracle Vault.

KeyStoreWalletName string

The wallet name for Oracle Key Vault.

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

KmsKeyRotation int

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

KmsKeyVersionId string

LastBackupDurationInSeconds int

The duration when the latest database backup created.

LastBackupTimestamp string

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

LastFailedBackupTimestamp string

The date and time when the latest database backup failed.

LifecycleDetails string

Additional information about the current lifecycle state.

NcharacterSet string

The national character set for the database.

PdbName string

SidPrefix string

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

Source string

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. This parameter and secretId are required for Customer Managed Keys.

VmClusterId string

The OCID of the VM cluster.

actionTrigger Integer

characterSet String

The character set for the database.

compartmentId String

The OCID of the compartment.

connectionStrings List<ConnectionString>

The Connection strings used to connect to the Oracle Database.

dataGuardAction String

Describes the Data Guard operation to be triggered. Could be set to a string value ('Switchover', 'Failover', 'Reinstate', 'DgConfig', "ConvertToStandalone').

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

dataGuardGroups List<DataGuardGroup>

Details of Data Guard setup that the given database is part of. Also includes information about databases part of this Data Guard group and properties for their Data Guard configuration.

database DatabaseDatabaseArgs

(Updatable) Details for creating a database.

Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.

databaseManagementConfigs List<ManagementConfig>

The configuration of the Database Management service.

databaseSoftwareImageId String

The database software image OCID

dbBackupConfigs List<DbBackupConfig>

dbHomeId String

The OCID of the Database Home.

dbName String

The database name.

dbSystemId String

The OCID of the DB system.

dbUniqueName String

A system-generated name for the database to ensure uniqueness within an Oracle Data Guard group (a primary database and its standby databases). The unique name cannot be changed.

dbVersion String

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

dbWorkload String

definedTags Map<String,String>

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

freeformTags Map<String,String>

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.

keyStoreId String

The OCID of the key store of Oracle Vault.

keyStoreWalletName String

The wallet name for Oracle Key Vault.

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

kmsKeyRotation Integer

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

kmsKeyVersionId String

lastBackupDurationInSeconds Integer

The duration when the latest database backup created.

lastBackupTimestamp String

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

lastFailedBackupTimestamp String

The date and time when the latest database backup failed.

lifecycleDetails String

Additional information about the current lifecycle state.

ncharacterSet String

The national character set for the database.

pdbName String

sidPrefix String

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

source String

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. This parameter and secretId are required for Customer Managed Keys.

vmClusterId String

The OCID of the VM cluster.

actionTrigger number

characterSet string

The character set for the database.

compartmentId string

The OCID of the compartment.

connectionStrings DatabaseConnectionString[]

The Connection strings used to connect to the Oracle Database.

dataGuardAction string

Describes the Data Guard operation to be triggered. Could be set to a string value ('Switchover', 'Failover', 'Reinstate', 'DgConfig', "ConvertToStandalone').

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

dataGuardGroups DatabaseDataGuardGroup[]

Details of Data Guard setup that the given database is part of. Also includes information about databases part of this Data Guard group and properties for their Data Guard configuration.

database DatabaseDatabase

(Updatable) Details for creating a database.

Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.

databaseManagementConfigs DatabaseDatabaseManagementConfig[]

The configuration of the Database Management service.

databaseSoftwareImageId string

The database software image OCID

dbBackupConfigs DatabaseDbBackupConfig[]

dbHomeId string

The OCID of the Database Home.

dbName string

The database name.

dbSystemId string

The OCID of the DB system.

dbUniqueName string

A system-generated name for the database to ensure uniqueness within an Oracle Data Guard group (a primary database and its standby databases). The unique name cannot be changed.

dbVersion string

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

dbWorkload string

definedTags {[key: string]: string}

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

freeformTags {[key: string]: string}

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.

keyStoreId string

The OCID of the key store of Oracle Vault.

keyStoreWalletName string

The wallet name for Oracle Key Vault.

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

kmsKeyRotation number

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

kmsKeyVersionId string

lastBackupDurationInSeconds number

The duration when the latest database backup created.

lastBackupTimestamp string

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

lastFailedBackupTimestamp string

The date and time when the latest database backup failed.

lifecycleDetails string

Additional information about the current lifecycle state.

ncharacterSet string

The national character set for the database.

pdbName string

sidPrefix string

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

source string

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. This parameter and secretId are required for Customer Managed Keys.

vmClusterId string

The OCID of the VM cluster.

action_trigger int

character_set str

The character set for the database.

compartment_id str

The OCID of the compartment.

connection_strings Sequence[DatabaseConnectionStringArgs]

The Connection strings used to connect to the Oracle Database.

data_guard_action str

Describes the Data Guard operation to be triggered. Could be set to a string value ('Switchover', 'Failover', 'Reinstate', 'DgConfig', "ConvertToStandalone').

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

data_guard_groups Sequence[DatabaseDataGuardGroupArgs]

Details of Data Guard setup that the given database is part of. Also includes information about databases part of this Data Guard group and properties for their Data Guard configuration.

database DatabaseDatabaseArgs

(Updatable) Details for creating a database.

Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.

database_management_configs Sequence[DatabaseDatabaseManagementConfigArgs]

The configuration of the Database Management service.

database_software_image_id str

The database software image OCID

db_backup_configs Sequence[DatabaseDbBackupConfigArgs]

db_home_id str

The OCID of the Database Home.

db_name str

The database name.

db_system_id str

The OCID of the DB system.

db_unique_name str

A system-generated name for the database to ensure uniqueness within an Oracle Data Guard group (a primary database and its standby databases). The unique name cannot be changed.

db_version str

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

db_workload str

defined_tags Mapping[str, str]

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

freeform_tags Mapping[str, str]

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.

key_store_id str

The OCID of the key store of Oracle Vault.

key_store_wallet_name str

The wallet name for Oracle Key Vault.

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

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

last_backup_duration_in_seconds int

The duration when the latest database backup created.

last_backup_timestamp str

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

last_failed_backup_timestamp str

The date and time when the latest database backup failed.

lifecycle_details str

Additional information about the current lifecycle state.

ncharacter_set str

The national character set for the database.

pdb_name str

sid_prefix str

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

source str

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. This parameter and secretId are required for Customer Managed Keys.

vm_cluster_id str

The OCID of the VM cluster.

actionTrigger Number

characterSet String

The character set for the database.

compartmentId String

The OCID of the compartment.

connectionStrings List<Property Map>

The Connection strings used to connect to the Oracle Database.

dataGuardAction String

Describes the Data Guard operation to be triggered. Could be set to a string value ('Switchover', 'Failover', 'Reinstate', 'DgConfig', "ConvertToStandalone').

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

dataGuardGroups List<Property Map>

Details of Data Guard setup that the given database is part of. Also includes information about databases part of this Data Guard group and properties for their Data Guard configuration.

database Property Map

(Updatable) Details for creating a database.

Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.

databaseManagementConfigs List<Property Map>

The configuration of the Database Management service.

databaseSoftwareImageId String

The database software image OCID

dbBackupConfigs List<Property Map>

dbHomeId String

The OCID of the Database Home.

dbName String

The database name.

dbSystemId String

The OCID of the DB system.

dbUniqueName String

A system-generated name for the database to ensure uniqueness within an Oracle Data Guard group (a primary database and its standby databases). The unique name cannot be changed.

dbVersion String

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

dbWorkload String

definedTags Map<String>

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

freeformTags Map<String>

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.

keyStoreId String

The OCID of the key store of Oracle Vault.

keyStoreWalletName String

The wallet name for Oracle Key Vault.

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

kmsKeyRotation Number

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

kmsKeyVersionId String

lastBackupDurationInSeconds Number

The duration when the latest database backup created.

lastBackupTimestamp String

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

lastFailedBackupTimestamp String

The date and time when the latest database backup failed.

lifecycleDetails String

Additional information about the current lifecycle state.

ncharacterSet String

The national character set for the database.

pdbName String

sidPrefix String

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

source String

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. This parameter and secretId are required for Customer Managed Keys.

vmClusterId String

The OCID of the VM cluster.

Supporting Types

DatabaseConnectionString, DatabaseConnectionStringArgs

AllConnectionStrings Dictionary<string, string>: 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]string: 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,String>: 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]: string}: 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, str]: 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<String>: 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.

DatabaseDataGuardGroup, DatabaseDataGuardGroupArgs

Members List<DatabaseDataGuardGroupMember>: List of Data Guard members, representing each database that is part of Data Guard.
ProtectionMode string: The protection mode of this Data Guard. For more information, see Oracle Data Guard Protection Modes in the Oracle Data Guard documentation.

Members []DatabaseDataGuardGroupMember: List of Data Guard members, representing each database that is part of Data Guard.
ProtectionMode string: The protection mode of this Data Guard. For more information, see Oracle Data Guard Protection Modes in the Oracle Data Guard documentation.

members List<DataGuardGroupMember>: List of Data Guard members, representing each database that is part of Data Guard.
protectionMode String: The protection mode of this Data Guard. For more information, see Oracle Data Guard Protection Modes in the Oracle Data Guard documentation.

members DatabaseDataGuardGroupMember[]: List of Data Guard members, representing each database that is part of Data Guard.
protectionMode string: The protection mode of this Data Guard. For more information, see Oracle Data Guard Protection Modes in the Oracle Data Guard documentation.

members Sequence[DatabaseDataGuardGroupMember]: List of Data Guard members, representing each database that is part of Data Guard.
protection_mode str: The protection mode of this Data Guard. For more information, see Oracle Data Guard Protection Modes in the Oracle Data Guard documentation.

members List<Property Map>: List of Data Guard members, representing each database that is part of Data Guard.
protectionMode String: The protection mode of this Data Guard. For more information, see Oracle Data Guard Protection Modes in the Oracle Data Guard documentation.

DatabaseDataGuardGroupMember, DatabaseDataGuardGroupMemberArgs

ApplyLag string

The lag time between updates to the primary database and application of the redo data on the standby database, as computed by the reporting database. Example: 1 second

ApplyRate string

The rate at which redo logs are synced between the associated databases. Example: 102.96 MByte/s

DatabaseId string

The OCID of the Database.

DbSystemId string

The OCID of the DB system.

IsActiveDataGuardEnabled bool

True if active Data Guard is enabled.

Role string

The role of the reporting database in this Data Guard association.

TransportLag string

The rate at which redo logs are transported between the associated databases. Example: 1 second

TransportLagRefresh string

The date and time when last redo transport has been done.

TransportType string

The redo transport type to use for this Data Guard association. Valid values depend on the specified protectionMode:

MAXIMUM_AVAILABILITY - SYNC or FASTSYNC
MAXIMUM_PERFORMANCE - ASYNC
MAXIMUM_PROTECTION - SYNC

ApplyLag string

The lag time between updates to the primary database and application of the redo data on the standby database, as computed by the reporting database. Example: 1 second

ApplyRate string

The rate at which redo logs are synced between the associated databases. Example: 102.96 MByte/s

DatabaseId string

The OCID of the Database.

DbSystemId string

The OCID of the DB system.

IsActiveDataGuardEnabled bool

True if active Data Guard is enabled.

Role string

The role of the reporting database in this Data Guard association.

TransportLag string

The rate at which redo logs are transported between the associated databases. Example: 1 second

TransportLagRefresh string

The date and time when last redo transport has been done.

TransportType string

The redo transport type to use for this Data Guard association. Valid values depend on the specified protectionMode:

MAXIMUM_AVAILABILITY - SYNC or FASTSYNC
MAXIMUM_PERFORMANCE - ASYNC
MAXIMUM_PROTECTION - SYNC

applyLag String

The lag time between updates to the primary database and application of the redo data on the standby database, as computed by the reporting database. Example: 1 second

applyRate String

The rate at which redo logs are synced between the associated databases. Example: 102.96 MByte/s

databaseId String

The OCID of the Database.

dbSystemId String

The OCID of the DB system.

isActiveDataGuardEnabled Boolean

True if active Data Guard is enabled.

role String

The role of the reporting database in this Data Guard association.

transportLag String

The rate at which redo logs are transported between the associated databases. Example: 1 second

transportLagRefresh String

The date and time when last redo transport has been done.

transportType String

The redo transport type to use for this Data Guard association. Valid values depend on the specified protectionMode:

MAXIMUM_AVAILABILITY - SYNC or FASTSYNC
MAXIMUM_PERFORMANCE - ASYNC
MAXIMUM_PROTECTION - SYNC

applyLag string

The lag time between updates to the primary database and application of the redo data on the standby database, as computed by the reporting database. Example: 1 second

applyRate string

The rate at which redo logs are synced between the associated databases. Example: 102.96 MByte/s

databaseId string

The OCID of the Database.

dbSystemId string

The OCID of the DB system.

isActiveDataGuardEnabled boolean

True if active Data Guard is enabled.

role string

The role of the reporting database in this Data Guard association.

transportLag string

The rate at which redo logs are transported between the associated databases. Example: 1 second

transportLagRefresh string

The date and time when last redo transport has been done.

transportType string

The redo transport type to use for this Data Guard association. Valid values depend on the specified protectionMode:

MAXIMUM_AVAILABILITY - SYNC or FASTSYNC
MAXIMUM_PERFORMANCE - ASYNC
MAXIMUM_PROTECTION - SYNC

apply_lag str

The lag time between updates to the primary database and application of the redo data on the standby database, as computed by the reporting database. Example: 1 second

apply_rate str

The rate at which redo logs are synced between the associated databases. Example: 102.96 MByte/s

database_id str

The OCID of the Database.

db_system_id str

The OCID of the DB system.

is_active_data_guard_enabled bool

True if active Data Guard is enabled.

role str

The role of the reporting database in this Data Guard association.

transport_lag str

The rate at which redo logs are transported between the associated databases. Example: 1 second

transport_lag_refresh str

The date and time when last redo transport has been done.

transport_type str

The redo transport type to use for this Data Guard association. Valid values depend on the specified protectionMode:

MAXIMUM_AVAILABILITY - SYNC or FASTSYNC
MAXIMUM_PERFORMANCE - ASYNC
MAXIMUM_PROTECTION - SYNC

applyLag String

The lag time between updates to the primary database and application of the redo data on the standby database, as computed by the reporting database. Example: 1 second

applyRate String

The rate at which redo logs are synced between the associated databases. Example: 102.96 MByte/s

databaseId String

The OCID of the Database.

dbSystemId String

The OCID of the DB system.

isActiveDataGuardEnabled Boolean

True if active Data Guard is enabled.

role String

The role of the reporting database in this Data Guard association.

transportLag String

The rate at which redo logs are transported between the associated databases. Example: 1 second

transportLagRefresh String

The date and time when last redo transport has been done.

transportType String

The redo transport type to use for this Data Guard association. Valid values depend on the specified protectionMode:

MAXIMUM_AVAILABILITY - SYNC or FASTSYNC
MAXIMUM_PERFORMANCE - ASYNC
MAXIMUM_PROTECTION - SYNC

DatabaseDatabase, DatabaseDatabaseArgs

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 -.

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:

AL32UTF8, AR8ADOS710, AR8ADOS720, AR8APTEC715, AR8ARABICMACS, AR8ASMO8X, AR8ISO8859P6, AR8MSWIN1256, AR8MUSSAD768, AR8NAFITHA711, AR8NAFITHA721, AR8SAKHR706, AR8SAKHR707, AZ8ISO8859P9E, BG8MSWIN, BG8PC437S, BLT8CP921, BLT8ISO8859P13, BLT8MSWIN1257, BLT8PC775, BN8BSCII, CDN8PC863, CEL8ISO8859P14, CL8ISO8859P5, CL8ISOIR111, CL8KOI8R, CL8KOI8U, CL8MACCYRILLICS, CL8MSWIN1251, EE8ISO8859P2, EE8MACCES, EE8MACCROATIANS, EE8MSWIN1250, EE8PC852, EL8DEC, EL8ISO8859P7, EL8MACGREEKS, EL8MSWIN1253, EL8PC437S, EL8PC851, EL8PC869, ET8MSWIN923, HU8ABMOD, HU8CWI2, IN8ISCII, IS8PC861, IW8ISO8859P8, IW8MACHEBREWS, IW8MSWIN1255, IW8PC1507, JA16EUC, JA16EUCTILDE, JA16SJIS, JA16SJISTILDE, JA16VMS, KO16KSC5601, KO16KSCCS, KO16MSWIN949, LA8ISO6937, LA8PASSPORT, LT8MSWIN921, LT8PC772, LT8PC774, LV8PC1117, LV8PC8LR, LV8RST104090, N8PC865, NE8ISO8859P10, NEE8ISO8859P4, RU8BESTA, RU8PC855, RU8PC866, SE8ISO8859P3, TH8MACTHAIS, TH8TISASCII, TR8DEC, TR8MACTURKISHS, TR8MSWIN1254, TR8PC857, US7ASCII, US8PC437, UTF8, VN8MSWIN1258, VN8VN3, WE8DEC, WE8DG, WE8ISO8859P1, WE8ISO8859P15, WE8ISO8859P9, WE8MACROMAN8S, WE8MSWIN1252, WE8NCR4970, WE8NEXTSTEP, WE8PC850, WE8PC858, WE8PC860, WE8ROMAN8, ZHS16CGB231280, ZHS16GBK, ZHT16BIG5, ZHT16CCDC, ZHT16DBT, ZHT16HKSCS, ZHT16MSWIN950, ZHT32EUC, ZHT32SOPS, ZHT32TRIS

DatabaseAdminPassword string

The administrator password of the primary database in this Data Guard association.

The password MUST be the same as the primary admin password.

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.

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.

DbUniqueName string

Specifies the DB_UNIQUE_NAME of the peer database to be created.

DbWorkload string

The database workload type.

DefinedTags Dictionary<string, string>

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

EncryptionKeyLocationDetails DatabaseDatabaseEncryptionKeyLocationDetails

Types of providers supported for managing database encryption keys

FreeformTags Dictionary<string, string>

(Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

IsActiveDataGuardEnabled bool

True if active Data Guard is enabled.

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. Autonomous Database Serverless does not use key versions, hence is not applicable for Autonomous Database Serverless instances.

NcharacterSet string

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

PdbName string

PluggableDatabases List<string>

The list of pluggable databases that needs to be restored into new database.

ProtectionMode string

The protection mode of this Data Guard. For more information, see Oracle Data Guard Protection Modes in the Oracle Data Guard documentation.

SidPrefix string

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

SourceDatabaseId string

The OCID of the source database.

SourceEncryptionKeyLocationDetails DatabaseDatabaseSourceEncryptionKeyLocationDetails

Types of providers supported for managing database encryption keys

SourceTdeWalletPassword string

The TDE wallet password of the source database specified by 'sourceDatabaseId'.

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 -.

TransportType string

The redo transport type to use for this Data Guard association. Valid values depend on the specified protectionMode:

MAXIMUM_AVAILABILITY - SYNC or FASTSYNC
MAXIMUM_PERFORMANCE - ASYNC
MAXIMUM_PROTECTION - SYNC

For more information, see Redo Transport Services in the Oracle Data Guard documentation.

IMPORTANT - The only transport type currently supported by the Database service is ASYNC.

VaultId string

The OCID of the Oracle Cloud Infrastructure vault. This parameter and secretId are required for Customer Managed Keys.

AdminPassword string

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:

DatabaseAdminPassword string

The administrator password of the primary database in this Data Guard association.

The password MUST be the same as the primary admin password.

DatabaseSoftwareImageId string

The database software image OCID

DbBackupConfig DatabaseDatabaseDbBackupConfig

DbName string

DbUniqueName string

Specifies the DB_UNIQUE_NAME of the peer database to be created.

DbWorkload string

The database workload type.

DefinedTags map[string]string

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

EncryptionKeyLocationDetails DatabaseDatabaseEncryptionKeyLocationDetails

Types of providers supported for managing database encryption keys

FreeformTags map[string]string

IsActiveDataGuardEnabled bool

True if active Data Guard is enabled.

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

NcharacterSet string

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

PdbName string

PluggableDatabases []string

The list of pluggable databases that needs to be restored into new database.

ProtectionMode string

The protection mode of this Data Guard. For more information, see Oracle Data Guard Protection Modes in the Oracle Data Guard documentation.

SidPrefix string

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

SourceDatabaseId string

The OCID of the source database.

SourceEncryptionKeyLocationDetails DatabaseDatabaseSourceEncryptionKeyLocationDetails

Types of providers supported for managing database encryption keys

SourceTdeWalletPassword string

The TDE wallet password of the source database specified by 'sourceDatabaseId'.

TdeWalletPassword string

TransportType string

The redo transport type to use for this Data Guard association. Valid values depend on the specified protectionMode:

MAXIMUM_AVAILABILITY - SYNC or FASTSYNC
MAXIMUM_PERFORMANCE - ASYNC
MAXIMUM_PROTECTION - SYNC

For more information, see Redo Transport Services in the Oracle Data Guard documentation.

IMPORTANT - The only transport type currently supported by the Database service is ASYNC.

VaultId string

The OCID of the Oracle Cloud Infrastructure vault. This parameter and secretId are required for Customer Managed Keys.

adminPassword String

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:

databaseAdminPassword String

The administrator password of the primary database in this Data Guard association.

The password MUST be the same as the primary admin password.

databaseSoftwareImageId String

The database software image OCID

dbBackupConfig DbBackupConfig

dbName String

dbUniqueName String

Specifies the DB_UNIQUE_NAME of the peer database to be created.

dbWorkload String

The database workload type.

definedTags Map<String,String>

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

encryptionKeyLocationDetails EncryptionKeyLocationDetails

Types of providers supported for managing database encryption keys

freeformTags Map<String,String>

isActiveDataGuardEnabled Boolean

True if active Data Guard is enabled.

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

ncharacterSet String

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

pdbName String

pluggableDatabases List<String>

The list of pluggable databases that needs to be restored into new database.

protectionMode String

The protection mode of this Data Guard. For more information, see Oracle Data Guard Protection Modes in the Oracle Data Guard documentation.

sidPrefix String

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

sourceDatabaseId String

The OCID of the source database.

sourceEncryptionKeyLocationDetails SourceEncryptionKeyLocationDetails

Types of providers supported for managing database encryption keys

sourceTdeWalletPassword String

The TDE wallet password of the source database specified by 'sourceDatabaseId'.

tdeWalletPassword String

transportType String

The redo transport type to use for this Data Guard association. Valid values depend on the specified protectionMode:

MAXIMUM_AVAILABILITY - SYNC or FASTSYNC
MAXIMUM_PERFORMANCE - ASYNC
MAXIMUM_PROTECTION - SYNC

For more information, see Redo Transport Services in the Oracle Data Guard documentation.

IMPORTANT - The only transport type currently supported by the Database service is ASYNC.

vaultId String

The OCID of the Oracle Cloud Infrastructure vault. This parameter and secretId are required for Customer Managed Keys.

adminPassword string

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:

databaseAdminPassword string

The administrator password of the primary database in this Data Guard association.

The password MUST be the same as the primary admin password.

databaseSoftwareImageId string

The database software image OCID

dbBackupConfig DatabaseDatabaseDbBackupConfig

dbName string

dbUniqueName string

Specifies the DB_UNIQUE_NAME of the peer database to be created.

dbWorkload string

The database workload type.

definedTags {[key: string]: string}

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

encryptionKeyLocationDetails DatabaseDatabaseEncryptionKeyLocationDetails

Types of providers supported for managing database encryption keys

freeformTags {[key: string]: string}

isActiveDataGuardEnabled boolean

True if active Data Guard is enabled.

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

ncharacterSet string

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

pdbName string

pluggableDatabases string[]

The list of pluggable databases that needs to be restored into new database.

protectionMode string

The protection mode of this Data Guard. For more information, see Oracle Data Guard Protection Modes in the Oracle Data Guard documentation.

sidPrefix string

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

sourceDatabaseId string

The OCID of the source database.

sourceEncryptionKeyLocationDetails DatabaseDatabaseSourceEncryptionKeyLocationDetails

Types of providers supported for managing database encryption keys

sourceTdeWalletPassword string

The TDE wallet password of the source database specified by 'sourceDatabaseId'.

tdeWalletPassword string

transportType string

The redo transport type to use for this Data Guard association. Valid values depend on the specified protectionMode:

MAXIMUM_AVAILABILITY - SYNC or FASTSYNC
MAXIMUM_PERFORMANCE - ASYNC
MAXIMUM_PROTECTION - SYNC

For more information, see Redo Transport Services in the Oracle Data Guard documentation.

IMPORTANT - The only transport type currently supported by the Database service is ASYNC.

vaultId string

The OCID of the Oracle Cloud Infrastructure vault. This parameter and secretId are required for Customer Managed Keys.

admin_password str

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_admin_password str

The administrator password of the primary database in this Data Guard association.

The password MUST be the same as the primary admin password.

database_software_image_id str

The database software image OCID

db_backup_config DatabaseDatabaseDbBackupConfig

db_name str

db_unique_name str

Specifies the DB_UNIQUE_NAME of the peer database to be created.

db_workload str

The database workload type.

defined_tags Mapping[str, str]

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

encryption_key_location_details DatabaseDatabaseEncryptionKeyLocationDetails

Types of providers supported for managing database encryption keys

freeform_tags Mapping[str, str]

is_active_data_guard_enabled bool

True if active Data Guard is enabled.

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

ncharacter_set str

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

pdb_name str

pluggable_databases Sequence[str]

The list of pluggable databases that needs to be restored into new database.

protection_mode str

The protection mode of this Data Guard. For more information, see Oracle Data Guard Protection Modes in the Oracle Data Guard documentation.

sid_prefix str

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

source_database_id str

The OCID of the source database.

source_encryption_key_location_details DatabaseDatabaseSourceEncryptionKeyLocationDetails

Types of providers supported for managing database encryption keys

source_tde_wallet_password str

The TDE wallet password of the source database specified by 'sourceDatabaseId'.

tde_wallet_password str

transport_type str

The redo transport type to use for this Data Guard association. Valid values depend on the specified protectionMode:

MAXIMUM_AVAILABILITY - SYNC or FASTSYNC
MAXIMUM_PERFORMANCE - ASYNC
MAXIMUM_PROTECTION - SYNC

For more information, see Redo Transport Services in the Oracle Data Guard documentation.

IMPORTANT - The only transport type currently supported by the Database service is ASYNC.

vault_id str

The OCID of the Oracle Cloud Infrastructure vault. This parameter and secretId are required for Customer Managed Keys.

adminPassword String

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:

databaseAdminPassword String

The administrator password of the primary database in this Data Guard association.

The password MUST be the same as the primary admin password.

databaseSoftwareImageId String

The database software image OCID

dbBackupConfig Property Map

dbName String

dbUniqueName String

Specifies the DB_UNIQUE_NAME of the peer database to be created.

dbWorkload String

The database workload type.

definedTags Map<String>

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

encryptionKeyLocationDetails Property Map

Types of providers supported for managing database encryption keys

freeformTags Map<String>

isActiveDataGuardEnabled Boolean

True if active Data Guard is enabled.

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

ncharacterSet String

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

pdbName String

pluggableDatabases List<String>

The list of pluggable databases that needs to be restored into new database.

protectionMode String

The protection mode of this Data Guard. For more information, see Oracle Data Guard Protection Modes in the Oracle Data Guard documentation.

sidPrefix String

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

sourceDatabaseId String

The OCID of the source database.

sourceEncryptionKeyLocationDetails Property Map

Types of providers supported for managing database encryption keys

sourceTdeWalletPassword String

The TDE wallet password of the source database specified by 'sourceDatabaseId'.

tdeWalletPassword String

transportType String

The redo transport type to use for this Data Guard association. Valid values depend on the specified protectionMode:

MAXIMUM_AVAILABILITY - SYNC or FASTSYNC
MAXIMUM_PERFORMANCE - ASYNC
MAXIMUM_PROTECTION - SYNC

For more information, see Redo Transport Services in the Oracle Data Guard documentation.

IMPORTANT - The only transport type currently supported by the Database service is ASYNC.

vaultId String

The OCID of the Oracle Cloud Infrastructure vault. This parameter and secretId are required for Customer Managed Keys.

DatabaseDatabaseDbBackupConfig, DatabaseDatabaseDbBackupConfigArgs

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
AutoFullBackupDay string: Day of the week the full backup should be applied on the database system. If no option is selected, the value is null and we will default to Sunday.
AutoFullBackupWindow string: Time window selected for initiating full backup for the database system. There are twelve available two-hour time windows. If no option is selected, the value is null and 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
BackupDeletionPolicy string: This defines when the backups will be deleted. - IMMEDIATE option keep the backup for predefined time i.e 72 hours and then delete permanently... - RETAIN will keep the backups as per the policy defined for database backups.
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.
RunImmediateFullBackup bool: If set to true, configures automatic full backups in the local region (the region of the DB system) for the first backup run immediately.

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
AutoFullBackupDay string: Day of the week the full backup should be applied on the database system. If no option is selected, the value is null and we will default to Sunday.
AutoFullBackupWindow string: Time window selected for initiating full backup for the database system. There are twelve available two-hour time windows. If no option is selected, the value is null and 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
BackupDeletionPolicy string: This defines when the backups will be deleted. - IMMEDIATE option keep the backup for predefined time i.e 72 hours and then delete permanently... - RETAIN will keep the backups as per the policy defined for database backups.
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.
RunImmediateFullBackup bool: If set to true, configures automatic full backups in the local region (the region of the DB system) for the first backup run immediately.

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
autoFullBackupDay String: Day of the week the full backup should be applied on the database system. If no option is selected, the value is null and we will default to Sunday.
autoFullBackupWindow String: Time window selected for initiating full backup for the database system. There are twelve available two-hour time windows. If no option is selected, the value is null and 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
backupDeletionPolicy String: This defines when the backups will be deleted. - IMMEDIATE option keep the backup for predefined time i.e 72 hours and then delete permanently... - RETAIN will keep the backups as per the policy defined for database backups.
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.
runImmediateFullBackup Boolean: If set to true, configures automatic full backups in the local region (the region of the DB system) for the first backup run immediately.

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
autoFullBackupDay string: Day of the week the full backup should be applied on the database system. If no option is selected, the value is null and we will default to Sunday.
autoFullBackupWindow string: Time window selected for initiating full backup for the database system. There are twelve available two-hour time windows. If no option is selected, the value is null and 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
backupDeletionPolicy string: This defines when the backups will be deleted. - IMMEDIATE option keep the backup for predefined time i.e 72 hours and then delete permanently... - RETAIN will keep the backups as per the policy defined for database backups.
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.
runImmediateFullBackup boolean: If set to true, configures automatic full backups in the local region (the region of the DB system) for the first backup run immediately.

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
auto_full_backup_day str: Day of the week the full backup should be applied on the database system. If no option is selected, the value is null and we will default to Sunday.
auto_full_backup_window str: Time window selected for initiating full backup for the database system. There are twelve available two-hour time windows. If no option is selected, the value is null and 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_deletion_policy str: This defines when the backups will be deleted. - IMMEDIATE option keep the backup for predefined time i.e 72 hours and then delete permanently... - RETAIN will keep the backups as per the policy defined for database backups.
backup_destination_details Sequence[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.
run_immediate_full_backup bool: If set to true, configures automatic full backups in the local region (the region of the DB system) for the first backup run immediately.

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
autoFullBackupDay String: Day of the week the full backup should be applied on the database system. If no option is selected, the value is null and we will default to Sunday.
autoFullBackupWindow String: Time window selected for initiating full backup for the database system. There are twelve available two-hour time windows. If no option is selected, the value is null and 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
backupDeletionPolicy String: This defines when the backups will be deleted. - IMMEDIATE option keep the backup for predefined time i.e 72 hours and then delete permanently... - RETAIN will keep the backups as per the policy defined for database backups.
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.
runImmediateFullBackup Boolean: If set to true, configures automatic full backups in the local region (the region of the DB system) for the first backup run immediately.

DatabaseDatabaseDbBackupConfigBackupDestinationDetail, DatabaseDatabaseDbBackupConfigBackupDestinationDetailArgs

DbrsPolicyId string: The OCID of the DBRS policy used for backup.
Id string: The OCID of the backup destination.
Type string: Type of the database backup destination.
VpcUser string

DbrsPolicyId string: The OCID of the DBRS policy used for backup.
Id string: The OCID of the backup destination.
Type string: Type of the database backup destination.
VpcUser string

dbrsPolicyId String: The OCID of the DBRS policy used for backup.
id String: The OCID of the backup destination.
type String: Type of the database backup destination.
vpcUser String

dbrsPolicyId string: The OCID of the DBRS policy used for backup.
id string: The OCID of the backup destination.
type string: Type of the database backup destination.
vpcUser string

dbrs_policy_id str: The OCID of the DBRS policy used for backup.
id str: The OCID of the backup destination.
type str: Type of the database backup destination.
vpc_user str

dbrsPolicyId String: The OCID of the DBRS policy used for backup.
id String: The OCID of the backup destination.
type String: Type of the database backup destination.
vpcUser String

DatabaseDatabaseEncryptionKeyLocationDetails, DatabaseDatabaseEncryptionKeyLocationDetailsArgs

HsmPassword string: Provide the HSM password as you would in RDBMS for External HSM.
ProviderType string: Use 'EXTERNAL' for creating a new database or migrate database key with External HSM.

HsmPassword string: Provide the HSM password as you would in RDBMS for External HSM.
ProviderType string: Use 'EXTERNAL' for creating a new database or migrate database key with External HSM.

hsmPassword String: Provide the HSM password as you would in RDBMS for External HSM.
providerType String: Use 'EXTERNAL' for creating a new database or migrate database key with External HSM.

hsmPassword string: Provide the HSM password as you would in RDBMS for External HSM.
providerType string: Use 'EXTERNAL' for creating a new database or migrate database key with External HSM.

hsm_password str: Provide the HSM password as you would in RDBMS for External HSM.
provider_type str: Use 'EXTERNAL' for creating a new database or migrate database key with External HSM.

hsmPassword String: Provide the HSM password as you would in RDBMS for External HSM.
providerType String: Use 'EXTERNAL' for creating a new database or migrate database key with External HSM.

DatabaseDatabaseManagementConfig, DatabaseDatabaseManagementConfigArgs

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.

DatabaseDatabaseSourceEncryptionKeyLocationDetails, DatabaseDatabaseSourceEncryptionKeyLocationDetailsArgs

HsmPassword string: Provide the HSM password as you would in RDBMS for External HSM.
ProviderType string: Use 'EXTERNAL' for creating a new database or migrate database key with External HSM.

HsmPassword string: Provide the HSM password as you would in RDBMS for External HSM.
ProviderType string: Use 'EXTERNAL' for creating a new database or migrate database key with External HSM.

hsmPassword String: Provide the HSM password as you would in RDBMS for External HSM.
providerType String: Use 'EXTERNAL' for creating a new database or migrate database key with External HSM.

hsmPassword string: Provide the HSM password as you would in RDBMS for External HSM.
providerType string: Use 'EXTERNAL' for creating a new database or migrate database key with External HSM.

hsm_password str: Provide the HSM password as you would in RDBMS for External HSM.
provider_type str: Use 'EXTERNAL' for creating a new database or migrate database key with External HSM.

hsmPassword String: Provide the HSM password as you would in RDBMS for External HSM.
providerType String: Use 'EXTERNAL' for creating a new database or migrate database key with External HSM.

DatabaseDbBackupConfig, DatabaseDbBackupConfigArgs

AutoBackupEnabled bool: 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: 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
AutoFullBackupDay string: Day of the week the full backup should be applied on the database system. If no option is selected, the value is null and we will default to Sunday.
AutoFullBackupWindow string: Time window selected for initiating full backup for the database system. There are twelve available two-hour time windows. If no option is selected, the value is null and 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
BackupDeletionPolicy string: This defines when the backups will be deleted. - IMMEDIATE option keep the backup for predefined time i.e 72 hours and then delete permanently... - RETAIN will keep the backups as per the policy defined for database backups.
BackupDestinationDetails List<DatabaseDbBackupConfigBackupDestinationDetail>: Backup destination details.
RecoveryWindowInDays int: 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.
RunImmediateFullBackup bool: If set to true, configures automatic full backups in the local region (the region of the DB system) for the first backup run immediately.

AutoBackupEnabled bool: 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: 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
AutoFullBackupDay string: Day of the week the full backup should be applied on the database system. If no option is selected, the value is null and we will default to Sunday.
AutoFullBackupWindow string: Time window selected for initiating full backup for the database system. There are twelve available two-hour time windows. If no option is selected, the value is null and 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
BackupDeletionPolicy string: This defines when the backups will be deleted. - IMMEDIATE option keep the backup for predefined time i.e 72 hours and then delete permanently... - RETAIN will keep the backups as per the policy defined for database backups.
BackupDestinationDetails []DatabaseDbBackupConfigBackupDestinationDetail: Backup destination details.
RecoveryWindowInDays int: 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.
RunImmediateFullBackup bool: If set to true, configures automatic full backups in the local region (the region of the DB system) for the first backup run immediately.

autoBackupEnabled Boolean: 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: 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
autoFullBackupDay String: Day of the week the full backup should be applied on the database system. If no option is selected, the value is null and we will default to Sunday.
autoFullBackupWindow String: Time window selected for initiating full backup for the database system. There are twelve available two-hour time windows. If no option is selected, the value is null and 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
backupDeletionPolicy String: This defines when the backups will be deleted. - IMMEDIATE option keep the backup for predefined time i.e 72 hours and then delete permanently... - RETAIN will keep the backups as per the policy defined for database backups.
backupDestinationDetails List<DbBackupConfigBackupDestinationDetail>: Backup destination details.
recoveryWindowInDays Integer: 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.
runImmediateFullBackup Boolean: If set to true, configures automatic full backups in the local region (the region of the DB system) for the first backup run immediately.

autoBackupEnabled boolean: 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: 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
autoFullBackupDay string: Day of the week the full backup should be applied on the database system. If no option is selected, the value is null and we will default to Sunday.
autoFullBackupWindow string: Time window selected for initiating full backup for the database system. There are twelve available two-hour time windows. If no option is selected, the value is null and 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
backupDeletionPolicy string: This defines when the backups will be deleted. - IMMEDIATE option keep the backup for predefined time i.e 72 hours and then delete permanently... - RETAIN will keep the backups as per the policy defined for database backups.
backupDestinationDetails DatabaseDbBackupConfigBackupDestinationDetail[]: Backup destination details.
recoveryWindowInDays number: 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.
runImmediateFullBackup boolean: If set to true, configures automatic full backups in the local region (the region of the DB system) for the first backup run immediately.

auto_backup_enabled bool: 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: 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
auto_full_backup_day str: Day of the week the full backup should be applied on the database system. If no option is selected, the value is null and we will default to Sunday.
auto_full_backup_window str: Time window selected for initiating full backup for the database system. There are twelve available two-hour time windows. If no option is selected, the value is null and 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_deletion_policy str: This defines when the backups will be deleted. - IMMEDIATE option keep the backup for predefined time i.e 72 hours and then delete permanently... - RETAIN will keep the backups as per the policy defined for database backups.
backup_destination_details Sequence[DatabaseDbBackupConfigBackupDestinationDetail]: Backup destination details.
recovery_window_in_days int: 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.
run_immediate_full_backup bool: If set to true, configures automatic full backups in the local region (the region of the DB system) for the first backup run immediately.

autoBackupEnabled Boolean: 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: 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
autoFullBackupDay String: Day of the week the full backup should be applied on the database system. If no option is selected, the value is null and we will default to Sunday.
autoFullBackupWindow String: Time window selected for initiating full backup for the database system. There are twelve available two-hour time windows. If no option is selected, the value is null and 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
backupDeletionPolicy String: This defines when the backups will be deleted. - IMMEDIATE option keep the backup for predefined time i.e 72 hours and then delete permanently... - RETAIN will keep the backups as per the policy defined for database backups.
backupDestinationDetails List<Property Map>: Backup destination details.
recoveryWindowInDays Number: 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.
runImmediateFullBackup Boolean: If set to true, configures automatic full backups in the local region (the region of the DB system) for the first backup run immediately.

DatabaseDbBackupConfigBackupDestinationDetail, DatabaseDbBackupConfigBackupDestinationDetailArgs

DbrsPolicyId string: The OCID of the DBRS policy used for backup.
Id string: The OCID of the database.
Type string: Type of the database backup destination.
VpcUser string

DbrsPolicyId string: The OCID of the DBRS policy used for backup.
Id string: The OCID of the database.
Type string: Type of the database backup destination.
VpcUser string

dbrsPolicyId String: The OCID of the DBRS policy used for backup.
id String: The OCID of the database.
type String: Type of the database backup destination.
vpcUser String

dbrsPolicyId string: The OCID of the DBRS policy used for backup.
id string: The OCID of the database.
type string: Type of the database backup destination.
vpcUser string

dbrs_policy_id str: The OCID of the DBRS policy used for backup.
id str: The OCID of the database.
type str: Type of the database backup destination.
vpc_user str

dbrsPolicyId String: The OCID of the DBRS policy used for backup.
id String: The OCID of the database.
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"

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository: oci pulumi/pulumi-oci
License: Apache-2.0
Notes: This Pulumi package is based on the oci Terraform Provider.

Oracle Cloud Infrastructure v2.33.0 published on Thursday, May 1, 2025 by Pulumi

pulumi/pulumi-oci

oci.Database.Database

On this page

On this page

Create Database Resource

Constructor syntax

Parameters

Constructor example

Database Resource Properties

Inputs

Outputs

Look up Existing Database Resource

Supporting Types

DatabaseConnectionString, DatabaseConnectionStringArgs

DatabaseDataGuardGroup, DatabaseDataGuardGroupArgs

DatabaseDataGuardGroupMember, DatabaseDataGuardGroupMemberArgs

DatabaseDatabase, DatabaseDatabaseArgs

DatabaseDatabaseDbBackupConfig, DatabaseDatabaseDbBackupConfigArgs

DatabaseDatabaseDbBackupConfigBackupDestinationDetail, DatabaseDatabaseDbBackupConfigBackupDestinationDetailArgs

DatabaseDatabaseEncryptionKeyLocationDetails, DatabaseDatabaseEncryptionKeyLocationDetailsArgs

DatabaseDatabaseManagementConfig, DatabaseDatabaseManagementConfigArgs

DatabaseDatabaseSourceEncryptionKeyLocationDetails, DatabaseDatabaseSourceEncryptionKeyLocationDetailsArgs

DatabaseDbBackupConfig, DatabaseDbBackupConfigArgs

DatabaseDbBackupConfigBackupDestinationDetail, DatabaseDbBackupConfigBackupDestinationDetailArgs

Import

Package Details

On this page

On this page