Oracle Cloud Infrastructure v3.10.0, Nov 5 25

Oracle Cloud Infrastructure v3.10.0 published on Wednesday, Nov 5, 2025 by Pulumi

oci.Database.DatabaseSnapshotStandby

Start a Neo task

Explain and create an oci.Database.DatabaseSnapshotStandby resource

Oracle Cloud Infrastructure v3.10.0 published on Wednesday, Nov 5, 2025 by Pulumi

pulumi/pulumi-oci

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testDatabaseSnapshotStandby = new oci.database.DatabaseSnapshotStandby("test_database_snapshot_standby", {
    databaseAdminPassword: databaseSnapshotStandbyDatabaseAdminPassword,
    databaseId: testDatabase.id,
    standbyConversionType: databaseSnapshotStandbyStandbyConversionType,
    snapshotDurationInDays: databaseSnapshotStandbySnapshotDurationInDays,
});

import pulumi
import pulumi_oci as oci

test_database_snapshot_standby = oci.database.DatabaseSnapshotStandby("test_database_snapshot_standby",
    database_admin_password=database_snapshot_standby_database_admin_password,
    database_id=test_database["id"],
    standby_conversion_type=database_snapshot_standby_standby_conversion_type,
    snapshot_duration_in_days=database_snapshot_standby_snapshot_duration_in_days)

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := database.NewDatabaseSnapshotStandby(ctx, "test_database_snapshot_standby", &database.DatabaseSnapshotStandbyArgs{
			DatabaseAdminPassword:  pulumi.Any(databaseSnapshotStandbyDatabaseAdminPassword),
			DatabaseId:             pulumi.Any(testDatabase.Id),
			StandbyConversionType:  pulumi.Any(databaseSnapshotStandbyStandbyConversionType),
			SnapshotDurationInDays: pulumi.Any(databaseSnapshotStandbySnapshotDurationInDays),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;

return await Deployment.RunAsync(() => 
{
    var testDatabaseSnapshotStandby = new Oci.Database.DatabaseSnapshotStandby("test_database_snapshot_standby", new()
    {
        DatabaseAdminPassword = databaseSnapshotStandbyDatabaseAdminPassword,
        DatabaseId = testDatabase.Id,
        StandbyConversionType = databaseSnapshotStandbyStandbyConversionType,
        SnapshotDurationInDays = databaseSnapshotStandbySnapshotDurationInDays,
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.Database.DatabaseSnapshotStandby;
import com.pulumi.oci.Database.DatabaseSnapshotStandbyArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var testDatabaseSnapshotStandby = new DatabaseSnapshotStandby("testDatabaseSnapshotStandby", DatabaseSnapshotStandbyArgs.builder()
            .databaseAdminPassword(databaseSnapshotStandbyDatabaseAdminPassword)
            .databaseId(testDatabase.id())
            .standbyConversionType(databaseSnapshotStandbyStandbyConversionType)
            .snapshotDurationInDays(databaseSnapshotStandbySnapshotDurationInDays)
            .build());

    }
}

resources:
  testDatabaseSnapshotStandby:
    type: oci:Database:DatabaseSnapshotStandby
    name: test_database_snapshot_standby
    properties:
      databaseAdminPassword: ${databaseSnapshotStandbyDatabaseAdminPassword}
      databaseId: ${testDatabase.id}
      standbyConversionType: ${databaseSnapshotStandbyStandbyConversionType}
      snapshotDurationInDays: ${databaseSnapshotStandbySnapshotDurationInDays}

Create DatabaseSnapshotStandby Resource

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

Constructor syntax

new DatabaseSnapshotStandby(name: string, args: DatabaseSnapshotStandbyArgs, opts?: CustomResourceOptions);

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

@overload
def DatabaseSnapshotStandby(resource_name: str,
                            opts: Optional[ResourceOptions] = None,
                            database_admin_password: Optional[str] = None,
                            database_id: Optional[str] = None,
                            standby_conversion_type: Optional[str] = None,
                            snapshot_duration_in_days: Optional[int] = None)

func NewDatabaseSnapshotStandby(ctx *Context, name string, args DatabaseSnapshotStandbyArgs, opts ...ResourceOption) (*DatabaseSnapshotStandby, error)

public DatabaseSnapshotStandby(string name, DatabaseSnapshotStandbyArgs args, CustomResourceOptions? opts = null)

public DatabaseSnapshotStandby(String name, DatabaseSnapshotStandbyArgs args)
public DatabaseSnapshotStandby(String name, DatabaseSnapshotStandbyArgs args, CustomResourceOptions options)

type: oci:Database:DatabaseSnapshotStandby
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 DatabaseSnapshotStandbyArgs: 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 DatabaseSnapshotStandbyArgs: 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 DatabaseSnapshotStandbyArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args DatabaseSnapshotStandbyArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args DatabaseSnapshotStandbyArgs: 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 databaseSnapshotStandbyResource = new Oci.Database.DatabaseSnapshotStandby("databaseSnapshotStandbyResource", new()
{
    DatabaseAdminPassword = "string",
    DatabaseId = "string",
    StandbyConversionType = "string",
    SnapshotDurationInDays = 0,
});

example, err := database.NewDatabaseSnapshotStandby(ctx, "databaseSnapshotStandbyResource", &database.DatabaseSnapshotStandbyArgs{
	DatabaseAdminPassword:  pulumi.String("string"),
	DatabaseId:             pulumi.String("string"),
	StandbyConversionType:  pulumi.String("string"),
	SnapshotDurationInDays: pulumi.Int(0),
})

var databaseSnapshotStandbyResource = new DatabaseSnapshotStandby("databaseSnapshotStandbyResource", DatabaseSnapshotStandbyArgs.builder()
    .databaseAdminPassword("string")
    .databaseId("string")
    .standbyConversionType("string")
    .snapshotDurationInDays(0)
    .build());

database_snapshot_standby_resource = oci.database.DatabaseSnapshotStandby("databaseSnapshotStandbyResource",
    database_admin_password="string",
    database_id="string",
    standby_conversion_type="string",
    snapshot_duration_in_days=0)

const databaseSnapshotStandbyResource = new oci.database.DatabaseSnapshotStandby("databaseSnapshotStandbyResource", {
    databaseAdminPassword: "string",
    databaseId: "string",
    standbyConversionType: "string",
    snapshotDurationInDays: 0,
});

type: oci:Database:DatabaseSnapshotStandby
properties:
    databaseAdminPassword: string
    databaseId: string
    snapshotDurationInDays: 0
    standbyConversionType: string

DatabaseSnapshotStandby 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 DatabaseSnapshotStandby resource accepts the following input properties:

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.

DatabaseId string

The database OCID.

StandbyConversionType string

Defines the conversion type of the standby database. Specify this to convert a physical standby to a snapshot standby and vice versa.

Valid standbyConversionType:

SNAPSHOT
PHYSICAL

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

SnapshotDurationInDays int

SnapshotDurationInDays is the duration in day(s) after which the Snapshot Standby Database will get converted back to Physical Standby. The minimum value of snapshotDurationInDays is 3 days and maximum value is 14 days. Default value will be 7 days if not provided in the Request.

This field is only applicable if the requested database role is snapshot standby.

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.

DatabaseId string

The database OCID.

StandbyConversionType string

Defines the conversion type of the standby database. Specify this to convert a physical standby to a snapshot standby and vice versa.

Valid standbyConversionType:

SNAPSHOT
PHYSICAL

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

SnapshotDurationInDays int

This field is only applicable if the requested database role is snapshot standby.

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.

databaseId String

The database OCID.

standbyConversionType String

Defines the conversion type of the standby database. Specify this to convert a physical standby to a snapshot standby and vice versa.

Valid standbyConversionType:

SNAPSHOT
PHYSICAL

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

snapshotDurationInDays Integer

This field is only applicable if the requested database role is snapshot standby.

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.

databaseId string

The database OCID.

standbyConversionType string

Defines the conversion type of the standby database. Specify this to convert a physical standby to a snapshot standby and vice versa.

Valid standbyConversionType:

SNAPSHOT
PHYSICAL

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

snapshotDurationInDays number

This field is only applicable if the requested database role is snapshot standby.

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

The database OCID.

standby_conversion_type str

Defines the conversion type of the standby database. Specify this to convert a physical standby to a snapshot standby and vice versa.

Valid standbyConversionType:

SNAPSHOT
PHYSICAL

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

snapshot_duration_in_days int

This field is only applicable if the requested database role is snapshot standby.

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.

databaseId String

The database OCID.

standbyConversionType String

Defines the conversion type of the standby database. Specify this to convert a physical standby to a snapshot standby and vice versa.

Valid standbyConversionType:

SNAPSHOT
PHYSICAL

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

snapshotDurationInDays Number

This field is only applicable if the requested database role is snapshot standby.

Outputs

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

CharacterSet string: The character set for the database.
CompartmentId string: The OCID of the compartment.
ConnectionStrings List<DatabaseSnapshotStandbyConnectionString>: The Connection strings used to connect to the Oracle Database.
DataGuardGroups List<DatabaseSnapshotStandbyDataGuardGroup>: 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<DatabaseSnapshotStandbyDatabaseManagementConfig>: The configuration of the Database Management service.
DatabaseSoftwareImageId string: The database software image OCID
DbBackupConfigs List<DatabaseSnapshotStandbyDbBackupConfig>: 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.
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.
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.
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.
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.
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.

CharacterSet string: The character set for the database.
CompartmentId string: The OCID of the compartment.
ConnectionStrings []DatabaseSnapshotStandbyConnectionString: The Connection strings used to connect to the Oracle Database.
DataGuardGroups []DatabaseSnapshotStandbyDataGuardGroup: 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 []DatabaseSnapshotStandbyDatabaseManagementConfig: The configuration of the Database Management service.
DatabaseSoftwareImageId string: The database software image OCID
DbBackupConfigs []DatabaseSnapshotStandbyDbBackupConfig: 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.
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.
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.
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.
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.
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.

characterSet String: The character set for the database.
compartmentId String: The OCID of the compartment.
connectionStrings List<SnapshotStandbyConnectionString>: The Connection strings used to connect to the Oracle Database.
dataGuardGroups List<SnapshotStandbyDataGuardGroup>: 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<SnapshotStandbyManagementConfig>: The configuration of the Database Management service.
databaseSoftwareImageId String: The database software image OCID
dbBackupConfigs List<SnapshotStandbyDbBackupConfig>: 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.
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.
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.
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.
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.
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.

characterSet string: The character set for the database.
compartmentId string: The OCID of the compartment.
connectionStrings DatabaseSnapshotStandbyConnectionString[]: The Connection strings used to connect to the Oracle Database.
dataGuardGroups DatabaseSnapshotStandbyDataGuardGroup[]: 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 DatabaseSnapshotStandbyDatabaseManagementConfig[]: The configuration of the Database Management service.
databaseSoftwareImageId string: The database software image OCID
dbBackupConfigs DatabaseSnapshotStandbyDbBackupConfig[]: 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.
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.
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.
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.
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.
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.

character_set str: The character set for the database.
compartment_id str: The OCID of the compartment.
connection_strings Sequence[DatabaseSnapshotStandbyConnectionString]: The Connection strings used to connect to the Oracle Database.
data_guard_groups Sequence[DatabaseSnapshotStandbyDataGuardGroup]: 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[DatabaseSnapshotStandbyDatabaseManagementConfig]: The configuration of the Database Management service.
database_software_image_id str: The database software image OCID
db_backup_configs Sequence[DatabaseSnapshotStandbyDbBackupConfig]: Backup Options To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.
db_home_id str: The OCID of the Database Home.
db_name str: The 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_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_version_id str: The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation. Autonomous Database Serverless does not use key versions, hence is not applicable for Autonomous Database Serverless instances.
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.
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.

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

Look up Existing DatabaseSnapshotStandby Resource

Get an existing DatabaseSnapshotStandby 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?: DatabaseSnapshotStandbyState, opts?: CustomResourceOptions): DatabaseSnapshotStandby

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        character_set: Optional[str] = None,
        compartment_id: Optional[str] = None,
        connection_strings: Optional[Sequence[DatabaseSnapshotStandbyConnectionStringArgs]] = None,
        data_guard_groups: Optional[Sequence[DatabaseSnapshotStandbyDataGuardGroupArgs]] = None,
        database_admin_password: Optional[str] = None,
        database_id: Optional[str] = None,
        database_management_configs: Optional[Sequence[DatabaseSnapshotStandbyDatabaseManagementConfigArgs]] = None,
        database_software_image_id: Optional[str] = None,
        db_backup_configs: Optional[Sequence[DatabaseSnapshotStandbyDbBackupConfigArgs]] = 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_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_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,
        snapshot_duration_in_days: Optional[int] = None,
        source_database_point_in_time_recovery_timestamp: Optional[str] = None,
        standby_conversion_type: Optional[str] = None,
        state: Optional[str] = None,
        time_created: Optional[str] = None,
        vault_id: Optional[str] = None,
        vm_cluster_id: Optional[str] = None) -> DatabaseSnapshotStandby

func GetDatabaseSnapshotStandby(ctx *Context, name string, id IDInput, state *DatabaseSnapshotStandbyState, opts ...ResourceOption) (*DatabaseSnapshotStandby, error)

public static DatabaseSnapshotStandby Get(string name, Input<string> id, DatabaseSnapshotStandbyState? state, CustomResourceOptions? opts = null)

public static DatabaseSnapshotStandby get(String name, Output<String> id, DatabaseSnapshotStandbyState state, CustomResourceOptions options)

resources:  _:    type: oci:Database:DatabaseSnapshotStandby    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:

CharacterSet string

The character set for the database.

CompartmentId string

The OCID of the compartment.

ConnectionStrings List<DatabaseSnapshotStandbyConnectionString>

The Connection strings used to connect to the Oracle Database.

DataGuardGroups List<DatabaseSnapshotStandbyDataGuardGroup>

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.

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.

DatabaseId string

The database OCID.

DatabaseManagementConfigs List<DatabaseSnapshotStandbyDatabaseManagementConfig>

The configuration of the Database Management service.

DatabaseSoftwareImageId string

The database software image OCID

DbBackupConfigs List<DatabaseSnapshotStandbyDbBackupConfig>

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.

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.

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.

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.

SnapshotDurationInDays int

This field is only applicable if the requested database role is snapshot standby.

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

StandbyConversionType string

Defines the conversion type of the standby database. Specify this to convert a physical standby to a snapshot standby and vice versa.

Valid standbyConversionType:

SNAPSHOT
PHYSICAL

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

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.

CharacterSet string

The character set for the database.

CompartmentId string

The OCID of the compartment.

ConnectionStrings []DatabaseSnapshotStandbyConnectionStringArgs

The Connection strings used to connect to the Oracle Database.

DataGuardGroups []DatabaseSnapshotStandbyDataGuardGroupArgs

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.

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.

DatabaseId string

The database OCID.

DatabaseManagementConfigs []DatabaseSnapshotStandbyDatabaseManagementConfigArgs

The configuration of the Database Management service.

DatabaseSoftwareImageId string

The database software image OCID

DbBackupConfigs []DatabaseSnapshotStandbyDbBackupConfigArgs

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.

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.

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.

SnapshotDurationInDays int

This field is only applicable if the requested database role is snapshot standby.

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

StandbyConversionType string

Defines the conversion type of the standby database. Specify this to convert a physical standby to a snapshot standby and vice versa.

Valid standbyConversionType:

SNAPSHOT
PHYSICAL

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

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.

characterSet String

The character set for the database.

compartmentId String

The OCID of the compartment.

connectionStrings List<SnapshotStandbyConnectionString>

The Connection strings used to connect to the Oracle Database.

dataGuardGroups List<SnapshotStandbyDataGuardGroup>

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.

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.

databaseId String

The database OCID.

databaseManagementConfigs List<SnapshotStandbyManagementConfig>

The configuration of the Database Management service.

databaseSoftwareImageId String

The database software image OCID

dbBackupConfigs List<SnapshotStandbyDbBackupConfig>

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.

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.

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.

snapshotDurationInDays Integer

This field is only applicable if the requested database role is snapshot standby.

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

standbyConversionType String

Defines the conversion type of the standby database. Specify this to convert a physical standby to a snapshot standby and vice versa.

Valid standbyConversionType:

SNAPSHOT
PHYSICAL

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

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.

characterSet string

The character set for the database.

compartmentId string

The OCID of the compartment.

connectionStrings DatabaseSnapshotStandbyConnectionString[]

The Connection strings used to connect to the Oracle Database.

dataGuardGroups DatabaseSnapshotStandbyDataGuardGroup[]

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.

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.

databaseId string

The database OCID.

databaseManagementConfigs DatabaseSnapshotStandbyDatabaseManagementConfig[]

The configuration of the Database Management service.

databaseSoftwareImageId string

The database software image OCID

dbBackupConfigs DatabaseSnapshotStandbyDbBackupConfig[]

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.

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.

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.

snapshotDurationInDays number

This field is only applicable if the requested database role is snapshot standby.

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

standbyConversionType string

Defines the conversion type of the standby database. Specify this to convert a physical standby to a snapshot standby and vice versa.

Valid standbyConversionType:

SNAPSHOT
PHYSICAL

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

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.

character_set str

The character set for the database.

compartment_id str

The OCID of the compartment.

connection_strings Sequence[DatabaseSnapshotStandbyConnectionStringArgs]

The Connection strings used to connect to the Oracle Database.

data_guard_groups Sequence[DatabaseSnapshotStandbyDataGuardGroupArgs]

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_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_id str

The database OCID.

database_management_configs Sequence[DatabaseSnapshotStandbyDatabaseManagementConfigArgs]

The configuration of the Database Management service.

database_software_image_id str

The database software image OCID

db_backup_configs Sequence[DatabaseSnapshotStandbyDbBackupConfigArgs]

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

snapshot_duration_in_days int

This field is only applicable if the requested database role is snapshot standby.

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

standby_conversion_type str

Defines the conversion type of the standby database. Specify this to convert a physical standby to a snapshot standby and vice versa.

Valid standbyConversionType:

SNAPSHOT
PHYSICAL

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

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.

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.

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.

databaseId String

The database OCID.

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.

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.

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.

snapshotDurationInDays Number

This field is only applicable if the requested database role is snapshot standby.

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

standbyConversionType String

Defines the conversion type of the standby database. Specify this to convert a physical standby to a snapshot standby and vice versa.

Valid standbyConversionType:

SNAPSHOT
PHYSICAL

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

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

DatabaseSnapshotStandbyConnectionString, DatabaseSnapshotStandbyConnectionStringArgs

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.

DatabaseSnapshotStandbyDataGuardGroup, DatabaseSnapshotStandbyDataGuardGroupArgs

Members List<DatabaseSnapshotStandbyDataGuardGroupMember>: 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 []DatabaseSnapshotStandbyDataGuardGroupMember: 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<SnapshotStandbyDataGuardGroupMember>: 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 DatabaseSnapshotStandbyDataGuardGroupMember[]: 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[DatabaseSnapshotStandbyDataGuardGroupMember]: 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.

DatabaseSnapshotStandbyDataGuardGroupMember, DatabaseSnapshotStandbyDataGuardGroupMemberArgs

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

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

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

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

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

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

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

DatabaseSnapshotStandbyDatabaseManagementConfig, DatabaseSnapshotStandbyDatabaseManagementConfigArgs

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.

DatabaseSnapshotStandbyDbBackupConfig, DatabaseSnapshotStandbyDbBackupConfigArgs

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<DatabaseSnapshotStandbyDbBackupConfigBackupDestinationDetail>: 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 []DatabaseSnapshotStandbyDbBackupConfigBackupDestinationDetail: 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<SnapshotStandbyDbBackupConfigBackupDestinationDetail>: 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 DatabaseSnapshotStandbyDbBackupConfigBackupDestinationDetail[]: 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[DatabaseSnapshotStandbyDbBackupConfigBackupDestinationDetail]: 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.

DatabaseSnapshotStandbyDbBackupConfigBackupDestinationDetail, DatabaseSnapshotStandbyDbBackupConfigBackupDestinationDetailArgs

DbrsPolicyId string: The OCID of the DBRS policy used for backup.
Id string: The OCID of the database.
InternetProxy string: Proxy URL to connect to object store.
Type string: Type of the database backup destination.
VpcPassword string: For a RECOVERY_APPLIANCE backup destination, the password for the VPC user that is used to access the Recovery Appliance.
VpcUser string: For a RECOVERY_APPLIANCE backup destination, the Virtual Private Catalog (VPC) user that is used to access the Recovery Appliance.

DbrsPolicyId string: The OCID of the DBRS policy used for backup.
Id string: The OCID of the database.
InternetProxy string: Proxy URL to connect to object store.
Type string: Type of the database backup destination.
VpcPassword string: For a RECOVERY_APPLIANCE backup destination, the password for the VPC user that is used to access the Recovery Appliance.
VpcUser string: For a RECOVERY_APPLIANCE backup destination, the Virtual Private Catalog (VPC) user that is used to access the Recovery Appliance.

dbrsPolicyId String: The OCID of the DBRS policy used for backup.
id String: The OCID of the database.
internetProxy String: Proxy URL to connect to object store.
type String: Type of the database backup destination.
vpcPassword String: For a RECOVERY_APPLIANCE backup destination, the password for the VPC user that is used to access the Recovery Appliance.
vpcUser String: For a RECOVERY_APPLIANCE backup destination, the Virtual Private Catalog (VPC) user that is used to access the Recovery Appliance.

dbrsPolicyId string: The OCID of the DBRS policy used for backup.
id string: The OCID of the database.
internetProxy string: Proxy URL to connect to object store.
type string: Type of the database backup destination.
vpcPassword string: For a RECOVERY_APPLIANCE backup destination, the password for the VPC user that is used to access the Recovery Appliance.
vpcUser string: For a RECOVERY_APPLIANCE backup destination, the Virtual Private Catalog (VPC) user that is used to access the Recovery Appliance.

dbrs_policy_id str: The OCID of the DBRS policy used for backup.
id str: The OCID of the database.
internet_proxy str: Proxy URL to connect to object store.
type str: Type of the database backup destination.
vpc_password str: For a RECOVERY_APPLIANCE backup destination, the password for the VPC user that is used to access the Recovery Appliance.
vpc_user str: For a RECOVERY_APPLIANCE backup destination, the Virtual Private Catalog (VPC) user that is used to access the Recovery Appliance.

dbrsPolicyId String: The OCID of the DBRS policy used for backup.
id String: The OCID of the database.
internetProxy String: Proxy URL to connect to object store.
type String: Type of the database backup destination.
vpcPassword String: For a RECOVERY_APPLIANCE backup destination, the password for the VPC user that is used to access the Recovery Appliance.
vpcUser String: For a RECOVERY_APPLIANCE backup destination, the Virtual Private Catalog (VPC) user that is used to access the Recovery Appliance.

Import

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

$ pulumi import oci:Database/databaseSnapshotStandby:DatabaseSnapshotStandby test_database_snapshot_standby "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 v3.10.0 published on Wednesday, Nov 5, 2025 by Pulumi

pulumi/pulumi-oci

oci.Database.DatabaseSnapshotStandby

On this page

On this page

Example Usage

Create DatabaseSnapshotStandby Resource

Constructor syntax

Parameters

Constructor example

DatabaseSnapshotStandby Resource Properties

Inputs

Outputs

Look up Existing DatabaseSnapshotStandby Resource

Supporting Types

DatabaseSnapshotStandbyConnectionString, DatabaseSnapshotStandbyConnectionStringArgs

DatabaseSnapshotStandbyDataGuardGroup, DatabaseSnapshotStandbyDataGuardGroupArgs

DatabaseSnapshotStandbyDataGuardGroupMember, DatabaseSnapshotStandbyDataGuardGroupMemberArgs

DatabaseSnapshotStandbyDatabaseManagementConfig, DatabaseSnapshotStandbyDatabaseManagementConfigArgs

DatabaseSnapshotStandbyDbBackupConfig, DatabaseSnapshotStandbyDbBackupConfigArgs

DatabaseSnapshotStandbyDbBackupConfigBackupDestinationDetail, DatabaseSnapshotStandbyDbBackupConfigBackupDestinationDetailArgs

Import

Package Details

On this page

On this page