published on Friday, Apr 3, 2026 by Pulumi
published on Friday, Apr 3, 2026 by Pulumi
This resource provides the Distributed Database resource in Oracle Cloud Infrastructure Distributed Database service. Api doc link for the resource: https://docs.oracle.com/iaas/api/#/en/globally-distributed-database/latest/DistributedDatabase
Example terraform configs related to the resource : https://github.com/oracle/terraform-provider-oci/tree/master/examples/distributed_database
Creates a Globally distributed database.
Patch operation to add, remove or update shards to the Globally distributed database topology. In single patch operation, multiple shards can be either added, or removed or updated. Combination of inserts, update and remove in single operation is not allowed.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";
const testDistributedDatabase = new oci.oci.DistributedDatabaseDistributedDatabase("test_distributed_database", {
catalogDetails: [{
adminPassword: distributedDatabaseCatalogDetailsAdminPassword,
source: distributedDatabaseCatalogDetailsSource,
vmClusterId: testVmCluster.id,
kmsKeyId: testKey.id,
kmsKeyVersionId: testKeyVersion.id,
peerDetails: [{
vmClusterId: testVmCluster.id,
protectionMode: distributedDatabaseCatalogDetailsPeerDetailsProtectionMode,
transportType: distributedDatabaseCatalogDetailsPeerDetailsTransportType,
}],
peerVmClusterIds: distributedDatabaseCatalogDetailsPeerVmClusterIds,
shardSpace: distributedDatabaseCatalogDetailsShardSpace,
vaultId: testVault.id,
}],
characterSet: distributedDatabaseCharacterSet,
compartmentId: compartmentId,
databaseVersion: distributedDatabaseDatabaseVersion,
dbDeploymentType: distributedDatabaseDbDeploymentType,
displayName: distributedDatabaseDisplayName,
distributedDatabaseId: distributedDatabaseDistributedDatabaseId,
listenerPort: distributedDatabaseListenerPort,
ncharacterSet: distributedDatabaseNcharacterSet,
onsPortLocal: distributedDatabaseOnsPortLocal,
onsPortRemote: distributedDatabaseOnsPortRemote,
prefix: distributedDatabasePrefix,
privateEndpointIds: distributedDatabasePrivateEndpointIds,
shardDetails: [{
adminPassword: distributedDatabaseShardDetailsAdminPassword,
source: distributedDatabaseShardDetailsSource,
vmClusterId: testVmCluster.id,
kmsKeyId: testKey.id,
kmsKeyVersionId: testKeyVersion.id,
peerDetails: [{
vmClusterId: testVmCluster.id,
protectionMode: distributedDatabaseShardDetailsPeerDetailsProtectionMode,
transportType: distributedDatabaseShardDetailsPeerDetailsTransportType,
}],
peerVmClusterIds: distributedDatabaseShardDetailsPeerVmClusterIds,
shardSpace: distributedDatabaseShardDetailsShardSpace,
vaultId: testVault.id,
}],
shardingMethod: distributedDatabaseShardingMethod,
chunks: distributedDatabaseChunks,
dbBackupConfig: {
autoBackupWindow: distributedDatabaseDbBackupConfigAutoBackupWindow,
autoFullBackupDay: distributedDatabaseDbBackupConfigAutoFullBackupDay,
autoFullBackupWindow: distributedDatabaseDbBackupConfigAutoFullBackupWindow,
backupDeletionPolicy: distributedDatabaseDbBackupConfigBackupDeletionPolicy,
backupDestinationDetails: [{
type: distributedDatabaseDbBackupConfigBackupDestinationDetailsType,
dbrsPolicyId: testPolicy.id,
id: distributedDatabaseDbBackupConfigBackupDestinationDetailsId,
internetProxy: distributedDatabaseDbBackupConfigBackupDestinationDetailsInternetProxy,
isRemote: distributedDatabaseDbBackupConfigBackupDestinationDetailsIsRemote,
isZeroDataLossEnabled: distributedDatabaseDbBackupConfigBackupDestinationDetailsIsZeroDataLossEnabled,
remoteRegion: distributedDatabaseDbBackupConfigBackupDestinationDetailsRemoteRegion,
vpcPassword: distributedDatabaseDbBackupConfigBackupDestinationDetailsVpcPassword,
vpcUser: distributedDatabaseDbBackupConfigBackupDestinationDetailsVpcUser,
}],
canRunImmediateFullBackup: distributedDatabaseDbBackupConfigCanRunImmediateFullBackup,
isAutoBackupEnabled: distributedDatabaseDbBackupConfigIsAutoBackupEnabled,
isRemoteBackupEnabled: distributedDatabaseDbBackupConfigIsRemoteBackupEnabled,
recoveryWindowInDays: distributedDatabaseDbBackupConfigRecoveryWindowInDays,
remoteRegion: distributedDatabaseDbBackupConfigRemoteRegion,
},
definedTags: {
"foo-namespace.bar-key": "value",
},
freeformTags: {
"bar-key": "value",
},
gsmSshPublicKey: distributedDatabaseGsmSshPublicKey,
listenerPortTls: distributedDatabaseListenerPortTls,
patchOperations: [{
operation: distributedDatabasePatchOperationsOperation,
selection: distributedDatabasePatchOperationsSelection,
value: distributedDatabasePatchOperationsValue,
}],
replicationFactor: distributedDatabaseReplicationFactor,
replicationMethod: distributedDatabaseReplicationMethod,
replicationUnit: distributedDatabaseReplicationUnit,
});
import pulumi
import pulumi_oci as oci
test_distributed_database = oci.oci.DistributedDatabaseDistributedDatabase("test_distributed_database",
catalog_details=[{
"admin_password": distributed_database_catalog_details_admin_password,
"source": distributed_database_catalog_details_source,
"vm_cluster_id": test_vm_cluster["id"],
"kms_key_id": test_key["id"],
"kms_key_version_id": test_key_version["id"],
"peer_details": [{
"vm_cluster_id": test_vm_cluster["id"],
"protection_mode": distributed_database_catalog_details_peer_details_protection_mode,
"transport_type": distributed_database_catalog_details_peer_details_transport_type,
}],
"peer_vm_cluster_ids": distributed_database_catalog_details_peer_vm_cluster_ids,
"shard_space": distributed_database_catalog_details_shard_space,
"vault_id": test_vault["id"],
}],
character_set=distributed_database_character_set,
compartment_id=compartment_id,
database_version=distributed_database_database_version,
db_deployment_type=distributed_database_db_deployment_type,
display_name=distributed_database_display_name,
distributed_database_id=distributed_database_distributed_database_id,
listener_port=distributed_database_listener_port,
ncharacter_set=distributed_database_ncharacter_set,
ons_port_local=distributed_database_ons_port_local,
ons_port_remote=distributed_database_ons_port_remote,
prefix=distributed_database_prefix,
private_endpoint_ids=distributed_database_private_endpoint_ids,
shard_details=[{
"admin_password": distributed_database_shard_details_admin_password,
"source": distributed_database_shard_details_source,
"vm_cluster_id": test_vm_cluster["id"],
"kms_key_id": test_key["id"],
"kms_key_version_id": test_key_version["id"],
"peer_details": [{
"vm_cluster_id": test_vm_cluster["id"],
"protection_mode": distributed_database_shard_details_peer_details_protection_mode,
"transport_type": distributed_database_shard_details_peer_details_transport_type,
}],
"peer_vm_cluster_ids": distributed_database_shard_details_peer_vm_cluster_ids,
"shard_space": distributed_database_shard_details_shard_space,
"vault_id": test_vault["id"],
}],
sharding_method=distributed_database_sharding_method,
chunks=distributed_database_chunks,
db_backup_config={
"auto_backup_window": distributed_database_db_backup_config_auto_backup_window,
"auto_full_backup_day": distributed_database_db_backup_config_auto_full_backup_day,
"auto_full_backup_window": distributed_database_db_backup_config_auto_full_backup_window,
"backup_deletion_policy": distributed_database_db_backup_config_backup_deletion_policy,
"backup_destination_details": [{
"type": distributed_database_db_backup_config_backup_destination_details_type,
"dbrs_policy_id": test_policy["id"],
"id": distributed_database_db_backup_config_backup_destination_details_id,
"internet_proxy": distributed_database_db_backup_config_backup_destination_details_internet_proxy,
"is_remote": distributed_database_db_backup_config_backup_destination_details_is_remote,
"is_zero_data_loss_enabled": distributed_database_db_backup_config_backup_destination_details_is_zero_data_loss_enabled,
"remote_region": distributed_database_db_backup_config_backup_destination_details_remote_region,
"vpc_password": distributed_database_db_backup_config_backup_destination_details_vpc_password,
"vpc_user": distributed_database_db_backup_config_backup_destination_details_vpc_user,
}],
"can_run_immediate_full_backup": distributed_database_db_backup_config_can_run_immediate_full_backup,
"is_auto_backup_enabled": distributed_database_db_backup_config_is_auto_backup_enabled,
"is_remote_backup_enabled": distributed_database_db_backup_config_is_remote_backup_enabled,
"recovery_window_in_days": distributed_database_db_backup_config_recovery_window_in_days,
"remote_region": distributed_database_db_backup_config_remote_region,
},
defined_tags={
"foo-namespace.bar-key": "value",
},
freeform_tags={
"bar-key": "value",
},
gsm_ssh_public_key=distributed_database_gsm_ssh_public_key,
listener_port_tls=distributed_database_listener_port_tls,
patch_operations=[{
"operation": distributed_database_patch_operations_operation,
"selection": distributed_database_patch_operations_selection,
"value": distributed_database_patch_operations_value,
}],
replication_factor=distributed_database_replication_factor,
replication_method=distributed_database_replication_method,
replication_unit=distributed_database_replication_unit)
package main
import (
"github.com/pulumi/pulumi-oci/sdk/v4/go/oci/oci"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := oci.NewDistributedDatabaseDistributedDatabase(ctx, "test_distributed_database", &oci.DistributedDatabaseDistributedDatabaseArgs{
CatalogDetails: oci.DistributedDatabaseDistributedDatabaseCatalogDetailArray{
&oci.DistributedDatabaseDistributedDatabaseCatalogDetailArgs{
AdminPassword: pulumi.Any(distributedDatabaseCatalogDetailsAdminPassword),
Source: pulumi.Any(distributedDatabaseCatalogDetailsSource),
VmClusterId: pulumi.Any(testVmCluster.Id),
KmsKeyId: pulumi.Any(testKey.Id),
KmsKeyVersionId: pulumi.Any(testKeyVersion.Id),
PeerDetails: oci.DistributedDatabaseDistributedDatabaseCatalogDetailPeerDetailArray{
&oci.DistributedDatabaseDistributedDatabaseCatalogDetailPeerDetailArgs{
VmClusterId: pulumi.Any(testVmCluster.Id),
ProtectionMode: pulumi.Any(distributedDatabaseCatalogDetailsPeerDetailsProtectionMode),
TransportType: pulumi.Any(distributedDatabaseCatalogDetailsPeerDetailsTransportType),
},
},
PeerVmClusterIds: pulumi.Any(distributedDatabaseCatalogDetailsPeerVmClusterIds),
ShardSpace: pulumi.Any(distributedDatabaseCatalogDetailsShardSpace),
VaultId: pulumi.Any(testVault.Id),
},
},
CharacterSet: pulumi.Any(distributedDatabaseCharacterSet),
CompartmentId: pulumi.Any(compartmentId),
DatabaseVersion: pulumi.Any(distributedDatabaseDatabaseVersion),
DbDeploymentType: pulumi.Any(distributedDatabaseDbDeploymentType),
DisplayName: pulumi.Any(distributedDatabaseDisplayName),
DistributedDatabaseId: distributedDatabaseDistributedDatabaseId,
ListenerPort: pulumi.Any(distributedDatabaseListenerPort),
NcharacterSet: pulumi.Any(distributedDatabaseNcharacterSet),
OnsPortLocal: pulumi.Any(distributedDatabaseOnsPortLocal),
OnsPortRemote: pulumi.Any(distributedDatabaseOnsPortRemote),
Prefix: pulumi.Any(distributedDatabasePrefix),
PrivateEndpointIds: pulumi.Any(distributedDatabasePrivateEndpointIds),
ShardDetails: oci.DistributedDatabaseDistributedDatabaseShardDetailArray{
&oci.DistributedDatabaseDistributedDatabaseShardDetailArgs{
AdminPassword: pulumi.Any(distributedDatabaseShardDetailsAdminPassword),
Source: pulumi.Any(distributedDatabaseShardDetailsSource),
VmClusterId: pulumi.Any(testVmCluster.Id),
KmsKeyId: pulumi.Any(testKey.Id),
KmsKeyVersionId: pulumi.Any(testKeyVersion.Id),
PeerDetails: oci.DistributedDatabaseDistributedDatabaseShardDetailPeerDetailArray{
&oci.DistributedDatabaseDistributedDatabaseShardDetailPeerDetailArgs{
VmClusterId: pulumi.Any(testVmCluster.Id),
ProtectionMode: pulumi.Any(distributedDatabaseShardDetailsPeerDetailsProtectionMode),
TransportType: pulumi.Any(distributedDatabaseShardDetailsPeerDetailsTransportType),
},
},
PeerVmClusterIds: pulumi.Any(distributedDatabaseShardDetailsPeerVmClusterIds),
ShardSpace: pulumi.Any(distributedDatabaseShardDetailsShardSpace),
VaultId: pulumi.Any(testVault.Id),
},
},
ShardingMethod: pulumi.Any(distributedDatabaseShardingMethod),
Chunks: pulumi.Any(distributedDatabaseChunks),
DbBackupConfig: &oci.DistributedDatabaseDistributedDatabaseDbBackupConfigArgs{
AutoBackupWindow: pulumi.Any(distributedDatabaseDbBackupConfigAutoBackupWindow),
AutoFullBackupDay: pulumi.Any(distributedDatabaseDbBackupConfigAutoFullBackupDay),
AutoFullBackupWindow: pulumi.Any(distributedDatabaseDbBackupConfigAutoFullBackupWindow),
BackupDeletionPolicy: pulumi.Any(distributedDatabaseDbBackupConfigBackupDeletionPolicy),
BackupDestinationDetails: oci.DistributedDatabaseDistributedDatabaseDbBackupConfigBackupDestinationDetailArray{
&oci.DistributedDatabaseDistributedDatabaseDbBackupConfigBackupDestinationDetailArgs{
Type: pulumi.Any(distributedDatabaseDbBackupConfigBackupDestinationDetailsType),
DbrsPolicyId: pulumi.Any(testPolicy.Id),
Id: pulumi.Any(distributedDatabaseDbBackupConfigBackupDestinationDetailsId),
InternetProxy: pulumi.Any(distributedDatabaseDbBackupConfigBackupDestinationDetailsInternetProxy),
IsRemote: pulumi.Any(distributedDatabaseDbBackupConfigBackupDestinationDetailsIsRemote),
IsZeroDataLossEnabled: pulumi.Any(distributedDatabaseDbBackupConfigBackupDestinationDetailsIsZeroDataLossEnabled),
RemoteRegion: pulumi.Any(distributedDatabaseDbBackupConfigBackupDestinationDetailsRemoteRegion),
VpcPassword: pulumi.Any(distributedDatabaseDbBackupConfigBackupDestinationDetailsVpcPassword),
VpcUser: pulumi.Any(distributedDatabaseDbBackupConfigBackupDestinationDetailsVpcUser),
},
},
CanRunImmediateFullBackup: pulumi.Any(distributedDatabaseDbBackupConfigCanRunImmediateFullBackup),
IsAutoBackupEnabled: pulumi.Any(distributedDatabaseDbBackupConfigIsAutoBackupEnabled),
IsRemoteBackupEnabled: pulumi.Any(distributedDatabaseDbBackupConfigIsRemoteBackupEnabled),
RecoveryWindowInDays: pulumi.Any(distributedDatabaseDbBackupConfigRecoveryWindowInDays),
RemoteRegion: pulumi.Any(distributedDatabaseDbBackupConfigRemoteRegion),
},
DefinedTags: pulumi.StringMap{
"foo-namespace.bar-key": pulumi.String("value"),
},
FreeformTags: pulumi.StringMap{
"bar-key": pulumi.String("value"),
},
GsmSshPublicKey: pulumi.Any(distributedDatabaseGsmSshPublicKey),
ListenerPortTls: pulumi.Any(distributedDatabaseListenerPortTls),
PatchOperations: oci.DistributedDatabaseDistributedDatabasePatchOperationArray{
&oci.DistributedDatabaseDistributedDatabasePatchOperationArgs{
Operation: pulumi.Any(distributedDatabasePatchOperationsOperation),
Selection: pulumi.Any(distributedDatabasePatchOperationsSelection),
Value: pulumi.Any(distributedDatabasePatchOperationsValue),
},
},
ReplicationFactor: pulumi.Any(distributedDatabaseReplicationFactor),
ReplicationMethod: pulumi.Any(distributedDatabaseReplicationMethod),
ReplicationUnit: pulumi.Any(distributedDatabaseReplicationUnit),
})
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 testDistributedDatabase = new Oci.Oci.DistributedDatabaseDistributedDatabase("test_distributed_database", new()
{
CatalogDetails = new[]
{
new Oci.Oci.Inputs.DistributedDatabaseDistributedDatabaseCatalogDetailArgs
{
AdminPassword = distributedDatabaseCatalogDetailsAdminPassword,
Source = distributedDatabaseCatalogDetailsSource,
VmClusterId = testVmCluster.Id,
KmsKeyId = testKey.Id,
KmsKeyVersionId = testKeyVersion.Id,
PeerDetails = new[]
{
new Oci.Oci.Inputs.DistributedDatabaseDistributedDatabaseCatalogDetailPeerDetailArgs
{
VmClusterId = testVmCluster.Id,
ProtectionMode = distributedDatabaseCatalogDetailsPeerDetailsProtectionMode,
TransportType = distributedDatabaseCatalogDetailsPeerDetailsTransportType,
},
},
PeerVmClusterIds = distributedDatabaseCatalogDetailsPeerVmClusterIds,
ShardSpace = distributedDatabaseCatalogDetailsShardSpace,
VaultId = testVault.Id,
},
},
CharacterSet = distributedDatabaseCharacterSet,
CompartmentId = compartmentId,
DatabaseVersion = distributedDatabaseDatabaseVersion,
DbDeploymentType = distributedDatabaseDbDeploymentType,
DisplayName = distributedDatabaseDisplayName,
DistributedDatabaseId = distributedDatabaseDistributedDatabaseId,
ListenerPort = distributedDatabaseListenerPort,
NcharacterSet = distributedDatabaseNcharacterSet,
OnsPortLocal = distributedDatabaseOnsPortLocal,
OnsPortRemote = distributedDatabaseOnsPortRemote,
Prefix = distributedDatabasePrefix,
PrivateEndpointIds = distributedDatabasePrivateEndpointIds,
ShardDetails = new[]
{
new Oci.Oci.Inputs.DistributedDatabaseDistributedDatabaseShardDetailArgs
{
AdminPassword = distributedDatabaseShardDetailsAdminPassword,
Source = distributedDatabaseShardDetailsSource,
VmClusterId = testVmCluster.Id,
KmsKeyId = testKey.Id,
KmsKeyVersionId = testKeyVersion.Id,
PeerDetails = new[]
{
new Oci.Oci.Inputs.DistributedDatabaseDistributedDatabaseShardDetailPeerDetailArgs
{
VmClusterId = testVmCluster.Id,
ProtectionMode = distributedDatabaseShardDetailsPeerDetailsProtectionMode,
TransportType = distributedDatabaseShardDetailsPeerDetailsTransportType,
},
},
PeerVmClusterIds = distributedDatabaseShardDetailsPeerVmClusterIds,
ShardSpace = distributedDatabaseShardDetailsShardSpace,
VaultId = testVault.Id,
},
},
ShardingMethod = distributedDatabaseShardingMethod,
Chunks = distributedDatabaseChunks,
DbBackupConfig = new Oci.Oci.Inputs.DistributedDatabaseDistributedDatabaseDbBackupConfigArgs
{
AutoBackupWindow = distributedDatabaseDbBackupConfigAutoBackupWindow,
AutoFullBackupDay = distributedDatabaseDbBackupConfigAutoFullBackupDay,
AutoFullBackupWindow = distributedDatabaseDbBackupConfigAutoFullBackupWindow,
BackupDeletionPolicy = distributedDatabaseDbBackupConfigBackupDeletionPolicy,
BackupDestinationDetails = new[]
{
new Oci.Oci.Inputs.DistributedDatabaseDistributedDatabaseDbBackupConfigBackupDestinationDetailArgs
{
Type = distributedDatabaseDbBackupConfigBackupDestinationDetailsType,
DbrsPolicyId = testPolicy.Id,
Id = distributedDatabaseDbBackupConfigBackupDestinationDetailsId,
InternetProxy = distributedDatabaseDbBackupConfigBackupDestinationDetailsInternetProxy,
IsRemote = distributedDatabaseDbBackupConfigBackupDestinationDetailsIsRemote,
IsZeroDataLossEnabled = distributedDatabaseDbBackupConfigBackupDestinationDetailsIsZeroDataLossEnabled,
RemoteRegion = distributedDatabaseDbBackupConfigBackupDestinationDetailsRemoteRegion,
VpcPassword = distributedDatabaseDbBackupConfigBackupDestinationDetailsVpcPassword,
VpcUser = distributedDatabaseDbBackupConfigBackupDestinationDetailsVpcUser,
},
},
CanRunImmediateFullBackup = distributedDatabaseDbBackupConfigCanRunImmediateFullBackup,
IsAutoBackupEnabled = distributedDatabaseDbBackupConfigIsAutoBackupEnabled,
IsRemoteBackupEnabled = distributedDatabaseDbBackupConfigIsRemoteBackupEnabled,
RecoveryWindowInDays = distributedDatabaseDbBackupConfigRecoveryWindowInDays,
RemoteRegion = distributedDatabaseDbBackupConfigRemoteRegion,
},
DefinedTags =
{
{ "foo-namespace.bar-key", "value" },
},
FreeformTags =
{
{ "bar-key", "value" },
},
GsmSshPublicKey = distributedDatabaseGsmSshPublicKey,
ListenerPortTls = distributedDatabaseListenerPortTls,
PatchOperations = new[]
{
new Oci.Oci.Inputs.DistributedDatabaseDistributedDatabasePatchOperationArgs
{
Operation = distributedDatabasePatchOperationsOperation,
Selection = distributedDatabasePatchOperationsSelection,
Value = distributedDatabasePatchOperationsValue,
},
},
ReplicationFactor = distributedDatabaseReplicationFactor,
ReplicationMethod = distributedDatabaseReplicationMethod,
ReplicationUnit = distributedDatabaseReplicationUnit,
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.oci.DistributedDatabaseDistributedDatabase;
import com.pulumi.oci.oci.DistributedDatabaseDistributedDatabaseArgs;
import com.pulumi.oci.oci.inputs.DistributedDatabaseDistributedDatabaseCatalogDetailArgs;
import com.pulumi.oci.oci.inputs.DistributedDatabaseDistributedDatabaseShardDetailArgs;
import com.pulumi.oci.oci.inputs.DistributedDatabaseDistributedDatabaseDbBackupConfigArgs;
import com.pulumi.oci.oci.inputs.DistributedDatabaseDistributedDatabasePatchOperationArgs;
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 testDistributedDatabase = new DistributedDatabaseDistributedDatabase("testDistributedDatabase", DistributedDatabaseDistributedDatabaseArgs.builder()
.catalogDetails(DistributedDatabaseDistributedDatabaseCatalogDetailArgs.builder()
.adminPassword(distributedDatabaseCatalogDetailsAdminPassword)
.source(distributedDatabaseCatalogDetailsSource)
.vmClusterId(testVmCluster.id())
.kmsKeyId(testKey.id())
.kmsKeyVersionId(testKeyVersion.id())
.peerDetails(DistributedDatabaseDistributedDatabaseCatalogDetailPeerDetailArgs.builder()
.vmClusterId(testVmCluster.id())
.protectionMode(distributedDatabaseCatalogDetailsPeerDetailsProtectionMode)
.transportType(distributedDatabaseCatalogDetailsPeerDetailsTransportType)
.build())
.peerVmClusterIds(distributedDatabaseCatalogDetailsPeerVmClusterIds)
.shardSpace(distributedDatabaseCatalogDetailsShardSpace)
.vaultId(testVault.id())
.build())
.characterSet(distributedDatabaseCharacterSet)
.compartmentId(compartmentId)
.databaseVersion(distributedDatabaseDatabaseVersion)
.dbDeploymentType(distributedDatabaseDbDeploymentType)
.displayName(distributedDatabaseDisplayName)
.distributedDatabaseId(distributedDatabaseDistributedDatabaseId)
.listenerPort(distributedDatabaseListenerPort)
.ncharacterSet(distributedDatabaseNcharacterSet)
.onsPortLocal(distributedDatabaseOnsPortLocal)
.onsPortRemote(distributedDatabaseOnsPortRemote)
.prefix(distributedDatabasePrefix)
.privateEndpointIds(distributedDatabasePrivateEndpointIds)
.shardDetails(DistributedDatabaseDistributedDatabaseShardDetailArgs.builder()
.adminPassword(distributedDatabaseShardDetailsAdminPassword)
.source(distributedDatabaseShardDetailsSource)
.vmClusterId(testVmCluster.id())
.kmsKeyId(testKey.id())
.kmsKeyVersionId(testKeyVersion.id())
.peerDetails(DistributedDatabaseDistributedDatabaseShardDetailPeerDetailArgs.builder()
.vmClusterId(testVmCluster.id())
.protectionMode(distributedDatabaseShardDetailsPeerDetailsProtectionMode)
.transportType(distributedDatabaseShardDetailsPeerDetailsTransportType)
.build())
.peerVmClusterIds(distributedDatabaseShardDetailsPeerVmClusterIds)
.shardSpace(distributedDatabaseShardDetailsShardSpace)
.vaultId(testVault.id())
.build())
.shardingMethod(distributedDatabaseShardingMethod)
.chunks(distributedDatabaseChunks)
.dbBackupConfig(DistributedDatabaseDistributedDatabaseDbBackupConfigArgs.builder()
.autoBackupWindow(distributedDatabaseDbBackupConfigAutoBackupWindow)
.autoFullBackupDay(distributedDatabaseDbBackupConfigAutoFullBackupDay)
.autoFullBackupWindow(distributedDatabaseDbBackupConfigAutoFullBackupWindow)
.backupDeletionPolicy(distributedDatabaseDbBackupConfigBackupDeletionPolicy)
.backupDestinationDetails(DistributedDatabaseDistributedDatabaseDbBackupConfigBackupDestinationDetailArgs.builder()
.type(distributedDatabaseDbBackupConfigBackupDestinationDetailsType)
.dbrsPolicyId(testPolicy.id())
.id(distributedDatabaseDbBackupConfigBackupDestinationDetailsId)
.internetProxy(distributedDatabaseDbBackupConfigBackupDestinationDetailsInternetProxy)
.isRemote(distributedDatabaseDbBackupConfigBackupDestinationDetailsIsRemote)
.isZeroDataLossEnabled(distributedDatabaseDbBackupConfigBackupDestinationDetailsIsZeroDataLossEnabled)
.remoteRegion(distributedDatabaseDbBackupConfigBackupDestinationDetailsRemoteRegion)
.vpcPassword(distributedDatabaseDbBackupConfigBackupDestinationDetailsVpcPassword)
.vpcUser(distributedDatabaseDbBackupConfigBackupDestinationDetailsVpcUser)
.build())
.canRunImmediateFullBackup(distributedDatabaseDbBackupConfigCanRunImmediateFullBackup)
.isAutoBackupEnabled(distributedDatabaseDbBackupConfigIsAutoBackupEnabled)
.isRemoteBackupEnabled(distributedDatabaseDbBackupConfigIsRemoteBackupEnabled)
.recoveryWindowInDays(distributedDatabaseDbBackupConfigRecoveryWindowInDays)
.remoteRegion(distributedDatabaseDbBackupConfigRemoteRegion)
.build())
.definedTags(Map.of("foo-namespace.bar-key", "value"))
.freeformTags(Map.of("bar-key", "value"))
.gsmSshPublicKey(distributedDatabaseGsmSshPublicKey)
.listenerPortTls(distributedDatabaseListenerPortTls)
.patchOperations(DistributedDatabaseDistributedDatabasePatchOperationArgs.builder()
.operation(distributedDatabasePatchOperationsOperation)
.selection(distributedDatabasePatchOperationsSelection)
.value(distributedDatabasePatchOperationsValue)
.build())
.replicationFactor(distributedDatabaseReplicationFactor)
.replicationMethod(distributedDatabaseReplicationMethod)
.replicationUnit(distributedDatabaseReplicationUnit)
.build());
}
}
resources:
testDistributedDatabase:
type: oci:oci:DistributedDatabaseDistributedDatabase
name: test_distributed_database
properties:
catalogDetails:
- adminPassword: ${distributedDatabaseCatalogDetailsAdminPassword}
source: ${distributedDatabaseCatalogDetailsSource}
vmClusterId: ${testVmCluster.id}
kmsKeyId: ${testKey.id}
kmsKeyVersionId: ${testKeyVersion.id}
peerDetails:
- vmClusterId: ${testVmCluster.id}
protectionMode: ${distributedDatabaseCatalogDetailsPeerDetailsProtectionMode}
transportType: ${distributedDatabaseCatalogDetailsPeerDetailsTransportType}
peerVmClusterIds: ${distributedDatabaseCatalogDetailsPeerVmClusterIds}
shardSpace: ${distributedDatabaseCatalogDetailsShardSpace}
vaultId: ${testVault.id}
characterSet: ${distributedDatabaseCharacterSet}
compartmentId: ${compartmentId}
databaseVersion: ${distributedDatabaseDatabaseVersion}
dbDeploymentType: ${distributedDatabaseDbDeploymentType}
displayName: ${distributedDatabaseDisplayName}
distributedDatabaseId: ${distributedDatabaseDistributedDatabaseId}
listenerPort: ${distributedDatabaseListenerPort}
ncharacterSet: ${distributedDatabaseNcharacterSet}
onsPortLocal: ${distributedDatabaseOnsPortLocal}
onsPortRemote: ${distributedDatabaseOnsPortRemote}
prefix: ${distributedDatabasePrefix}
privateEndpointIds: ${distributedDatabasePrivateEndpointIds}
shardDetails:
- adminPassword: ${distributedDatabaseShardDetailsAdminPassword}
source: ${distributedDatabaseShardDetailsSource}
vmClusterId: ${testVmCluster.id}
kmsKeyId: ${testKey.id}
kmsKeyVersionId: ${testKeyVersion.id}
peerDetails:
- vmClusterId: ${testVmCluster.id}
protectionMode: ${distributedDatabaseShardDetailsPeerDetailsProtectionMode}
transportType: ${distributedDatabaseShardDetailsPeerDetailsTransportType}
peerVmClusterIds: ${distributedDatabaseShardDetailsPeerVmClusterIds}
shardSpace: ${distributedDatabaseShardDetailsShardSpace}
vaultId: ${testVault.id}
shardingMethod: ${distributedDatabaseShardingMethod}
chunks: ${distributedDatabaseChunks}
dbBackupConfig:
autoBackupWindow: ${distributedDatabaseDbBackupConfigAutoBackupWindow}
autoFullBackupDay: ${distributedDatabaseDbBackupConfigAutoFullBackupDay}
autoFullBackupWindow: ${distributedDatabaseDbBackupConfigAutoFullBackupWindow}
backupDeletionPolicy: ${distributedDatabaseDbBackupConfigBackupDeletionPolicy}
backupDestinationDetails:
- type: ${distributedDatabaseDbBackupConfigBackupDestinationDetailsType}
dbrsPolicyId: ${testPolicy.id}
id: ${distributedDatabaseDbBackupConfigBackupDestinationDetailsId}
internetProxy: ${distributedDatabaseDbBackupConfigBackupDestinationDetailsInternetProxy}
isRemote: ${distributedDatabaseDbBackupConfigBackupDestinationDetailsIsRemote}
isZeroDataLossEnabled: ${distributedDatabaseDbBackupConfigBackupDestinationDetailsIsZeroDataLossEnabled}
remoteRegion: ${distributedDatabaseDbBackupConfigBackupDestinationDetailsRemoteRegion}
vpcPassword: ${distributedDatabaseDbBackupConfigBackupDestinationDetailsVpcPassword}
vpcUser: ${distributedDatabaseDbBackupConfigBackupDestinationDetailsVpcUser}
canRunImmediateFullBackup: ${distributedDatabaseDbBackupConfigCanRunImmediateFullBackup}
isAutoBackupEnabled: ${distributedDatabaseDbBackupConfigIsAutoBackupEnabled}
isRemoteBackupEnabled: ${distributedDatabaseDbBackupConfigIsRemoteBackupEnabled}
recoveryWindowInDays: ${distributedDatabaseDbBackupConfigRecoveryWindowInDays}
remoteRegion: ${distributedDatabaseDbBackupConfigRemoteRegion}
definedTags:
foo-namespace.bar-key: value
freeformTags:
bar-key: value
gsmSshPublicKey: ${distributedDatabaseGsmSshPublicKey}
listenerPortTls: ${distributedDatabaseListenerPortTls}
patchOperations:
- operation: ${distributedDatabasePatchOperationsOperation}
selection: ${distributedDatabasePatchOperationsSelection}
value: ${distributedDatabasePatchOperationsValue}
replicationFactor: ${distributedDatabaseReplicationFactor}
replicationMethod: ${distributedDatabaseReplicationMethod}
replicationUnit: ${distributedDatabaseReplicationUnit}
Create DistributedDatabaseDistributedDatabase Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new DistributedDatabaseDistributedDatabase(name: string, args: DistributedDatabaseDistributedDatabaseArgs, opts?: CustomResourceOptions);@overload
def DistributedDatabaseDistributedDatabase(resource_name: str,
args: DistributedDatabaseDistributedDatabaseArgs,
opts: Optional[ResourceOptions] = None)
@overload
def DistributedDatabaseDistributedDatabase(resource_name: str,
opts: Optional[ResourceOptions] = None,
listener_port: Optional[int] = None,
catalog_details: Optional[Sequence[DistributedDatabaseDistributedDatabaseCatalogDetailArgs]] = None,
character_set: Optional[str] = None,
sharding_method: Optional[str] = None,
compartment_id: Optional[str] = None,
ncharacter_set: Optional[str] = None,
shard_details: Optional[Sequence[DistributedDatabaseDistributedDatabaseShardDetailArgs]] = None,
database_version: Optional[str] = None,
private_endpoint_ids: Optional[Sequence[str]] = None,
db_deployment_type: Optional[str] = None,
prefix: Optional[str] = None,
display_name: Optional[str] = None,
ons_port_remote: Optional[int] = None,
ons_port_local: Optional[int] = None,
listener_port_tls: Optional[int] = None,
db_backup_config: Optional[DistributedDatabaseDistributedDatabaseDbBackupConfigArgs] = None,
generate_wallet_trigger: Optional[int] = None,
gsm_ssh_public_key: Optional[str] = None,
change_db_backup_config_trigger: Optional[int] = None,
generate_gsm_certificate_signing_request_trigger: Optional[int] = None,
configure_sharding_is_rebalance_required: Optional[bool] = None,
freeform_tags: Optional[Mapping[str, str]] = None,
download_gsm_certificate_signing_request_trigger: Optional[int] = None,
patch_operations: Optional[Sequence[DistributedDatabaseDistributedDatabasePatchOperationArgs]] = None,
defined_tags: Optional[Mapping[str, str]] = None,
generate_wallet_password: Optional[str] = None,
replication_factor: Optional[int] = None,
replication_method: Optional[str] = None,
replication_unit: Optional[int] = None,
configure_sharding_trigger: Optional[int] = None,
chunks: Optional[int] = None,
start_database_trigger: Optional[int] = None,
state: Optional[str] = None,
stop_database_trigger: Optional[int] = None,
upload_signed_certificate_and_generate_wallet_trigger: Optional[int] = None,
validate_network_details: Optional[DistributedDatabaseDistributedDatabaseValidateNetworkDetailsArgs] = None,
validate_network_trigger: Optional[int] = None)func NewDistributedDatabaseDistributedDatabase(ctx *Context, name string, args DistributedDatabaseDistributedDatabaseArgs, opts ...ResourceOption) (*DistributedDatabaseDistributedDatabase, error)public DistributedDatabaseDistributedDatabase(string name, DistributedDatabaseDistributedDatabaseArgs args, CustomResourceOptions? opts = null)
public DistributedDatabaseDistributedDatabase(String name, DistributedDatabaseDistributedDatabaseArgs args)
public DistributedDatabaseDistributedDatabase(String name, DistributedDatabaseDistributedDatabaseArgs args, CustomResourceOptions options)
type: oci:oci:DistributedDatabaseDistributedDatabase
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 DistributedDatabaseDistributedDatabaseArgs
- 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 DistributedDatabaseDistributedDatabaseArgs
- 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 DistributedDatabaseDistributedDatabaseArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args DistributedDatabaseDistributedDatabaseArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args DistributedDatabaseDistributedDatabaseArgs
- 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 distributedDatabaseDistributedDatabaseResource = new Oci.Oci.DistributedDatabaseDistributedDatabase("distributedDatabaseDistributedDatabaseResource", new()
{
ListenerPort = 0,
CatalogDetails = new[]
{
new Oci.Oci.Inputs.DistributedDatabaseDistributedDatabaseCatalogDetailArgs
{
AdminPassword = "string",
VmClusterId = "string",
Source = "string",
PeerVmClusterIds = new[]
{
"string",
},
ShardSpace = "string",
Metadatas = new[]
{
new Oci.Oci.Inputs.DistributedDatabaseDistributedDatabaseCatalogDetailMetadataArgs
{
Map =
{
{ "string", "string" },
},
},
},
Name = "string",
PeerDetails = new[]
{
new Oci.Oci.Inputs.DistributedDatabaseDistributedDatabaseCatalogDetailPeerDetailArgs
{
VmClusterId = "string",
ContainerDatabaseId = "string",
Metadatas = new[]
{
new Oci.Oci.Inputs.DistributedDatabaseDistributedDatabaseCatalogDetailPeerDetailMetadataArgs
{
Map =
{
{ "string", "string" },
},
},
},
ProtectionMode = "string",
ShardGroup = "string",
Status = "string",
SupportingResourceId = "string",
TimeCreated = "string",
TimeUpdated = "string",
TransportType = "string",
},
},
KmsKeyId = "string",
ShardGroup = "string",
KmsKeyVersionId = "string",
DbHomeId = "string",
Status = "string",
SupportingResourceId = "string",
TimeCreated = "string",
TimeUpdated = "string",
VaultId = "string",
ContainerDatabaseId = "string",
},
},
CharacterSet = "string",
ShardingMethod = "string",
CompartmentId = "string",
NcharacterSet = "string",
ShardDetails = new[]
{
new Oci.Oci.Inputs.DistributedDatabaseDistributedDatabaseShardDetailArgs
{
AdminPassword = "string",
VmClusterId = "string",
Source = "string",
PeerVmClusterIds = new[]
{
"string",
},
ShardSpace = "string",
Metadatas = new[]
{
new Oci.Oci.Inputs.DistributedDatabaseDistributedDatabaseShardDetailMetadataArgs
{
Map =
{
{ "string", "string" },
},
},
},
Name = "string",
PeerDetails = new[]
{
new Oci.Oci.Inputs.DistributedDatabaseDistributedDatabaseShardDetailPeerDetailArgs
{
VmClusterId = "string",
ContainerDatabaseId = "string",
Metadatas = new[]
{
new Oci.Oci.Inputs.DistributedDatabaseDistributedDatabaseShardDetailPeerDetailMetadataArgs
{
Map =
{
{ "string", "string" },
},
},
},
ProtectionMode = "string",
ShardGroup = "string",
Status = "string",
SupportingResourceId = "string",
TimeCreated = "string",
TimeUpdated = "string",
TransportType = "string",
},
},
KmsKeyId = "string",
ShardGroup = "string",
KmsKeyVersionId = "string",
DbHomeId = "string",
Status = "string",
SupportingResourceId = "string",
TimeCreated = "string",
TimeUpdated = "string",
VaultId = "string",
ContainerDatabaseId = "string",
},
},
DatabaseVersion = "string",
PrivateEndpointIds = new[]
{
"string",
},
DbDeploymentType = "string",
Prefix = "string",
DisplayName = "string",
OnsPortRemote = 0,
OnsPortLocal = 0,
ListenerPortTls = 0,
DbBackupConfig = new Oci.Oci.Inputs.DistributedDatabaseDistributedDatabaseDbBackupConfigArgs
{
AutoBackupWindow = "string",
AutoFullBackupDay = "string",
AutoFullBackupWindow = "string",
BackupDeletionPolicy = "string",
BackupDestinationDetails = new[]
{
new Oci.Oci.Inputs.DistributedDatabaseDistributedDatabaseDbBackupConfigBackupDestinationDetailArgs
{
Type = "string",
DbrsPolicyId = "string",
Id = "string",
InternetProxy = "string",
IsRemote = false,
IsZeroDataLossEnabled = false,
RemoteRegion = "string",
VpcPassword = "string",
VpcUser = "string",
},
},
CanRunImmediateFullBackup = false,
IsAutoBackupEnabled = false,
IsRemoteBackupEnabled = false,
RecoveryWindowInDays = 0,
RemoteRegion = "string",
},
GenerateWalletTrigger = 0,
GsmSshPublicKey = "string",
ChangeDbBackupConfigTrigger = 0,
ConfigureShardingIsRebalanceRequired = false,
FreeformTags =
{
{ "string", "string" },
},
PatchOperations = new[]
{
new Oci.Oci.Inputs.DistributedDatabaseDistributedDatabasePatchOperationArgs
{
Operation = "string",
Selection = "string",
Value = "string",
},
},
DefinedTags =
{
{ "string", "string" },
},
GenerateWalletPassword = "string",
ReplicationFactor = 0,
ReplicationMethod = "string",
ReplicationUnit = 0,
ConfigureShardingTrigger = 0,
Chunks = 0,
StartDatabaseTrigger = 0,
State = "string",
StopDatabaseTrigger = 0,
ValidateNetworkDetails = new Oci.Oci.Inputs.DistributedDatabaseDistributedDatabaseValidateNetworkDetailsArgs
{
IsSurrogate = false,
ResourceName = "string",
ShardGroup = "string",
},
ValidateNetworkTrigger = 0,
});
example, err := oci.NewDistributedDatabaseDistributedDatabase(ctx, "distributedDatabaseDistributedDatabaseResource", &oci.DistributedDatabaseDistributedDatabaseArgs{
ListenerPort: pulumi.Int(0),
CatalogDetails: oci.DistributedDatabaseDistributedDatabaseCatalogDetailArray{
&oci.DistributedDatabaseDistributedDatabaseCatalogDetailArgs{
AdminPassword: pulumi.String("string"),
VmClusterId: pulumi.String("string"),
Source: pulumi.String("string"),
PeerVmClusterIds: pulumi.StringArray{
pulumi.String("string"),
},
ShardSpace: pulumi.String("string"),
Metadatas: oci.DistributedDatabaseDistributedDatabaseCatalogDetailMetadataArray{
&oci.DistributedDatabaseDistributedDatabaseCatalogDetailMetadataArgs{
Map: pulumi.StringMap{
"string": pulumi.String("string"),
},
},
},
Name: pulumi.String("string"),
PeerDetails: oci.DistributedDatabaseDistributedDatabaseCatalogDetailPeerDetailArray{
&oci.DistributedDatabaseDistributedDatabaseCatalogDetailPeerDetailArgs{
VmClusterId: pulumi.String("string"),
ContainerDatabaseId: pulumi.String("string"),
Metadatas: oci.DistributedDatabaseDistributedDatabaseCatalogDetailPeerDetailMetadataArray{
&oci.DistributedDatabaseDistributedDatabaseCatalogDetailPeerDetailMetadataArgs{
Map: pulumi.StringMap{
"string": pulumi.String("string"),
},
},
},
ProtectionMode: pulumi.String("string"),
ShardGroup: pulumi.String("string"),
Status: pulumi.String("string"),
SupportingResourceId: pulumi.String("string"),
TimeCreated: pulumi.String("string"),
TimeUpdated: pulumi.String("string"),
TransportType: pulumi.String("string"),
},
},
KmsKeyId: pulumi.String("string"),
ShardGroup: pulumi.String("string"),
KmsKeyVersionId: pulumi.String("string"),
DbHomeId: pulumi.String("string"),
Status: pulumi.String("string"),
SupportingResourceId: pulumi.String("string"),
TimeCreated: pulumi.String("string"),
TimeUpdated: pulumi.String("string"),
VaultId: pulumi.String("string"),
ContainerDatabaseId: pulumi.String("string"),
},
},
CharacterSet: pulumi.String("string"),
ShardingMethod: pulumi.String("string"),
CompartmentId: pulumi.String("string"),
NcharacterSet: pulumi.String("string"),
ShardDetails: oci.DistributedDatabaseDistributedDatabaseShardDetailArray{
&oci.DistributedDatabaseDistributedDatabaseShardDetailArgs{
AdminPassword: pulumi.String("string"),
VmClusterId: pulumi.String("string"),
Source: pulumi.String("string"),
PeerVmClusterIds: pulumi.StringArray{
pulumi.String("string"),
},
ShardSpace: pulumi.String("string"),
Metadatas: oci.DistributedDatabaseDistributedDatabaseShardDetailMetadataArray{
&oci.DistributedDatabaseDistributedDatabaseShardDetailMetadataArgs{
Map: pulumi.StringMap{
"string": pulumi.String("string"),
},
},
},
Name: pulumi.String("string"),
PeerDetails: oci.DistributedDatabaseDistributedDatabaseShardDetailPeerDetailArray{
&oci.DistributedDatabaseDistributedDatabaseShardDetailPeerDetailArgs{
VmClusterId: pulumi.String("string"),
ContainerDatabaseId: pulumi.String("string"),
Metadatas: oci.DistributedDatabaseDistributedDatabaseShardDetailPeerDetailMetadataArray{
&oci.DistributedDatabaseDistributedDatabaseShardDetailPeerDetailMetadataArgs{
Map: pulumi.StringMap{
"string": pulumi.String("string"),
},
},
},
ProtectionMode: pulumi.String("string"),
ShardGroup: pulumi.String("string"),
Status: pulumi.String("string"),
SupportingResourceId: pulumi.String("string"),
TimeCreated: pulumi.String("string"),
TimeUpdated: pulumi.String("string"),
TransportType: pulumi.String("string"),
},
},
KmsKeyId: pulumi.String("string"),
ShardGroup: pulumi.String("string"),
KmsKeyVersionId: pulumi.String("string"),
DbHomeId: pulumi.String("string"),
Status: pulumi.String("string"),
SupportingResourceId: pulumi.String("string"),
TimeCreated: pulumi.String("string"),
TimeUpdated: pulumi.String("string"),
VaultId: pulumi.String("string"),
ContainerDatabaseId: pulumi.String("string"),
},
},
DatabaseVersion: pulumi.String("string"),
PrivateEndpointIds: pulumi.StringArray{
pulumi.String("string"),
},
DbDeploymentType: pulumi.String("string"),
Prefix: pulumi.String("string"),
DisplayName: pulumi.String("string"),
OnsPortRemote: pulumi.Int(0),
OnsPortLocal: pulumi.Int(0),
ListenerPortTls: pulumi.Int(0),
DbBackupConfig: &oci.DistributedDatabaseDistributedDatabaseDbBackupConfigArgs{
AutoBackupWindow: pulumi.String("string"),
AutoFullBackupDay: pulumi.String("string"),
AutoFullBackupWindow: pulumi.String("string"),
BackupDeletionPolicy: pulumi.String("string"),
BackupDestinationDetails: oci.DistributedDatabaseDistributedDatabaseDbBackupConfigBackupDestinationDetailArray{
&oci.DistributedDatabaseDistributedDatabaseDbBackupConfigBackupDestinationDetailArgs{
Type: pulumi.String("string"),
DbrsPolicyId: pulumi.String("string"),
Id: pulumi.String("string"),
InternetProxy: pulumi.String("string"),
IsRemote: pulumi.Bool(false),
IsZeroDataLossEnabled: pulumi.Bool(false),
RemoteRegion: pulumi.String("string"),
VpcPassword: pulumi.String("string"),
VpcUser: pulumi.String("string"),
},
},
CanRunImmediateFullBackup: pulumi.Bool(false),
IsAutoBackupEnabled: pulumi.Bool(false),
IsRemoteBackupEnabled: pulumi.Bool(false),
RecoveryWindowInDays: pulumi.Int(0),
RemoteRegion: pulumi.String("string"),
},
GenerateWalletTrigger: pulumi.Int(0),
GsmSshPublicKey: pulumi.String("string"),
ChangeDbBackupConfigTrigger: pulumi.Int(0),
ConfigureShardingIsRebalanceRequired: pulumi.Bool(false),
FreeformTags: pulumi.StringMap{
"string": pulumi.String("string"),
},
PatchOperations: oci.DistributedDatabaseDistributedDatabasePatchOperationArray{
&oci.DistributedDatabaseDistributedDatabasePatchOperationArgs{
Operation: pulumi.String("string"),
Selection: pulumi.String("string"),
Value: pulumi.String("string"),
},
},
DefinedTags: pulumi.StringMap{
"string": pulumi.String("string"),
},
GenerateWalletPassword: pulumi.String("string"),
ReplicationFactor: pulumi.Int(0),
ReplicationMethod: pulumi.String("string"),
ReplicationUnit: pulumi.Int(0),
ConfigureShardingTrigger: pulumi.Int(0),
Chunks: pulumi.Int(0),
StartDatabaseTrigger: pulumi.Int(0),
State: pulumi.String("string"),
StopDatabaseTrigger: pulumi.Int(0),
ValidateNetworkDetails: &oci.DistributedDatabaseDistributedDatabaseValidateNetworkDetailsArgs{
IsSurrogate: pulumi.Bool(false),
ResourceName: pulumi.String("string"),
ShardGroup: pulumi.String("string"),
},
ValidateNetworkTrigger: pulumi.Int(0),
})
var distributedDatabaseDistributedDatabaseResource = new DistributedDatabaseDistributedDatabase("distributedDatabaseDistributedDatabaseResource", DistributedDatabaseDistributedDatabaseArgs.builder()
.listenerPort(0)
.catalogDetails(DistributedDatabaseDistributedDatabaseCatalogDetailArgs.builder()
.adminPassword("string")
.vmClusterId("string")
.source("string")
.peerVmClusterIds("string")
.shardSpace("string")
.metadatas(DistributedDatabaseDistributedDatabaseCatalogDetailMetadataArgs.builder()
.map(Map.of("string", "string"))
.build())
.name("string")
.peerDetails(DistributedDatabaseDistributedDatabaseCatalogDetailPeerDetailArgs.builder()
.vmClusterId("string")
.containerDatabaseId("string")
.metadatas(DistributedDatabaseDistributedDatabaseCatalogDetailPeerDetailMetadataArgs.builder()
.map(Map.of("string", "string"))
.build())
.protectionMode("string")
.shardGroup("string")
.status("string")
.supportingResourceId("string")
.timeCreated("string")
.timeUpdated("string")
.transportType("string")
.build())
.kmsKeyId("string")
.shardGroup("string")
.kmsKeyVersionId("string")
.dbHomeId("string")
.status("string")
.supportingResourceId("string")
.timeCreated("string")
.timeUpdated("string")
.vaultId("string")
.containerDatabaseId("string")
.build())
.characterSet("string")
.shardingMethod("string")
.compartmentId("string")
.ncharacterSet("string")
.shardDetails(DistributedDatabaseDistributedDatabaseShardDetailArgs.builder()
.adminPassword("string")
.vmClusterId("string")
.source("string")
.peerVmClusterIds("string")
.shardSpace("string")
.metadatas(DistributedDatabaseDistributedDatabaseShardDetailMetadataArgs.builder()
.map(Map.of("string", "string"))
.build())
.name("string")
.peerDetails(DistributedDatabaseDistributedDatabaseShardDetailPeerDetailArgs.builder()
.vmClusterId("string")
.containerDatabaseId("string")
.metadatas(DistributedDatabaseDistributedDatabaseShardDetailPeerDetailMetadataArgs.builder()
.map(Map.of("string", "string"))
.build())
.protectionMode("string")
.shardGroup("string")
.status("string")
.supportingResourceId("string")
.timeCreated("string")
.timeUpdated("string")
.transportType("string")
.build())
.kmsKeyId("string")
.shardGroup("string")
.kmsKeyVersionId("string")
.dbHomeId("string")
.status("string")
.supportingResourceId("string")
.timeCreated("string")
.timeUpdated("string")
.vaultId("string")
.containerDatabaseId("string")
.build())
.databaseVersion("string")
.privateEndpointIds("string")
.dbDeploymentType("string")
.prefix("string")
.displayName("string")
.onsPortRemote(0)
.onsPortLocal(0)
.listenerPortTls(0)
.dbBackupConfig(DistributedDatabaseDistributedDatabaseDbBackupConfigArgs.builder()
.autoBackupWindow("string")
.autoFullBackupDay("string")
.autoFullBackupWindow("string")
.backupDeletionPolicy("string")
.backupDestinationDetails(DistributedDatabaseDistributedDatabaseDbBackupConfigBackupDestinationDetailArgs.builder()
.type("string")
.dbrsPolicyId("string")
.id("string")
.internetProxy("string")
.isRemote(false)
.isZeroDataLossEnabled(false)
.remoteRegion("string")
.vpcPassword("string")
.vpcUser("string")
.build())
.canRunImmediateFullBackup(false)
.isAutoBackupEnabled(false)
.isRemoteBackupEnabled(false)
.recoveryWindowInDays(0)
.remoteRegion("string")
.build())
.generateWalletTrigger(0)
.gsmSshPublicKey("string")
.changeDbBackupConfigTrigger(0)
.configureShardingIsRebalanceRequired(false)
.freeformTags(Map.of("string", "string"))
.patchOperations(DistributedDatabaseDistributedDatabasePatchOperationArgs.builder()
.operation("string")
.selection("string")
.value("string")
.build())
.definedTags(Map.of("string", "string"))
.generateWalletPassword("string")
.replicationFactor(0)
.replicationMethod("string")
.replicationUnit(0)
.configureShardingTrigger(0)
.chunks(0)
.startDatabaseTrigger(0)
.state("string")
.stopDatabaseTrigger(0)
.validateNetworkDetails(DistributedDatabaseDistributedDatabaseValidateNetworkDetailsArgs.builder()
.isSurrogate(false)
.resourceName("string")
.shardGroup("string")
.build())
.validateNetworkTrigger(0)
.build());
distributed_database_distributed_database_resource = oci.oci.DistributedDatabaseDistributedDatabase("distributedDatabaseDistributedDatabaseResource",
listener_port=0,
catalog_details=[{
"admin_password": "string",
"vm_cluster_id": "string",
"source": "string",
"peer_vm_cluster_ids": ["string"],
"shard_space": "string",
"metadatas": [{
"map": {
"string": "string",
},
}],
"name": "string",
"peer_details": [{
"vm_cluster_id": "string",
"container_database_id": "string",
"metadatas": [{
"map": {
"string": "string",
},
}],
"protection_mode": "string",
"shard_group": "string",
"status": "string",
"supporting_resource_id": "string",
"time_created": "string",
"time_updated": "string",
"transport_type": "string",
}],
"kms_key_id": "string",
"shard_group": "string",
"kms_key_version_id": "string",
"db_home_id": "string",
"status": "string",
"supporting_resource_id": "string",
"time_created": "string",
"time_updated": "string",
"vault_id": "string",
"container_database_id": "string",
}],
character_set="string",
sharding_method="string",
compartment_id="string",
ncharacter_set="string",
shard_details=[{
"admin_password": "string",
"vm_cluster_id": "string",
"source": "string",
"peer_vm_cluster_ids": ["string"],
"shard_space": "string",
"metadatas": [{
"map": {
"string": "string",
},
}],
"name": "string",
"peer_details": [{
"vm_cluster_id": "string",
"container_database_id": "string",
"metadatas": [{
"map": {
"string": "string",
},
}],
"protection_mode": "string",
"shard_group": "string",
"status": "string",
"supporting_resource_id": "string",
"time_created": "string",
"time_updated": "string",
"transport_type": "string",
}],
"kms_key_id": "string",
"shard_group": "string",
"kms_key_version_id": "string",
"db_home_id": "string",
"status": "string",
"supporting_resource_id": "string",
"time_created": "string",
"time_updated": "string",
"vault_id": "string",
"container_database_id": "string",
}],
database_version="string",
private_endpoint_ids=["string"],
db_deployment_type="string",
prefix="string",
display_name="string",
ons_port_remote=0,
ons_port_local=0,
listener_port_tls=0,
db_backup_config={
"auto_backup_window": "string",
"auto_full_backup_day": "string",
"auto_full_backup_window": "string",
"backup_deletion_policy": "string",
"backup_destination_details": [{
"type": "string",
"dbrs_policy_id": "string",
"id": "string",
"internet_proxy": "string",
"is_remote": False,
"is_zero_data_loss_enabled": False,
"remote_region": "string",
"vpc_password": "string",
"vpc_user": "string",
}],
"can_run_immediate_full_backup": False,
"is_auto_backup_enabled": False,
"is_remote_backup_enabled": False,
"recovery_window_in_days": 0,
"remote_region": "string",
},
generate_wallet_trigger=0,
gsm_ssh_public_key="string",
change_db_backup_config_trigger=0,
configure_sharding_is_rebalance_required=False,
freeform_tags={
"string": "string",
},
patch_operations=[{
"operation": "string",
"selection": "string",
"value": "string",
}],
defined_tags={
"string": "string",
},
generate_wallet_password="string",
replication_factor=0,
replication_method="string",
replication_unit=0,
configure_sharding_trigger=0,
chunks=0,
start_database_trigger=0,
state="string",
stop_database_trigger=0,
validate_network_details={
"is_surrogate": False,
"resource_name": "string",
"shard_group": "string",
},
validate_network_trigger=0)
const distributedDatabaseDistributedDatabaseResource = new oci.oci.DistributedDatabaseDistributedDatabase("distributedDatabaseDistributedDatabaseResource", {
listenerPort: 0,
catalogDetails: [{
adminPassword: "string",
vmClusterId: "string",
source: "string",
peerVmClusterIds: ["string"],
shardSpace: "string",
metadatas: [{
map: {
string: "string",
},
}],
name: "string",
peerDetails: [{
vmClusterId: "string",
containerDatabaseId: "string",
metadatas: [{
map: {
string: "string",
},
}],
protectionMode: "string",
shardGroup: "string",
status: "string",
supportingResourceId: "string",
timeCreated: "string",
timeUpdated: "string",
transportType: "string",
}],
kmsKeyId: "string",
shardGroup: "string",
kmsKeyVersionId: "string",
dbHomeId: "string",
status: "string",
supportingResourceId: "string",
timeCreated: "string",
timeUpdated: "string",
vaultId: "string",
containerDatabaseId: "string",
}],
characterSet: "string",
shardingMethod: "string",
compartmentId: "string",
ncharacterSet: "string",
shardDetails: [{
adminPassword: "string",
vmClusterId: "string",
source: "string",
peerVmClusterIds: ["string"],
shardSpace: "string",
metadatas: [{
map: {
string: "string",
},
}],
name: "string",
peerDetails: [{
vmClusterId: "string",
containerDatabaseId: "string",
metadatas: [{
map: {
string: "string",
},
}],
protectionMode: "string",
shardGroup: "string",
status: "string",
supportingResourceId: "string",
timeCreated: "string",
timeUpdated: "string",
transportType: "string",
}],
kmsKeyId: "string",
shardGroup: "string",
kmsKeyVersionId: "string",
dbHomeId: "string",
status: "string",
supportingResourceId: "string",
timeCreated: "string",
timeUpdated: "string",
vaultId: "string",
containerDatabaseId: "string",
}],
databaseVersion: "string",
privateEndpointIds: ["string"],
dbDeploymentType: "string",
prefix: "string",
displayName: "string",
onsPortRemote: 0,
onsPortLocal: 0,
listenerPortTls: 0,
dbBackupConfig: {
autoBackupWindow: "string",
autoFullBackupDay: "string",
autoFullBackupWindow: "string",
backupDeletionPolicy: "string",
backupDestinationDetails: [{
type: "string",
dbrsPolicyId: "string",
id: "string",
internetProxy: "string",
isRemote: false,
isZeroDataLossEnabled: false,
remoteRegion: "string",
vpcPassword: "string",
vpcUser: "string",
}],
canRunImmediateFullBackup: false,
isAutoBackupEnabled: false,
isRemoteBackupEnabled: false,
recoveryWindowInDays: 0,
remoteRegion: "string",
},
generateWalletTrigger: 0,
gsmSshPublicKey: "string",
changeDbBackupConfigTrigger: 0,
configureShardingIsRebalanceRequired: false,
freeformTags: {
string: "string",
},
patchOperations: [{
operation: "string",
selection: "string",
value: "string",
}],
definedTags: {
string: "string",
},
generateWalletPassword: "string",
replicationFactor: 0,
replicationMethod: "string",
replicationUnit: 0,
configureShardingTrigger: 0,
chunks: 0,
startDatabaseTrigger: 0,
state: "string",
stopDatabaseTrigger: 0,
validateNetworkDetails: {
isSurrogate: false,
resourceName: "string",
shardGroup: "string",
},
validateNetworkTrigger: 0,
});
type: oci:oci:DistributedDatabaseDistributedDatabase
properties:
catalogDetails:
- adminPassword: string
containerDatabaseId: string
dbHomeId: string
kmsKeyId: string
kmsKeyVersionId: string
metadatas:
- map:
string: string
name: string
peerDetails:
- containerDatabaseId: string
metadatas:
- map:
string: string
protectionMode: string
shardGroup: string
status: string
supportingResourceId: string
timeCreated: string
timeUpdated: string
transportType: string
vmClusterId: string
peerVmClusterIds:
- string
shardGroup: string
shardSpace: string
source: string
status: string
supportingResourceId: string
timeCreated: string
timeUpdated: string
vaultId: string
vmClusterId: string
changeDbBackupConfigTrigger: 0
characterSet: string
chunks: 0
compartmentId: string
configureShardingIsRebalanceRequired: false
configureShardingTrigger: 0
databaseVersion: string
dbBackupConfig:
autoBackupWindow: string
autoFullBackupDay: string
autoFullBackupWindow: string
backupDeletionPolicy: string
backupDestinationDetails:
- dbrsPolicyId: string
id: string
internetProxy: string
isRemote: false
isZeroDataLossEnabled: false
remoteRegion: string
type: string
vpcPassword: string
vpcUser: string
canRunImmediateFullBackup: false
isAutoBackupEnabled: false
isRemoteBackupEnabled: false
recoveryWindowInDays: 0
remoteRegion: string
dbDeploymentType: string
definedTags:
string: string
displayName: string
freeformTags:
string: string
generateWalletPassword: string
generateWalletTrigger: 0
gsmSshPublicKey: string
listenerPort: 0
listenerPortTls: 0
ncharacterSet: string
onsPortLocal: 0
onsPortRemote: 0
patchOperations:
- operation: string
selection: string
value: string
prefix: string
privateEndpointIds:
- string
replicationFactor: 0
replicationMethod: string
replicationUnit: 0
shardDetails:
- adminPassword: string
containerDatabaseId: string
dbHomeId: string
kmsKeyId: string
kmsKeyVersionId: string
metadatas:
- map:
string: string
name: string
peerDetails:
- containerDatabaseId: string
metadatas:
- map:
string: string
protectionMode: string
shardGroup: string
status: string
supportingResourceId: string
timeCreated: string
timeUpdated: string
transportType: string
vmClusterId: string
peerVmClusterIds:
- string
shardGroup: string
shardSpace: string
source: string
status: string
supportingResourceId: string
timeCreated: string
timeUpdated: string
vaultId: string
vmClusterId: string
shardingMethod: string
startDatabaseTrigger: 0
state: string
stopDatabaseTrigger: 0
validateNetworkDetails:
isSurrogate: false
resourceName: string
shardGroup: string
validateNetworkTrigger: 0
DistributedDatabaseDistributedDatabase 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 DistributedDatabaseDistributedDatabase resource accepts the following input properties:
- Catalog
Details List<DistributedDatabase Distributed Database Catalog Detail> - Collection of catalog for the Globally distributed database.
- Character
Set string - The character set for the database.
- Compartment
Id string - (Updatable) The OCID of the Globally distributed database compartment.
- Database
Version string - Oracle Database version for the shards and catalog used in Globally distributed database.
- Db
Deployment stringType - The distributed database deployment type.
- Display
Name string - (Updatable) The display name of the Globally distributed database.
- Listener
Port int - The listener port number for the Globally distributed database. The listener port number has to be unique for a customer tenancy across all distributed databases. Same port number should not be re-used for any other distributed database.
- Ncharacter
Set string - The national character set for the database.
- Ons
Port intLocal - The ons local port number for the Globally distributed database. The onsPortLocal has to be unique for a customer tenancy across all distributed databases. Same port number should not be re-used for any other distributed database.
- Ons
Port intRemote - The ons remote port number for the Globally distributed database. The onsPortRemote has to be unique for a customer tenancy across all distributed databases. Same port number should not be re-used for any other distributed database.
- Prefix string
- Unique name prefix for the Globally distributed databases. Only alpha-numeric values are allowed. First character has to be a letter followed by any combination of letter and number.
- Private
Endpoint List<string>Ids - The collection of OCID of the private endpoint associated with Globally distributed autonomous database.
-
List<Distributed
Database Distributed Database Shard Detail> - Collection of shards for the Globally distributed database.
- string
- Sharding Methods for the Globally distributed database.
- Change
Db intBackup Config Trigger - (Updatable) An optional property when incremented triggers Change Db Backup Config. Could be set to any integer value.
- Chunks int
- Number of chunks in a shardspace. The value of chunks must be greater than 2 times the size of the largest shardgroup in any shardspace. Chunks is required to be provided for distributed databases being created with SYSTEM shardingMethod. For USER shardingMethod, chunks should not be set in create payload.
- Configure
Sharding boolIs Rebalance Required - Configure
Sharding intTrigger - (Updatable) An optional property when incremented triggers Configure Sharding. Could be set to any integer value.
- Db
Backup DistributedConfig Database Distributed Database Db Backup Config - 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.
- Dictionary<string, string>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"} - Download
Gsm intCertificate Signing Request Trigger - (Updatable) An optional property when incremented triggers Download Gsm Certificate Signing Request. Could be set to any integer value.
- Dictionary<string, string>
- (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example:
{"bar-key": "value"} - Generate
Gsm intCertificate Signing Request Trigger - (Updatable) An optional property when incremented triggers Generate Gsm Certificate Signing Request. Could be set to any integer value.
- Generate
Wallet stringPassword - Generate
Wallet intTrigger - (Updatable) An optional property when incremented triggers Generate Wallet. Could be set to any integer value.
- Gsm
Ssh stringPublic Key - The SSH public key for Global service manager instances.
- Listener
Port intTls - The TLS listener port number for the Globally distributed database. The TLS listener port number has to be unique for a customer tenancy across all distributed databases. Same port number should not be re-used for any other distributed database. For BASE_DB and EXADB_XS based distributed databases, tls is not supported hence the listenerPortTls is not needed to be provided in create payload.
- Patch
Operations List<DistributedDatabase Distributed Database Patch Operation> - (Updatable)
- Replication
Factor int - The Replication factor for RAFT replication based Globally distributed database. Currently supported values are 3, 5 and 7.
- Replication
Method string - The Replication method for Globally distributed database. Use RAFT for Raft based replication. With RAFT replication, shards cannot have peers details set on them. In case shards need to have peers, please do not set RAFT replicationMethod. For all non RAFT replication cases (with or without peers), please set replicationMethod as DG or do not set any value for replicationMethod.
- Replication
Unit int - The replication unit count for RAFT based distributed database. For RAFT replication based Globally distributed database, the value should be at least twice the number of shards.
- Start
Database intTrigger - Increment this value to trigger StartDistributedDatabase action.
- State string
- (Updatable) The target state for the Distributed Database. Could be set to
ACTIVEorINACTIVE. - Stop
Database intTrigger - Increment this value to trigger StopDistributedDatabase action.
- Upload
Signed intCertificate And Generate Wallet Trigger - (Updatable) An optional property when incremented triggers Upload Signed Certificate And Generate Wallet. Could be set to any integer value.
- Validate
Network DistributedDetails Database Distributed Database Validate Network Details - Validate
Network intTrigger (Updatable) An optional property when incremented triggers Validate Network. Could be set to any integer value.
** 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
- Catalog
Details []DistributedDatabase Distributed Database Catalog Detail Args - Collection of catalog for the Globally distributed database.
- Character
Set string - The character set for the database.
- Compartment
Id string - (Updatable) The OCID of the Globally distributed database compartment.
- Database
Version string - Oracle Database version for the shards and catalog used in Globally distributed database.
- Db
Deployment stringType - The distributed database deployment type.
- Display
Name string - (Updatable) The display name of the Globally distributed database.
- Listener
Port int - The listener port number for the Globally distributed database. The listener port number has to be unique for a customer tenancy across all distributed databases. Same port number should not be re-used for any other distributed database.
- Ncharacter
Set string - The national character set for the database.
- Ons
Port intLocal - The ons local port number for the Globally distributed database. The onsPortLocal has to be unique for a customer tenancy across all distributed databases. Same port number should not be re-used for any other distributed database.
- Ons
Port intRemote - The ons remote port number for the Globally distributed database. The onsPortRemote has to be unique for a customer tenancy across all distributed databases. Same port number should not be re-used for any other distributed database.
- Prefix string
- Unique name prefix for the Globally distributed databases. Only alpha-numeric values are allowed. First character has to be a letter followed by any combination of letter and number.
- Private
Endpoint []stringIds - The collection of OCID of the private endpoint associated with Globally distributed autonomous database.
-
[]Distributed
Database Distributed Database Shard Detail Args - Collection of shards for the Globally distributed database.
- string
- Sharding Methods for the Globally distributed database.
- Change
Db intBackup Config Trigger - (Updatable) An optional property when incremented triggers Change Db Backup Config. Could be set to any integer value.
- Chunks int
- Number of chunks in a shardspace. The value of chunks must be greater than 2 times the size of the largest shardgroup in any shardspace. Chunks is required to be provided for distributed databases being created with SYSTEM shardingMethod. For USER shardingMethod, chunks should not be set in create payload.
- Configure
Sharding boolIs Rebalance Required - Configure
Sharding intTrigger - (Updatable) An optional property when incremented triggers Configure Sharding. Could be set to any integer value.
- Db
Backup DistributedConfig Database Distributed Database Db Backup Config Args - 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.
- map[string]string
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"} - Download
Gsm intCertificate Signing Request Trigger - (Updatable) An optional property when incremented triggers Download Gsm Certificate Signing Request. Could be set to any integer value.
- map[string]string
- (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example:
{"bar-key": "value"} - Generate
Gsm intCertificate Signing Request Trigger - (Updatable) An optional property when incremented triggers Generate Gsm Certificate Signing Request. Could be set to any integer value.
- Generate
Wallet stringPassword - Generate
Wallet intTrigger - (Updatable) An optional property when incremented triggers Generate Wallet. Could be set to any integer value.
- Gsm
Ssh stringPublic Key - The SSH public key for Global service manager instances.
- Listener
Port intTls - The TLS listener port number for the Globally distributed database. The TLS listener port number has to be unique for a customer tenancy across all distributed databases. Same port number should not be re-used for any other distributed database. For BASE_DB and EXADB_XS based distributed databases, tls is not supported hence the listenerPortTls is not needed to be provided in create payload.
- Patch
Operations []DistributedDatabase Distributed Database Patch Operation Args - (Updatable)
- Replication
Factor int - The Replication factor for RAFT replication based Globally distributed database. Currently supported values are 3, 5 and 7.
- Replication
Method string - The Replication method for Globally distributed database. Use RAFT for Raft based replication. With RAFT replication, shards cannot have peers details set on them. In case shards need to have peers, please do not set RAFT replicationMethod. For all non RAFT replication cases (with or without peers), please set replicationMethod as DG or do not set any value for replicationMethod.
- Replication
Unit int - The replication unit count for RAFT based distributed database. For RAFT replication based Globally distributed database, the value should be at least twice the number of shards.
- Start
Database intTrigger - Increment this value to trigger StartDistributedDatabase action.
- State string
- (Updatable) The target state for the Distributed Database. Could be set to
ACTIVEorINACTIVE. - Stop
Database intTrigger - Increment this value to trigger StopDistributedDatabase action.
- Upload
Signed intCertificate And Generate Wallet Trigger - (Updatable) An optional property when incremented triggers Upload Signed Certificate And Generate Wallet. Could be set to any integer value.
- Validate
Network DistributedDetails Database Distributed Database Validate Network Details Args - Validate
Network intTrigger (Updatable) An optional property when incremented triggers Validate Network. Could be set to any integer value.
** 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
- catalog
Details List<DistributedDatabase Distributed Database Catalog Detail> - Collection of catalog for the Globally distributed database.
- character
Set String - The character set for the database.
- compartment
Id String - (Updatable) The OCID of the Globally distributed database compartment.
- database
Version String - Oracle Database version for the shards and catalog used in Globally distributed database.
- db
Deployment StringType - The distributed database deployment type.
- display
Name String - (Updatable) The display name of the Globally distributed database.
- listener
Port Integer - The listener port number for the Globally distributed database. The listener port number has to be unique for a customer tenancy across all distributed databases. Same port number should not be re-used for any other distributed database.
- ncharacter
Set String - The national character set for the database.
- ons
Port IntegerLocal - The ons local port number for the Globally distributed database. The onsPortLocal has to be unique for a customer tenancy across all distributed databases. Same port number should not be re-used for any other distributed database.
- ons
Port IntegerRemote - The ons remote port number for the Globally distributed database. The onsPortRemote has to be unique for a customer tenancy across all distributed databases. Same port number should not be re-used for any other distributed database.
- prefix String
- Unique name prefix for the Globally distributed databases. Only alpha-numeric values are allowed. First character has to be a letter followed by any combination of letter and number.
- private
Endpoint List<String>Ids - The collection of OCID of the private endpoint associated with Globally distributed autonomous database.
-
List<Distributed
Database Distributed Database Shard Detail> - Collection of shards for the Globally distributed database.
- String
- Sharding Methods for the Globally distributed database.
- change
Db IntegerBackup Config Trigger - (Updatable) An optional property when incremented triggers Change Db Backup Config. Could be set to any integer value.
- chunks Integer
- Number of chunks in a shardspace. The value of chunks must be greater than 2 times the size of the largest shardgroup in any shardspace. Chunks is required to be provided for distributed databases being created with SYSTEM shardingMethod. For USER shardingMethod, chunks should not be set in create payload.
- configure
Sharding BooleanIs Rebalance Required - configure
Sharding IntegerTrigger - (Updatable) An optional property when incremented triggers Configure Sharding. Could be set to any integer value.
- db
Backup DistributedConfig Database Distributed Database Db Backup Config - 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.
- Map<String,String>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"} - download
Gsm IntegerCertificate Signing Request Trigger - (Updatable) An optional property when incremented triggers Download Gsm Certificate Signing Request. Could be set to any integer value.
- Map<String,String>
- (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example:
{"bar-key": "value"} - generate
Gsm IntegerCertificate Signing Request Trigger - (Updatable) An optional property when incremented triggers Generate Gsm Certificate Signing Request. Could be set to any integer value.
- generate
Wallet StringPassword - generate
Wallet IntegerTrigger - (Updatable) An optional property when incremented triggers Generate Wallet. Could be set to any integer value.
- gsm
Ssh StringPublic Key - The SSH public key for Global service manager instances.
- listener
Port IntegerTls - The TLS listener port number for the Globally distributed database. The TLS listener port number has to be unique for a customer tenancy across all distributed databases. Same port number should not be re-used for any other distributed database. For BASE_DB and EXADB_XS based distributed databases, tls is not supported hence the listenerPortTls is not needed to be provided in create payload.
- patch
Operations List<DistributedDatabase Distributed Database Patch Operation> - (Updatable)
- replication
Factor Integer - The Replication factor for RAFT replication based Globally distributed database. Currently supported values are 3, 5 and 7.
- replication
Method String - The Replication method for Globally distributed database. Use RAFT for Raft based replication. With RAFT replication, shards cannot have peers details set on them. In case shards need to have peers, please do not set RAFT replicationMethod. For all non RAFT replication cases (with or without peers), please set replicationMethod as DG or do not set any value for replicationMethod.
- replication
Unit Integer - The replication unit count for RAFT based distributed database. For RAFT replication based Globally distributed database, the value should be at least twice the number of shards.
- start
Database IntegerTrigger - Increment this value to trigger StartDistributedDatabase action.
- state String
- (Updatable) The target state for the Distributed Database. Could be set to
ACTIVEorINACTIVE. - stop
Database IntegerTrigger - Increment this value to trigger StopDistributedDatabase action.
- upload
Signed IntegerCertificate And Generate Wallet Trigger - (Updatable) An optional property when incremented triggers Upload Signed Certificate And Generate Wallet. Could be set to any integer value.
- validate
Network DistributedDetails Database Distributed Database Validate Network Details - validate
Network IntegerTrigger (Updatable) An optional property when incremented triggers Validate Network. Could be set to any integer value.
** 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
- catalog
Details DistributedDatabase Distributed Database Catalog Detail[] - Collection of catalog for the Globally distributed database.
- character
Set string - The character set for the database.
- compartment
Id string - (Updatable) The OCID of the Globally distributed database compartment.
- database
Version string - Oracle Database version for the shards and catalog used in Globally distributed database.
- db
Deployment stringType - The distributed database deployment type.
- display
Name string - (Updatable) The display name of the Globally distributed database.
- listener
Port number - The listener port number for the Globally distributed database. The listener port number has to be unique for a customer tenancy across all distributed databases. Same port number should not be re-used for any other distributed database.
- ncharacter
Set string - The national character set for the database.
- ons
Port numberLocal - The ons local port number for the Globally distributed database. The onsPortLocal has to be unique for a customer tenancy across all distributed databases. Same port number should not be re-used for any other distributed database.
- ons
Port numberRemote - The ons remote port number for the Globally distributed database. The onsPortRemote has to be unique for a customer tenancy across all distributed databases. Same port number should not be re-used for any other distributed database.
- prefix string
- Unique name prefix for the Globally distributed databases. Only alpha-numeric values are allowed. First character has to be a letter followed by any combination of letter and number.
- private
Endpoint string[]Ids - The collection of OCID of the private endpoint associated with Globally distributed autonomous database.
-
Distributed
Database Distributed Database Shard Detail[] - Collection of shards for the Globally distributed database.
- string
- Sharding Methods for the Globally distributed database.
- change
Db numberBackup Config Trigger - (Updatable) An optional property when incremented triggers Change Db Backup Config. Could be set to any integer value.
- chunks number
- Number of chunks in a shardspace. The value of chunks must be greater than 2 times the size of the largest shardgroup in any shardspace. Chunks is required to be provided for distributed databases being created with SYSTEM shardingMethod. For USER shardingMethod, chunks should not be set in create payload.
- configure
Sharding booleanIs Rebalance Required - configure
Sharding numberTrigger - (Updatable) An optional property when incremented triggers Configure Sharding. Could be set to any integer value.
- db
Backup DistributedConfig Database Distributed Database Db Backup Config - 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.
- {[key: string]: string}
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"} - download
Gsm numberCertificate Signing Request Trigger - (Updatable) An optional property when incremented triggers Download Gsm Certificate Signing Request. Could be set to any integer value.
- {[key: string]: string}
- (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example:
{"bar-key": "value"} - generate
Gsm numberCertificate Signing Request Trigger - (Updatable) An optional property when incremented triggers Generate Gsm Certificate Signing Request. Could be set to any integer value.
- generate
Wallet stringPassword - generate
Wallet numberTrigger - (Updatable) An optional property when incremented triggers Generate Wallet. Could be set to any integer value.
- gsm
Ssh stringPublic Key - The SSH public key for Global service manager instances.
- listener
Port numberTls - The TLS listener port number for the Globally distributed database. The TLS listener port number has to be unique for a customer tenancy across all distributed databases. Same port number should not be re-used for any other distributed database. For BASE_DB and EXADB_XS based distributed databases, tls is not supported hence the listenerPortTls is not needed to be provided in create payload.
- patch
Operations DistributedDatabase Distributed Database Patch Operation[] - (Updatable)
- replication
Factor number - The Replication factor for RAFT replication based Globally distributed database. Currently supported values are 3, 5 and 7.
- replication
Method string - The Replication method for Globally distributed database. Use RAFT for Raft based replication. With RAFT replication, shards cannot have peers details set on them. In case shards need to have peers, please do not set RAFT replicationMethod. For all non RAFT replication cases (with or without peers), please set replicationMethod as DG or do not set any value for replicationMethod.
- replication
Unit number - The replication unit count for RAFT based distributed database. For RAFT replication based Globally distributed database, the value should be at least twice the number of shards.
- start
Database numberTrigger - Increment this value to trigger StartDistributedDatabase action.
- state string
- (Updatable) The target state for the Distributed Database. Could be set to
ACTIVEorINACTIVE. - stop
Database numberTrigger - Increment this value to trigger StopDistributedDatabase action.
- upload
Signed numberCertificate And Generate Wallet Trigger - (Updatable) An optional property when incremented triggers Upload Signed Certificate And Generate Wallet. Could be set to any integer value.
- validate
Network DistributedDetails Database Distributed Database Validate Network Details - validate
Network numberTrigger (Updatable) An optional property when incremented triggers Validate Network. Could be set to any integer value.
** 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
- catalog_
details Sequence[DistributedDatabase Distributed Database Catalog Detail Args] - Collection of catalog for the Globally distributed database.
- character_
set str - The character set for the database.
- compartment_
id str - (Updatable) The OCID of the Globally distributed database compartment.
- database_
version str - Oracle Database version for the shards and catalog used in Globally distributed database.
- db_
deployment_ strtype - The distributed database deployment type.
- display_
name str - (Updatable) The display name of the Globally distributed database.
- listener_
port int - The listener port number for the Globally distributed database. The listener port number has to be unique for a customer tenancy across all distributed databases. Same port number should not be re-used for any other distributed database.
- ncharacter_
set str - The national character set for the database.
- ons_
port_ intlocal - The ons local port number for the Globally distributed database. The onsPortLocal has to be unique for a customer tenancy across all distributed databases. Same port number should not be re-used for any other distributed database.
- ons_
port_ intremote - The ons remote port number for the Globally distributed database. The onsPortRemote has to be unique for a customer tenancy across all distributed databases. Same port number should not be re-used for any other distributed database.
- prefix str
- Unique name prefix for the Globally distributed databases. Only alpha-numeric values are allowed. First character has to be a letter followed by any combination of letter and number.
- private_
endpoint_ Sequence[str]ids - The collection of OCID of the private endpoint associated with Globally distributed autonomous database.
-
Sequence[Distributed
Database Distributed Database Shard Detail Args] - Collection of shards for the Globally distributed database.
- str
- Sharding Methods for the Globally distributed database.
- change_
db_ intbackup_ config_ trigger - (Updatable) An optional property when incremented triggers Change Db Backup Config. Could be set to any integer value.
- chunks int
- Number of chunks in a shardspace. The value of chunks must be greater than 2 times the size of the largest shardgroup in any shardspace. Chunks is required to be provided for distributed databases being created with SYSTEM shardingMethod. For USER shardingMethod, chunks should not be set in create payload.
- configure_
sharding_ boolis_ rebalance_ required - configure_
sharding_ inttrigger - (Updatable) An optional property when incremented triggers Configure Sharding. Could be set to any integer value.
- db_
backup_ Distributedconfig Database Distributed Database Db Backup Config Args - 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.
- Mapping[str, str]
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"} - download_
gsm_ intcertificate_ signing_ request_ trigger - (Updatable) An optional property when incremented triggers Download Gsm Certificate Signing Request. Could be set to any integer value.
- Mapping[str, str]
- (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example:
{"bar-key": "value"} - generate_
gsm_ intcertificate_ signing_ request_ trigger - (Updatable) An optional property when incremented triggers Generate Gsm Certificate Signing Request. Could be set to any integer value.
- generate_
wallet_ strpassword - generate_
wallet_ inttrigger - (Updatable) An optional property when incremented triggers Generate Wallet. Could be set to any integer value.
- gsm_
ssh_ strpublic_ key - The SSH public key for Global service manager instances.
- listener_
port_ inttls - The TLS listener port number for the Globally distributed database. The TLS listener port number has to be unique for a customer tenancy across all distributed databases. Same port number should not be re-used for any other distributed database. For BASE_DB and EXADB_XS based distributed databases, tls is not supported hence the listenerPortTls is not needed to be provided in create payload.
- patch_
operations Sequence[DistributedDatabase Distributed Database Patch Operation Args] - (Updatable)
- replication_
factor int - The Replication factor for RAFT replication based Globally distributed database. Currently supported values are 3, 5 and 7.
- replication_
method str - The Replication method for Globally distributed database. Use RAFT for Raft based replication. With RAFT replication, shards cannot have peers details set on them. In case shards need to have peers, please do not set RAFT replicationMethod. For all non RAFT replication cases (with or without peers), please set replicationMethod as DG or do not set any value for replicationMethod.
- replication_
unit int - The replication unit count for RAFT based distributed database. For RAFT replication based Globally distributed database, the value should be at least twice the number of shards.
- start_
database_ inttrigger - Increment this value to trigger StartDistributedDatabase action.
- state str
- (Updatable) The target state for the Distributed Database. Could be set to
ACTIVEorINACTIVE. - stop_
database_ inttrigger - Increment this value to trigger StopDistributedDatabase action.
- upload_
signed_ intcertificate_ and_ generate_ wallet_ trigger - (Updatable) An optional property when incremented triggers Upload Signed Certificate And Generate Wallet. Could be set to any integer value.
- validate_
network_ Distributeddetails Database Distributed Database Validate Network Details Args - validate_
network_ inttrigger (Updatable) An optional property when incremented triggers Validate Network. Could be set to any integer value.
** 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
- catalog
Details List<Property Map> - Collection of catalog for the Globally distributed database.
- character
Set String - The character set for the database.
- compartment
Id String - (Updatable) The OCID of the Globally distributed database compartment.
- database
Version String - Oracle Database version for the shards and catalog used in Globally distributed database.
- db
Deployment StringType - The distributed database deployment type.
- display
Name String - (Updatable) The display name of the Globally distributed database.
- listener
Port Number - The listener port number for the Globally distributed database. The listener port number has to be unique for a customer tenancy across all distributed databases. Same port number should not be re-used for any other distributed database.
- ncharacter
Set String - The national character set for the database.
- ons
Port NumberLocal - The ons local port number for the Globally distributed database. The onsPortLocal has to be unique for a customer tenancy across all distributed databases. Same port number should not be re-used for any other distributed database.
- ons
Port NumberRemote - The ons remote port number for the Globally distributed database. The onsPortRemote has to be unique for a customer tenancy across all distributed databases. Same port number should not be re-used for any other distributed database.
- prefix String
- Unique name prefix for the Globally distributed databases. Only alpha-numeric values are allowed. First character has to be a letter followed by any combination of letter and number.
- private
Endpoint List<String>Ids - The collection of OCID of the private endpoint associated with Globally distributed autonomous database.
- List<Property Map>
- Collection of shards for the Globally distributed database.
- String
- Sharding Methods for the Globally distributed database.
- change
Db NumberBackup Config Trigger - (Updatable) An optional property when incremented triggers Change Db Backup Config. Could be set to any integer value.
- chunks Number
- Number of chunks in a shardspace. The value of chunks must be greater than 2 times the size of the largest shardgroup in any shardspace. Chunks is required to be provided for distributed databases being created with SYSTEM shardingMethod. For USER shardingMethod, chunks should not be set in create payload.
- configure
Sharding BooleanIs Rebalance Required - configure
Sharding NumberTrigger - (Updatable) An optional property when incremented triggers Configure Sharding. Could be set to any integer value.
- db
Backup Property MapConfig - 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.
- Map<String>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"} - download
Gsm NumberCertificate Signing Request Trigger - (Updatable) An optional property when incremented triggers Download Gsm Certificate Signing Request. Could be set to any integer value.
- Map<String>
- (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example:
{"bar-key": "value"} - generate
Gsm NumberCertificate Signing Request Trigger - (Updatable) An optional property when incremented triggers Generate Gsm Certificate Signing Request. Could be set to any integer value.
- generate
Wallet StringPassword - generate
Wallet NumberTrigger - (Updatable) An optional property when incremented triggers Generate Wallet. Could be set to any integer value.
- gsm
Ssh StringPublic Key - The SSH public key for Global service manager instances.
- listener
Port NumberTls - The TLS listener port number for the Globally distributed database. The TLS listener port number has to be unique for a customer tenancy across all distributed databases. Same port number should not be re-used for any other distributed database. For BASE_DB and EXADB_XS based distributed databases, tls is not supported hence the listenerPortTls is not needed to be provided in create payload.
- patch
Operations List<Property Map> - (Updatable)
- replication
Factor Number - The Replication factor for RAFT replication based Globally distributed database. Currently supported values are 3, 5 and 7.
- replication
Method String - The Replication method for Globally distributed database. Use RAFT for Raft based replication. With RAFT replication, shards cannot have peers details set on them. In case shards need to have peers, please do not set RAFT replicationMethod. For all non RAFT replication cases (with or without peers), please set replicationMethod as DG or do not set any value for replicationMethod.
- replication
Unit Number - The replication unit count for RAFT based distributed database. For RAFT replication based Globally distributed database, the value should be at least twice the number of shards.
- start
Database NumberTrigger - Increment this value to trigger StartDistributedDatabase action.
- state String
- (Updatable) The target state for the Distributed Database. Could be set to
ACTIVEorINACTIVE. - stop
Database NumberTrigger - Increment this value to trigger StopDistributedDatabase action.
- upload
Signed NumberCertificate And Generate Wallet Trigger - (Updatable) An optional property when incremented triggers Upload Signed Certificate And Generate Wallet. Could be set to any integer value.
- validate
Network Property MapDetails - validate
Network NumberTrigger (Updatable) An optional property when incremented triggers Validate Network. Could be set to any integer value.
** 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
Outputs
All input properties are implicitly available as output properties. Additionally, the DistributedDatabaseDistributedDatabase resource produces the following output properties:
- Connection
Strings List<DistributedDatabase Distributed Database Connection String> - Details of Globally distributed database connection String.
- Generate
Wallet intDownloaded Wallet Content Length - Generate
Wallet stringDownloaded Wallet Etag - Generate
Wallet stringDownloaded Wallet Last Modified - Generate
Wallet stringDownloaded Wallet Zip Base64 - Gsm
Details List<DistributedDatabase Distributed Database Gsm Detail> - Collection of catalogs associated with the Globally distributed database.
- Id string
- The provider-assigned unique ID for this managed resource.
- Latest
Gsm List<DistributedImage Details Database Distributed Database Latest Gsm Image Detail> - The Global service manager image details
- Lifecycle
Details string - The lifecycleDetails for the Globally distributed database.
- Metadatas
List<Distributed
Database Distributed Database Metadata> - Additional metadata related to Globally distributed database resources.
- Dictionary<string, string>
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example:
{"orcl-cloud.free-tier-retained": "true"} - Time
Created string - The time the Globally distributed database was created. An RFC3339 formatted datetime string
- Time
Updated string - The time the Globally distributed database was last updated. An RFC3339 formatted datetime string
- Connection
Strings []DistributedDatabase Distributed Database Connection String - Details of Globally distributed database connection String.
- Generate
Wallet intDownloaded Wallet Content Length - Generate
Wallet stringDownloaded Wallet Etag - Generate
Wallet stringDownloaded Wallet Last Modified - Generate
Wallet stringDownloaded Wallet Zip Base64 - Gsm
Details []DistributedDatabase Distributed Database Gsm Detail - Collection of catalogs associated with the Globally distributed database.
- Id string
- The provider-assigned unique ID for this managed resource.
- Latest
Gsm []DistributedImage Details Database Distributed Database Latest Gsm Image Detail - The Global service manager image details
- Lifecycle
Details string - The lifecycleDetails for the Globally distributed database.
- Metadatas
[]Distributed
Database Distributed Database Metadata - Additional metadata related to Globally distributed database resources.
- map[string]string
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example:
{"orcl-cloud.free-tier-retained": "true"} - Time
Created string - The time the Globally distributed database was created. An RFC3339 formatted datetime string
- Time
Updated string - The time the Globally distributed database was last updated. An RFC3339 formatted datetime string
- connection
Strings List<DistributedDatabase Distributed Database Connection String> - Details of Globally distributed database connection String.
- generate
Wallet IntegerDownloaded Wallet Content Length - generate
Wallet StringDownloaded Wallet Etag - generate
Wallet StringDownloaded Wallet Last Modified - generate
Wallet StringDownloaded Wallet Zip Base64 - gsm
Details List<DistributedDatabase Distributed Database Gsm Detail> - Collection of catalogs associated with the Globally distributed database.
- id String
- The provider-assigned unique ID for this managed resource.
- latest
Gsm List<DistributedImage Details Database Distributed Database Latest Gsm Image Detail> - The Global service manager image details
- lifecycle
Details String - The lifecycleDetails for the Globally distributed database.
- metadatas
List<Distributed
Database Distributed Database Metadata> - Additional metadata related to Globally distributed database resources.
- Map<String,String>
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example:
{"orcl-cloud.free-tier-retained": "true"} - time
Created String - The time the Globally distributed database was created. An RFC3339 formatted datetime string
- time
Updated String - The time the Globally distributed database was last updated. An RFC3339 formatted datetime string
- connection
Strings DistributedDatabase Distributed Database Connection String[] - Details of Globally distributed database connection String.
- generate
Wallet numberDownloaded Wallet Content Length - generate
Wallet stringDownloaded Wallet Etag - generate
Wallet stringDownloaded Wallet Last Modified - generate
Wallet stringDownloaded Wallet Zip Base64 - gsm
Details DistributedDatabase Distributed Database Gsm Detail[] - Collection of catalogs associated with the Globally distributed database.
- id string
- The provider-assigned unique ID for this managed resource.
- latest
Gsm DistributedImage Details Database Distributed Database Latest Gsm Image Detail[] - The Global service manager image details
- lifecycle
Details string - The lifecycleDetails for the Globally distributed database.
- metadatas
Distributed
Database Distributed Database Metadata[] - Additional metadata related to Globally distributed database resources.
- {[key: string]: string}
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example:
{"orcl-cloud.free-tier-retained": "true"} - time
Created string - The time the Globally distributed database was created. An RFC3339 formatted datetime string
- time
Updated string - The time the Globally distributed database was last updated. An RFC3339 formatted datetime string
- connection_
strings Sequence[DistributedDatabase Distributed Database Connection String] - Details of Globally distributed database connection String.
- generate_
wallet_ intdownloaded_ wallet_ content_ length - generate_
wallet_ strdownloaded_ wallet_ etag - generate_
wallet_ strdownloaded_ wallet_ last_ modified - generate_
wallet_ strdownloaded_ wallet_ zip_ base64 - gsm_
details Sequence[DistributedDatabase Distributed Database Gsm Detail] - Collection of catalogs associated with the Globally distributed database.
- id str
- The provider-assigned unique ID for this managed resource.
- latest_
gsm_ Sequence[Distributedimage_ details Database Distributed Database Latest Gsm Image Detail] - The Global service manager image details
- lifecycle_
details str - The lifecycleDetails for the Globally distributed database.
- metadatas
Sequence[Distributed
Database Distributed Database Metadata] - Additional metadata related to Globally distributed database resources.
- Mapping[str, str]
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example:
{"orcl-cloud.free-tier-retained": "true"} - time_
created str - The time the Globally distributed database was created. An RFC3339 formatted datetime string
- time_
updated str - The time the Globally distributed database was last updated. An RFC3339 formatted datetime string
- connection
Strings List<Property Map> - Details of Globally distributed database connection String.
- generate
Wallet NumberDownloaded Wallet Content Length - generate
Wallet StringDownloaded Wallet Etag - generate
Wallet StringDownloaded Wallet Last Modified - generate
Wallet StringDownloaded Wallet Zip Base64 - gsm
Details List<Property Map> - Collection of catalogs associated with the Globally distributed database.
- id String
- The provider-assigned unique ID for this managed resource.
- latest
Gsm List<Property Map>Image Details - The Global service manager image details
- lifecycle
Details String - The lifecycleDetails for the Globally distributed database.
- metadatas List<Property Map>
- Additional metadata related to Globally distributed database resources.
- Map<String>
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example:
{"orcl-cloud.free-tier-retained": "true"} - time
Created String - The time the Globally distributed database was created. An RFC3339 formatted datetime string
- time
Updated String - The time the Globally distributed database was last updated. An RFC3339 formatted datetime string
Look up Existing DistributedDatabaseDistributedDatabase Resource
Get an existing DistributedDatabaseDistributedDatabase 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?: DistributedDatabaseDistributedDatabaseState, opts?: CustomResourceOptions): DistributedDatabaseDistributedDatabase@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
catalog_details: Optional[Sequence[DistributedDatabaseDistributedDatabaseCatalogDetailArgs]] = None,
change_db_backup_config_trigger: Optional[int] = None,
character_set: Optional[str] = None,
chunks: Optional[int] = None,
compartment_id: Optional[str] = None,
configure_sharding_is_rebalance_required: Optional[bool] = None,
configure_sharding_trigger: Optional[int] = None,
connection_strings: Optional[Sequence[DistributedDatabaseDistributedDatabaseConnectionStringArgs]] = None,
database_version: Optional[str] = None,
db_backup_config: Optional[DistributedDatabaseDistributedDatabaseDbBackupConfigArgs] = None,
db_deployment_type: Optional[str] = None,
defined_tags: Optional[Mapping[str, str]] = None,
display_name: Optional[str] = None,
download_gsm_certificate_signing_request_trigger: Optional[int] = None,
freeform_tags: Optional[Mapping[str, str]] = None,
generate_gsm_certificate_signing_request_trigger: Optional[int] = None,
generate_wallet_downloaded_wallet_content_length: Optional[int] = None,
generate_wallet_downloaded_wallet_etag: Optional[str] = None,
generate_wallet_downloaded_wallet_last_modified: Optional[str] = None,
generate_wallet_downloaded_wallet_zip_base64: Optional[str] = None,
generate_wallet_password: Optional[str] = None,
generate_wallet_trigger: Optional[int] = None,
gsm_details: Optional[Sequence[DistributedDatabaseDistributedDatabaseGsmDetailArgs]] = None,
gsm_ssh_public_key: Optional[str] = None,
latest_gsm_image_details: Optional[Sequence[DistributedDatabaseDistributedDatabaseLatestGsmImageDetailArgs]] = None,
lifecycle_details: Optional[str] = None,
listener_port: Optional[int] = None,
listener_port_tls: Optional[int] = None,
metadatas: Optional[Sequence[DistributedDatabaseDistributedDatabaseMetadataArgs]] = None,
ncharacter_set: Optional[str] = None,
ons_port_local: Optional[int] = None,
ons_port_remote: Optional[int] = None,
patch_operations: Optional[Sequence[DistributedDatabaseDistributedDatabasePatchOperationArgs]] = None,
prefix: Optional[str] = None,
private_endpoint_ids: Optional[Sequence[str]] = None,
replication_factor: Optional[int] = None,
replication_method: Optional[str] = None,
replication_unit: Optional[int] = None,
shard_details: Optional[Sequence[DistributedDatabaseDistributedDatabaseShardDetailArgs]] = None,
sharding_method: Optional[str] = None,
start_database_trigger: Optional[int] = None,
state: Optional[str] = None,
stop_database_trigger: Optional[int] = None,
system_tags: Optional[Mapping[str, str]] = None,
time_created: Optional[str] = None,
time_updated: Optional[str] = None,
upload_signed_certificate_and_generate_wallet_trigger: Optional[int] = None,
validate_network_details: Optional[DistributedDatabaseDistributedDatabaseValidateNetworkDetailsArgs] = None,
validate_network_trigger: Optional[int] = None) -> DistributedDatabaseDistributedDatabasefunc GetDistributedDatabaseDistributedDatabase(ctx *Context, name string, id IDInput, state *DistributedDatabaseDistributedDatabaseState, opts ...ResourceOption) (*DistributedDatabaseDistributedDatabase, error)public static DistributedDatabaseDistributedDatabase Get(string name, Input<string> id, DistributedDatabaseDistributedDatabaseState? state, CustomResourceOptions? opts = null)public static DistributedDatabaseDistributedDatabase get(String name, Output<String> id, DistributedDatabaseDistributedDatabaseState state, CustomResourceOptions options)resources: _: type: oci:oci:DistributedDatabaseDistributedDatabase 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.
- Catalog
Details List<DistributedDatabase Distributed Database Catalog Detail> - Collection of catalog for the Globally distributed database.
- Change
Db intBackup Config Trigger - (Updatable) An optional property when incremented triggers Change Db Backup Config. Could be set to any integer value.
- Character
Set string - The character set for the database.
- Chunks int
- Number of chunks in a shardspace. The value of chunks must be greater than 2 times the size of the largest shardgroup in any shardspace. Chunks is required to be provided for distributed databases being created with SYSTEM shardingMethod. For USER shardingMethod, chunks should not be set in create payload.
- Compartment
Id string - (Updatable) The OCID of the Globally distributed database compartment.
- Configure
Sharding boolIs Rebalance Required - Configure
Sharding intTrigger - (Updatable) An optional property when incremented triggers Configure Sharding. Could be set to any integer value.
- Connection
Strings List<DistributedDatabase Distributed Database Connection String> - Details of Globally distributed database connection String.
- Database
Version string - Oracle Database version for the shards and catalog used in Globally distributed database.
- Db
Backup DistributedConfig Database Distributed Database Db Backup Config - 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
Deployment stringType - The distributed database deployment type.
- Dictionary<string, string>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"} - Display
Name string - (Updatable) The display name of the Globally distributed database.
- Download
Gsm intCertificate Signing Request Trigger - (Updatable) An optional property when incremented triggers Download Gsm Certificate Signing Request. Could be set to any integer value.
- Dictionary<string, string>
- (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example:
{"bar-key": "value"} - Generate
Gsm intCertificate Signing Request Trigger - (Updatable) An optional property when incremented triggers Generate Gsm Certificate Signing Request. Could be set to any integer value.
- Generate
Wallet intDownloaded Wallet Content Length - Generate
Wallet stringDownloaded Wallet Etag - Generate
Wallet stringDownloaded Wallet Last Modified - Generate
Wallet stringDownloaded Wallet Zip Base64 - Generate
Wallet stringPassword - Generate
Wallet intTrigger - (Updatable) An optional property when incremented triggers Generate Wallet. Could be set to any integer value.
- Gsm
Details List<DistributedDatabase Distributed Database Gsm Detail> - Collection of catalogs associated with the Globally distributed database.
- Gsm
Ssh stringPublic Key - The SSH public key for Global service manager instances.
- Latest
Gsm List<DistributedImage Details Database Distributed Database Latest Gsm Image Detail> - The Global service manager image details
- Lifecycle
Details string - The lifecycleDetails for the Globally distributed database.
- Listener
Port int - The listener port number for the Globally distributed database. The listener port number has to be unique for a customer tenancy across all distributed databases. Same port number should not be re-used for any other distributed database.
- Listener
Port intTls - The TLS listener port number for the Globally distributed database. The TLS listener port number has to be unique for a customer tenancy across all distributed databases. Same port number should not be re-used for any other distributed database. For BASE_DB and EXADB_XS based distributed databases, tls is not supported hence the listenerPortTls is not needed to be provided in create payload.
- Metadatas
List<Distributed
Database Distributed Database Metadata> - Additional metadata related to Globally distributed database resources.
- Ncharacter
Set string - The national character set for the database.
- Ons
Port intLocal - The ons local port number for the Globally distributed database. The onsPortLocal has to be unique for a customer tenancy across all distributed databases. Same port number should not be re-used for any other distributed database.
- Ons
Port intRemote - The ons remote port number for the Globally distributed database. The onsPortRemote has to be unique for a customer tenancy across all distributed databases. Same port number should not be re-used for any other distributed database.
- Patch
Operations List<DistributedDatabase Distributed Database Patch Operation> - (Updatable)
- Prefix string
- Unique name prefix for the Globally distributed databases. Only alpha-numeric values are allowed. First character has to be a letter followed by any combination of letter and number.
- Private
Endpoint List<string>Ids - The collection of OCID of the private endpoint associated with Globally distributed autonomous database.
- Replication
Factor int - The Replication factor for RAFT replication based Globally distributed database. Currently supported values are 3, 5 and 7.
- Replication
Method string - The Replication method for Globally distributed database. Use RAFT for Raft based replication. With RAFT replication, shards cannot have peers details set on them. In case shards need to have peers, please do not set RAFT replicationMethod. For all non RAFT replication cases (with or without peers), please set replicationMethod as DG or do not set any value for replicationMethod.
- Replication
Unit int - The replication unit count for RAFT based distributed database. For RAFT replication based Globally distributed database, the value should be at least twice the number of shards.
- Shard
Details List<DistributedDatabase Distributed Database Shard Detail> - Collection of shards for the Globally distributed database.
- Sharding
Method string - Sharding Methods for the Globally distributed database.
- Start
Database intTrigger - Increment this value to trigger StartDistributedDatabase action.
- State string
- (Updatable) The target state for the Distributed Database. Could be set to
ACTIVEorINACTIVE. - Stop
Database intTrigger - Increment this value to trigger StopDistributedDatabase action.
- Dictionary<string, string>
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example:
{"orcl-cloud.free-tier-retained": "true"} - Time
Created string - The time the Globally distributed database was created. An RFC3339 formatted datetime string
- Time
Updated string - The time the Globally distributed database was last updated. An RFC3339 formatted datetime string
- Upload
Signed intCertificate And Generate Wallet Trigger - (Updatable) An optional property when incremented triggers Upload Signed Certificate And Generate Wallet. Could be set to any integer value.
- Validate
Network DistributedDetails Database Distributed Database Validate Network Details - Validate
Network intTrigger (Updatable) An optional property when incremented triggers Validate Network. Could be set to any integer value.
** 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
- Catalog
Details []DistributedDatabase Distributed Database Catalog Detail Args - Collection of catalog for the Globally distributed database.
- Change
Db intBackup Config Trigger - (Updatable) An optional property when incremented triggers Change Db Backup Config. Could be set to any integer value.
- Character
Set string - The character set for the database.
- Chunks int
- Number of chunks in a shardspace. The value of chunks must be greater than 2 times the size of the largest shardgroup in any shardspace. Chunks is required to be provided for distributed databases being created with SYSTEM shardingMethod. For USER shardingMethod, chunks should not be set in create payload.
- Compartment
Id string - (Updatable) The OCID of the Globally distributed database compartment.
- Configure
Sharding boolIs Rebalance Required - Configure
Sharding intTrigger - (Updatable) An optional property when incremented triggers Configure Sharding. Could be set to any integer value.
- Connection
Strings []DistributedDatabase Distributed Database Connection String Args - Details of Globally distributed database connection String.
- Database
Version string - Oracle Database version for the shards and catalog used in Globally distributed database.
- Db
Backup DistributedConfig Database Distributed Database Db Backup Config Args - 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
Deployment stringType - The distributed database deployment type.
- map[string]string
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"} - Display
Name string - (Updatable) The display name of the Globally distributed database.
- Download
Gsm intCertificate Signing Request Trigger - (Updatable) An optional property when incremented triggers Download Gsm Certificate Signing Request. Could be set to any integer value.
- map[string]string
- (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example:
{"bar-key": "value"} - Generate
Gsm intCertificate Signing Request Trigger - (Updatable) An optional property when incremented triggers Generate Gsm Certificate Signing Request. Could be set to any integer value.
- Generate
Wallet intDownloaded Wallet Content Length - Generate
Wallet stringDownloaded Wallet Etag - Generate
Wallet stringDownloaded Wallet Last Modified - Generate
Wallet stringDownloaded Wallet Zip Base64 - Generate
Wallet stringPassword - Generate
Wallet intTrigger - (Updatable) An optional property when incremented triggers Generate Wallet. Could be set to any integer value.
- Gsm
Details []DistributedDatabase Distributed Database Gsm Detail Args - Collection of catalogs associated with the Globally distributed database.
- Gsm
Ssh stringPublic Key - The SSH public key for Global service manager instances.
- Latest
Gsm []DistributedImage Details Database Distributed Database Latest Gsm Image Detail Args - The Global service manager image details
- Lifecycle
Details string - The lifecycleDetails for the Globally distributed database.
- Listener
Port int - The listener port number for the Globally distributed database. The listener port number has to be unique for a customer tenancy across all distributed databases. Same port number should not be re-used for any other distributed database.
- Listener
Port intTls - The TLS listener port number for the Globally distributed database. The TLS listener port number has to be unique for a customer tenancy across all distributed databases. Same port number should not be re-used for any other distributed database. For BASE_DB and EXADB_XS based distributed databases, tls is not supported hence the listenerPortTls is not needed to be provided in create payload.
- Metadatas
[]Distributed
Database Distributed Database Metadata Args - Additional metadata related to Globally distributed database resources.
- Ncharacter
Set string - The national character set for the database.
- Ons
Port intLocal - The ons local port number for the Globally distributed database. The onsPortLocal has to be unique for a customer tenancy across all distributed databases. Same port number should not be re-used for any other distributed database.
- Ons
Port intRemote - The ons remote port number for the Globally distributed database. The onsPortRemote has to be unique for a customer tenancy across all distributed databases. Same port number should not be re-used for any other distributed database.
- Patch
Operations []DistributedDatabase Distributed Database Patch Operation Args - (Updatable)
- Prefix string
- Unique name prefix for the Globally distributed databases. Only alpha-numeric values are allowed. First character has to be a letter followed by any combination of letter and number.
- Private
Endpoint []stringIds - The collection of OCID of the private endpoint associated with Globally distributed autonomous database.
- Replication
Factor int - The Replication factor for RAFT replication based Globally distributed database. Currently supported values are 3, 5 and 7.
- Replication
Method string - The Replication method for Globally distributed database. Use RAFT for Raft based replication. With RAFT replication, shards cannot have peers details set on them. In case shards need to have peers, please do not set RAFT replicationMethod. For all non RAFT replication cases (with or without peers), please set replicationMethod as DG or do not set any value for replicationMethod.
- Replication
Unit int - The replication unit count for RAFT based distributed database. For RAFT replication based Globally distributed database, the value should be at least twice the number of shards.
- Shard
Details []DistributedDatabase Distributed Database Shard Detail Args - Collection of shards for the Globally distributed database.
- Sharding
Method string - Sharding Methods for the Globally distributed database.
- Start
Database intTrigger - Increment this value to trigger StartDistributedDatabase action.
- State string
- (Updatable) The target state for the Distributed Database. Could be set to
ACTIVEorINACTIVE. - Stop
Database intTrigger - Increment this value to trigger StopDistributedDatabase action.
- map[string]string
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example:
{"orcl-cloud.free-tier-retained": "true"} - Time
Created string - The time the Globally distributed database was created. An RFC3339 formatted datetime string
- Time
Updated string - The time the Globally distributed database was last updated. An RFC3339 formatted datetime string
- Upload
Signed intCertificate And Generate Wallet Trigger - (Updatable) An optional property when incremented triggers Upload Signed Certificate And Generate Wallet. Could be set to any integer value.
- Validate
Network DistributedDetails Database Distributed Database Validate Network Details Args - Validate
Network intTrigger (Updatable) An optional property when incremented triggers Validate Network. Could be set to any integer value.
** 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
- catalog
Details List<DistributedDatabase Distributed Database Catalog Detail> - Collection of catalog for the Globally distributed database.
- change
Db IntegerBackup Config Trigger - (Updatable) An optional property when incremented triggers Change Db Backup Config. Could be set to any integer value.
- character
Set String - The character set for the database.
- chunks Integer
- Number of chunks in a shardspace. The value of chunks must be greater than 2 times the size of the largest shardgroup in any shardspace. Chunks is required to be provided for distributed databases being created with SYSTEM shardingMethod. For USER shardingMethod, chunks should not be set in create payload.
- compartment
Id String - (Updatable) The OCID of the Globally distributed database compartment.
- configure
Sharding BooleanIs Rebalance Required - configure
Sharding IntegerTrigger - (Updatable) An optional property when incremented triggers Configure Sharding. Could be set to any integer value.
- connection
Strings List<DistributedDatabase Distributed Database Connection String> - Details of Globally distributed database connection String.
- database
Version String - Oracle Database version for the shards and catalog used in Globally distributed database.
- db
Backup DistributedConfig Database Distributed Database Db Backup Config - 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
Deployment StringType - The distributed database deployment type.
- Map<String,String>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"} - display
Name String - (Updatable) The display name of the Globally distributed database.
- download
Gsm IntegerCertificate Signing Request Trigger - (Updatable) An optional property when incremented triggers Download Gsm Certificate Signing Request. Could be set to any integer value.
- Map<String,String>
- (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example:
{"bar-key": "value"} - generate
Gsm IntegerCertificate Signing Request Trigger - (Updatable) An optional property when incremented triggers Generate Gsm Certificate Signing Request. Could be set to any integer value.
- generate
Wallet IntegerDownloaded Wallet Content Length - generate
Wallet StringDownloaded Wallet Etag - generate
Wallet StringDownloaded Wallet Last Modified - generate
Wallet StringDownloaded Wallet Zip Base64 - generate
Wallet StringPassword - generate
Wallet IntegerTrigger - (Updatable) An optional property when incremented triggers Generate Wallet. Could be set to any integer value.
- gsm
Details List<DistributedDatabase Distributed Database Gsm Detail> - Collection of catalogs associated with the Globally distributed database.
- gsm
Ssh StringPublic Key - The SSH public key for Global service manager instances.
- latest
Gsm List<DistributedImage Details Database Distributed Database Latest Gsm Image Detail> - The Global service manager image details
- lifecycle
Details String - The lifecycleDetails for the Globally distributed database.
- listener
Port Integer - The listener port number for the Globally distributed database. The listener port number has to be unique for a customer tenancy across all distributed databases. Same port number should not be re-used for any other distributed database.
- listener
Port IntegerTls - The TLS listener port number for the Globally distributed database. The TLS listener port number has to be unique for a customer tenancy across all distributed databases. Same port number should not be re-used for any other distributed database. For BASE_DB and EXADB_XS based distributed databases, tls is not supported hence the listenerPortTls is not needed to be provided in create payload.
- metadatas
List<Distributed
Database Distributed Database Metadata> - Additional metadata related to Globally distributed database resources.
- ncharacter
Set String - The national character set for the database.
- ons
Port IntegerLocal - The ons local port number for the Globally distributed database. The onsPortLocal has to be unique for a customer tenancy across all distributed databases. Same port number should not be re-used for any other distributed database.
- ons
Port IntegerRemote - The ons remote port number for the Globally distributed database. The onsPortRemote has to be unique for a customer tenancy across all distributed databases. Same port number should not be re-used for any other distributed database.
- patch
Operations List<DistributedDatabase Distributed Database Patch Operation> - (Updatable)
- prefix String
- Unique name prefix for the Globally distributed databases. Only alpha-numeric values are allowed. First character has to be a letter followed by any combination of letter and number.
- private
Endpoint List<String>Ids - The collection of OCID of the private endpoint associated with Globally distributed autonomous database.
- replication
Factor Integer - The Replication factor for RAFT replication based Globally distributed database. Currently supported values are 3, 5 and 7.
- replication
Method String - The Replication method for Globally distributed database. Use RAFT for Raft based replication. With RAFT replication, shards cannot have peers details set on them. In case shards need to have peers, please do not set RAFT replicationMethod. For all non RAFT replication cases (with or without peers), please set replicationMethod as DG or do not set any value for replicationMethod.
- replication
Unit Integer - The replication unit count for RAFT based distributed database. For RAFT replication based Globally distributed database, the value should be at least twice the number of shards.
- shard
Details List<DistributedDatabase Distributed Database Shard Detail> - Collection of shards for the Globally distributed database.
- sharding
Method String - Sharding Methods for the Globally distributed database.
- start
Database IntegerTrigger - Increment this value to trigger StartDistributedDatabase action.
- state String
- (Updatable) The target state for the Distributed Database. Could be set to
ACTIVEorINACTIVE. - stop
Database IntegerTrigger - Increment this value to trigger StopDistributedDatabase action.
- Map<String,String>
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example:
{"orcl-cloud.free-tier-retained": "true"} - time
Created String - The time the Globally distributed database was created. An RFC3339 formatted datetime string
- time
Updated String - The time the Globally distributed database was last updated. An RFC3339 formatted datetime string
- upload
Signed IntegerCertificate And Generate Wallet Trigger - (Updatable) An optional property when incremented triggers Upload Signed Certificate And Generate Wallet. Could be set to any integer value.
- validate
Network DistributedDetails Database Distributed Database Validate Network Details - validate
Network IntegerTrigger (Updatable) An optional property when incremented triggers Validate Network. Could be set to any integer value.
** 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
- catalog
Details DistributedDatabase Distributed Database Catalog Detail[] - Collection of catalog for the Globally distributed database.
- change
Db numberBackup Config Trigger - (Updatable) An optional property when incremented triggers Change Db Backup Config. Could be set to any integer value.
- character
Set string - The character set for the database.
- chunks number
- Number of chunks in a shardspace. The value of chunks must be greater than 2 times the size of the largest shardgroup in any shardspace. Chunks is required to be provided for distributed databases being created with SYSTEM shardingMethod. For USER shardingMethod, chunks should not be set in create payload.
- compartment
Id string - (Updatable) The OCID of the Globally distributed database compartment.
- configure
Sharding booleanIs Rebalance Required - configure
Sharding numberTrigger - (Updatable) An optional property when incremented triggers Configure Sharding. Could be set to any integer value.
- connection
Strings DistributedDatabase Distributed Database Connection String[] - Details of Globally distributed database connection String.
- database
Version string - Oracle Database version for the shards and catalog used in Globally distributed database.
- db
Backup DistributedConfig Database Distributed Database Db Backup Config - 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
Deployment stringType - The distributed database deployment type.
- {[key: string]: string}
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"} - display
Name string - (Updatable) The display name of the Globally distributed database.
- download
Gsm numberCertificate Signing Request Trigger - (Updatable) An optional property when incremented triggers Download Gsm Certificate Signing Request. Could be set to any integer value.
- {[key: string]: string}
- (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example:
{"bar-key": "value"} - generate
Gsm numberCertificate Signing Request Trigger - (Updatable) An optional property when incremented triggers Generate Gsm Certificate Signing Request. Could be set to any integer value.
- generate
Wallet numberDownloaded Wallet Content Length - generate
Wallet stringDownloaded Wallet Etag - generate
Wallet stringDownloaded Wallet Last Modified - generate
Wallet stringDownloaded Wallet Zip Base64 - generate
Wallet stringPassword - generate
Wallet numberTrigger - (Updatable) An optional property when incremented triggers Generate Wallet. Could be set to any integer value.
- gsm
Details DistributedDatabase Distributed Database Gsm Detail[] - Collection of catalogs associated with the Globally distributed database.
- gsm
Ssh stringPublic Key - The SSH public key for Global service manager instances.
- latest
Gsm DistributedImage Details Database Distributed Database Latest Gsm Image Detail[] - The Global service manager image details
- lifecycle
Details string - The lifecycleDetails for the Globally distributed database.
- listener
Port number - The listener port number for the Globally distributed database. The listener port number has to be unique for a customer tenancy across all distributed databases. Same port number should not be re-used for any other distributed database.
- listener
Port numberTls - The TLS listener port number for the Globally distributed database. The TLS listener port number has to be unique for a customer tenancy across all distributed databases. Same port number should not be re-used for any other distributed database. For BASE_DB and EXADB_XS based distributed databases, tls is not supported hence the listenerPortTls is not needed to be provided in create payload.
- metadatas
Distributed
Database Distributed Database Metadata[] - Additional metadata related to Globally distributed database resources.
- ncharacter
Set string - The national character set for the database.
- ons
Port numberLocal - The ons local port number for the Globally distributed database. The onsPortLocal has to be unique for a customer tenancy across all distributed databases. Same port number should not be re-used for any other distributed database.
- ons
Port numberRemote - The ons remote port number for the Globally distributed database. The onsPortRemote has to be unique for a customer tenancy across all distributed databases. Same port number should not be re-used for any other distributed database.
- patch
Operations DistributedDatabase Distributed Database Patch Operation[] - (Updatable)
- prefix string
- Unique name prefix for the Globally distributed databases. Only alpha-numeric values are allowed. First character has to be a letter followed by any combination of letter and number.
- private
Endpoint string[]Ids - The collection of OCID of the private endpoint associated with Globally distributed autonomous database.
- replication
Factor number - The Replication factor for RAFT replication based Globally distributed database. Currently supported values are 3, 5 and 7.
- replication
Method string - The Replication method for Globally distributed database. Use RAFT for Raft based replication. With RAFT replication, shards cannot have peers details set on them. In case shards need to have peers, please do not set RAFT replicationMethod. For all non RAFT replication cases (with or without peers), please set replicationMethod as DG or do not set any value for replicationMethod.
- replication
Unit number - The replication unit count for RAFT based distributed database. For RAFT replication based Globally distributed database, the value should be at least twice the number of shards.
- shard
Details DistributedDatabase Distributed Database Shard Detail[] - Collection of shards for the Globally distributed database.
- sharding
Method string - Sharding Methods for the Globally distributed database.
- start
Database numberTrigger - Increment this value to trigger StartDistributedDatabase action.
- state string
- (Updatable) The target state for the Distributed Database. Could be set to
ACTIVEorINACTIVE. - stop
Database numberTrigger - Increment this value to trigger StopDistributedDatabase action.
- {[key: string]: string}
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example:
{"orcl-cloud.free-tier-retained": "true"} - time
Created string - The time the Globally distributed database was created. An RFC3339 formatted datetime string
- time
Updated string - The time the Globally distributed database was last updated. An RFC3339 formatted datetime string
- upload
Signed numberCertificate And Generate Wallet Trigger - (Updatable) An optional property when incremented triggers Upload Signed Certificate And Generate Wallet. Could be set to any integer value.
- validate
Network DistributedDetails Database Distributed Database Validate Network Details - validate
Network numberTrigger (Updatable) An optional property when incremented triggers Validate Network. Could be set to any integer value.
** 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
- catalog_
details Sequence[DistributedDatabase Distributed Database Catalog Detail Args] - Collection of catalog for the Globally distributed database.
- change_
db_ intbackup_ config_ trigger - (Updatable) An optional property when incremented triggers Change Db Backup Config. Could be set to any integer value.
- character_
set str - The character set for the database.
- chunks int
- Number of chunks in a shardspace. The value of chunks must be greater than 2 times the size of the largest shardgroup in any shardspace. Chunks is required to be provided for distributed databases being created with SYSTEM shardingMethod. For USER shardingMethod, chunks should not be set in create payload.
- compartment_
id str - (Updatable) The OCID of the Globally distributed database compartment.
- configure_
sharding_ boolis_ rebalance_ required - configure_
sharding_ inttrigger - (Updatable) An optional property when incremented triggers Configure Sharding. Could be set to any integer value.
- connection_
strings Sequence[DistributedDatabase Distributed Database Connection String Args] - Details of Globally distributed database connection String.
- database_
version str - Oracle Database version for the shards and catalog used in Globally distributed database.
- db_
backup_ Distributedconfig Database Distributed Database Db Backup Config Args - 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_
deployment_ strtype - The distributed database deployment type.
- Mapping[str, str]
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"} - display_
name str - (Updatable) The display name of the Globally distributed database.
- download_
gsm_ intcertificate_ signing_ request_ trigger - (Updatable) An optional property when incremented triggers Download Gsm Certificate Signing Request. Could be set to any integer value.
- Mapping[str, str]
- (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example:
{"bar-key": "value"} - generate_
gsm_ intcertificate_ signing_ request_ trigger - (Updatable) An optional property when incremented triggers Generate Gsm Certificate Signing Request. Could be set to any integer value.
- generate_
wallet_ intdownloaded_ wallet_ content_ length - generate_
wallet_ strdownloaded_ wallet_ etag - generate_
wallet_ strdownloaded_ wallet_ last_ modified - generate_
wallet_ strdownloaded_ wallet_ zip_ base64 - generate_
wallet_ strpassword - generate_
wallet_ inttrigger - (Updatable) An optional property when incremented triggers Generate Wallet. Could be set to any integer value.
- gsm_
details Sequence[DistributedDatabase Distributed Database Gsm Detail Args] - Collection of catalogs associated with the Globally distributed database.
- gsm_
ssh_ strpublic_ key - The SSH public key for Global service manager instances.
- latest_
gsm_ Sequence[Distributedimage_ details Database Distributed Database Latest Gsm Image Detail Args] - The Global service manager image details
- lifecycle_
details str - The lifecycleDetails for the Globally distributed database.
- listener_
port int - The listener port number for the Globally distributed database. The listener port number has to be unique for a customer tenancy across all distributed databases. Same port number should not be re-used for any other distributed database.
- listener_
port_ inttls - The TLS listener port number for the Globally distributed database. The TLS listener port number has to be unique for a customer tenancy across all distributed databases. Same port number should not be re-used for any other distributed database. For BASE_DB and EXADB_XS based distributed databases, tls is not supported hence the listenerPortTls is not needed to be provided in create payload.
- metadatas
Sequence[Distributed
Database Distributed Database Metadata Args] - Additional metadata related to Globally distributed database resources.
- ncharacter_
set str - The national character set for the database.
- ons_
port_ intlocal - The ons local port number for the Globally distributed database. The onsPortLocal has to be unique for a customer tenancy across all distributed databases. Same port number should not be re-used for any other distributed database.
- ons_
port_ intremote - The ons remote port number for the Globally distributed database. The onsPortRemote has to be unique for a customer tenancy across all distributed databases. Same port number should not be re-used for any other distributed database.
- patch_
operations Sequence[DistributedDatabase Distributed Database Patch Operation Args] - (Updatable)
- prefix str
- Unique name prefix for the Globally distributed databases. Only alpha-numeric values are allowed. First character has to be a letter followed by any combination of letter and number.
- private_
endpoint_ Sequence[str]ids - The collection of OCID of the private endpoint associated with Globally distributed autonomous database.
- replication_
factor int - The Replication factor for RAFT replication based Globally distributed database. Currently supported values are 3, 5 and 7.
- replication_
method str - The Replication method for Globally distributed database. Use RAFT for Raft based replication. With RAFT replication, shards cannot have peers details set on them. In case shards need to have peers, please do not set RAFT replicationMethod. For all non RAFT replication cases (with or without peers), please set replicationMethod as DG or do not set any value for replicationMethod.
- replication_
unit int - The replication unit count for RAFT based distributed database. For RAFT replication based Globally distributed database, the value should be at least twice the number of shards.
- shard_
details Sequence[DistributedDatabase Distributed Database Shard Detail Args] - Collection of shards for the Globally distributed database.
- sharding_
method str - Sharding Methods for the Globally distributed database.
- start_
database_ inttrigger - Increment this value to trigger StartDistributedDatabase action.
- state str
- (Updatable) The target state for the Distributed Database. Could be set to
ACTIVEorINACTIVE. - stop_
database_ inttrigger - Increment this value to trigger StopDistributedDatabase action.
- Mapping[str, str]
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example:
{"orcl-cloud.free-tier-retained": "true"} - time_
created str - The time the Globally distributed database was created. An RFC3339 formatted datetime string
- time_
updated str - The time the Globally distributed database was last updated. An RFC3339 formatted datetime string
- upload_
signed_ intcertificate_ and_ generate_ wallet_ trigger - (Updatable) An optional property when incremented triggers Upload Signed Certificate And Generate Wallet. Could be set to any integer value.
- validate_
network_ Distributeddetails Database Distributed Database Validate Network Details Args - validate_
network_ inttrigger (Updatable) An optional property when incremented triggers Validate Network. Could be set to any integer value.
** 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
- catalog
Details List<Property Map> - Collection of catalog for the Globally distributed database.
- change
Db NumberBackup Config Trigger - (Updatable) An optional property when incremented triggers Change Db Backup Config. Could be set to any integer value.
- character
Set String - The character set for the database.
- chunks Number
- Number of chunks in a shardspace. The value of chunks must be greater than 2 times the size of the largest shardgroup in any shardspace. Chunks is required to be provided for distributed databases being created with SYSTEM shardingMethod. For USER shardingMethod, chunks should not be set in create payload.
- compartment
Id String - (Updatable) The OCID of the Globally distributed database compartment.
- configure
Sharding BooleanIs Rebalance Required - configure
Sharding NumberTrigger - (Updatable) An optional property when incremented triggers Configure Sharding. Could be set to any integer value.
- connection
Strings List<Property Map> - Details of Globally distributed database connection String.
- database
Version String - Oracle Database version for the shards and catalog used in Globally distributed database.
- db
Backup Property MapConfig - 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
Deployment StringType - The distributed database deployment type.
- Map<String>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"} - display
Name String - (Updatable) The display name of the Globally distributed database.
- download
Gsm NumberCertificate Signing Request Trigger - (Updatable) An optional property when incremented triggers Download Gsm Certificate Signing Request. Could be set to any integer value.
- Map<String>
- (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example:
{"bar-key": "value"} - generate
Gsm NumberCertificate Signing Request Trigger - (Updatable) An optional property when incremented triggers Generate Gsm Certificate Signing Request. Could be set to any integer value.
- generate
Wallet NumberDownloaded Wallet Content Length - generate
Wallet StringDownloaded Wallet Etag - generate
Wallet StringDownloaded Wallet Last Modified - generate
Wallet StringDownloaded Wallet Zip Base64 - generate
Wallet StringPassword - generate
Wallet NumberTrigger - (Updatable) An optional property when incremented triggers Generate Wallet. Could be set to any integer value.
- gsm
Details List<Property Map> - Collection of catalogs associated with the Globally distributed database.
- gsm
Ssh StringPublic Key - The SSH public key for Global service manager instances.
- latest
Gsm List<Property Map>Image Details - The Global service manager image details
- lifecycle
Details String - The lifecycleDetails for the Globally distributed database.
- listener
Port Number - The listener port number for the Globally distributed database. The listener port number has to be unique for a customer tenancy across all distributed databases. Same port number should not be re-used for any other distributed database.
- listener
Port NumberTls - The TLS listener port number for the Globally distributed database. The TLS listener port number has to be unique for a customer tenancy across all distributed databases. Same port number should not be re-used for any other distributed database. For BASE_DB and EXADB_XS based distributed databases, tls is not supported hence the listenerPortTls is not needed to be provided in create payload.
- metadatas List<Property Map>
- Additional metadata related to Globally distributed database resources.
- ncharacter
Set String - The national character set for the database.
- ons
Port NumberLocal - The ons local port number for the Globally distributed database. The onsPortLocal has to be unique for a customer tenancy across all distributed databases. Same port number should not be re-used for any other distributed database.
- ons
Port NumberRemote - The ons remote port number for the Globally distributed database. The onsPortRemote has to be unique for a customer tenancy across all distributed databases. Same port number should not be re-used for any other distributed database.
- patch
Operations List<Property Map> - (Updatable)
- prefix String
- Unique name prefix for the Globally distributed databases. Only alpha-numeric values are allowed. First character has to be a letter followed by any combination of letter and number.
- private
Endpoint List<String>Ids - The collection of OCID of the private endpoint associated with Globally distributed autonomous database.
- replication
Factor Number - The Replication factor for RAFT replication based Globally distributed database. Currently supported values are 3, 5 and 7.
- replication
Method String - The Replication method for Globally distributed database. Use RAFT for Raft based replication. With RAFT replication, shards cannot have peers details set on them. In case shards need to have peers, please do not set RAFT replicationMethod. For all non RAFT replication cases (with or without peers), please set replicationMethod as DG or do not set any value for replicationMethod.
- replication
Unit Number - The replication unit count for RAFT based distributed database. For RAFT replication based Globally distributed database, the value should be at least twice the number of shards.
- shard
Details List<Property Map> - Collection of shards for the Globally distributed database.
- sharding
Method String - Sharding Methods for the Globally distributed database.
- start
Database NumberTrigger - Increment this value to trigger StartDistributedDatabase action.
- state String
- (Updatable) The target state for the Distributed Database. Could be set to
ACTIVEorINACTIVE. - stop
Database NumberTrigger - Increment this value to trigger StopDistributedDatabase action.
- Map<String>
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example:
{"orcl-cloud.free-tier-retained": "true"} - time
Created String - The time the Globally distributed database was created. An RFC3339 formatted datetime string
- time
Updated String - The time the Globally distributed database was last updated. An RFC3339 formatted datetime string
- upload
Signed NumberCertificate And Generate Wallet Trigger - (Updatable) An optional property when incremented triggers Upload Signed Certificate And Generate Wallet. Could be set to any integer value.
- validate
Network Property MapDetails - validate
Network NumberTrigger (Updatable) An optional property when incremented triggers Validate Network. Could be set to any integer value.
** 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
Supporting Types
DistributedDatabaseDistributedDatabaseCatalogDetail, DistributedDatabaseDistributedDatabaseCatalogDetailArgs
- Admin
Password string - The admin password for the cataog associated with Globally distributed database.
- Source string
- The source of Globally distributed database type: Use EXADB_XS for the Globally distributed database with Exascale based distributed database.
- Vm
Cluster stringId - The OCID of the VmCluster.
- Container
Database stringId - the identifier of the container database for underlying supporting resource.
- Db
Home stringId - The OCID of the Database Home.
- Kms
Key stringId - The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
- Kms
Key stringVersion Id - The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions.
- Metadatas
List<Distributed
Database Distributed Database Catalog Detail Metadata> - Additional metadata related to Globally distributed database resources.
- Name string
- Name of the shard.
- Peer
Details List<DistributedDatabase Distributed Database Catalog Detail Peer Detail> - The details required for creation of the peer for the ExadbXs infrastructure based catalog.
- Peer
Vm List<string>Cluster Ids - This field is deprecated. This should not be used while creation of new distributed database. To set the peers on catalog of distributed database please use peerDetails.
- string
- The name of the shardGroup for the shard.
- string
- The shard space name for the Globally distributed database. Shard space for existing shard cannot be changed, once shard is created. Shard space name shall be used while creation of new shards.
- Status string
- Status of EXADB_XS based shard.
- Supporting
Resource stringId - the identifier of the underlying supporting resource.
- Time
Created string - The time the Globally distributed database was created. An RFC3339 formatted datetime string
- Time
Updated string - The time the Globally distributed database was last updated. An RFC3339 formatted datetime string
- Vault
Id string - The OCID of the Oracle Cloud Infrastructure vault. This parameter and
kmsKeyIdare required for Customer Managed Keys.
- Admin
Password string - The admin password for the cataog associated with Globally distributed database.
- Source string
- The source of Globally distributed database type: Use EXADB_XS for the Globally distributed database with Exascale based distributed database.
- Vm
Cluster stringId - The OCID of the VmCluster.
- Container
Database stringId - the identifier of the container database for underlying supporting resource.
- Db
Home stringId - The OCID of the Database Home.
- Kms
Key stringId - The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
- Kms
Key stringVersion Id - The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions.
- Metadatas
[]Distributed
Database Distributed Database Catalog Detail Metadata - Additional metadata related to Globally distributed database resources.
- Name string
- Name of the shard.
- Peer
Details []DistributedDatabase Distributed Database Catalog Detail Peer Detail - The details required for creation of the peer for the ExadbXs infrastructure based catalog.
- Peer
Vm []stringCluster Ids - This field is deprecated. This should not be used while creation of new distributed database. To set the peers on catalog of distributed database please use peerDetails.
- string
- The name of the shardGroup for the shard.
- string
- The shard space name for the Globally distributed database. Shard space for existing shard cannot be changed, once shard is created. Shard space name shall be used while creation of new shards.
- Status string
- Status of EXADB_XS based shard.
- Supporting
Resource stringId - the identifier of the underlying supporting resource.
- Time
Created string - The time the Globally distributed database was created. An RFC3339 formatted datetime string
- Time
Updated string - The time the Globally distributed database was last updated. An RFC3339 formatted datetime string
- Vault
Id string - The OCID of the Oracle Cloud Infrastructure vault. This parameter and
kmsKeyIdare required for Customer Managed Keys.
- admin
Password String - The admin password for the cataog associated with Globally distributed database.
- source String
- The source of Globally distributed database type: Use EXADB_XS for the Globally distributed database with Exascale based distributed database.
- vm
Cluster StringId - The OCID of the VmCluster.
- container
Database StringId - the identifier of the container database for underlying supporting resource.
- db
Home StringId - The OCID of the Database Home.
- kms
Key StringId - The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
- kms
Key StringVersion Id - The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions.
- metadatas
List<Distributed
Database Distributed Database Catalog Detail Metadata> - Additional metadata related to Globally distributed database resources.
- name String
- Name of the shard.
- peer
Details List<DistributedDatabase Distributed Database Catalog Detail Peer Detail> - The details required for creation of the peer for the ExadbXs infrastructure based catalog.
- peer
Vm List<String>Cluster Ids - This field is deprecated. This should not be used while creation of new distributed database. To set the peers on catalog of distributed database please use peerDetails.
- String
- The name of the shardGroup for the shard.
- String
- The shard space name for the Globally distributed database. Shard space for existing shard cannot be changed, once shard is created. Shard space name shall be used while creation of new shards.
- status String
- Status of EXADB_XS based shard.
- supporting
Resource StringId - the identifier of the underlying supporting resource.
- time
Created String - The time the Globally distributed database was created. An RFC3339 formatted datetime string
- time
Updated String - The time the Globally distributed database was last updated. An RFC3339 formatted datetime string
- vault
Id String - The OCID of the Oracle Cloud Infrastructure vault. This parameter and
kmsKeyIdare required for Customer Managed Keys.
- admin
Password string - The admin password for the cataog associated with Globally distributed database.
- source string
- The source of Globally distributed database type: Use EXADB_XS for the Globally distributed database with Exascale based distributed database.
- vm
Cluster stringId - The OCID of the VmCluster.
- container
Database stringId - the identifier of the container database for underlying supporting resource.
- db
Home stringId - The OCID of the Database Home.
- kms
Key stringId - The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
- kms
Key stringVersion Id - The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions.
- metadatas
Distributed
Database Distributed Database Catalog Detail Metadata[] - Additional metadata related to Globally distributed database resources.
- name string
- Name of the shard.
- peer
Details DistributedDatabase Distributed Database Catalog Detail Peer Detail[] - The details required for creation of the peer for the ExadbXs infrastructure based catalog.
- peer
Vm string[]Cluster Ids - This field is deprecated. This should not be used while creation of new distributed database. To set the peers on catalog of distributed database please use peerDetails.
- string
- The name of the shardGroup for the shard.
- string
- The shard space name for the Globally distributed database. Shard space for existing shard cannot be changed, once shard is created. Shard space name shall be used while creation of new shards.
- status string
- Status of EXADB_XS based shard.
- supporting
Resource stringId - the identifier of the underlying supporting resource.
- time
Created string - The time the Globally distributed database was created. An RFC3339 formatted datetime string
- time
Updated string - The time the Globally distributed database was last updated. An RFC3339 formatted datetime string
- vault
Id string - The OCID of the Oracle Cloud Infrastructure vault. This parameter and
kmsKeyIdare required for Customer Managed Keys.
- admin_
password str - The admin password for the cataog associated with Globally distributed database.
- source str
- The source of Globally distributed database type: Use EXADB_XS for the Globally distributed database with Exascale based distributed database.
- vm_
cluster_ strid - The OCID of the VmCluster.
- container_
database_ strid - the identifier of the container database for underlying supporting resource.
- db_
home_ strid - The OCID of the Database Home.
- kms_
key_ strid - The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
- kms_
key_ strversion_ id - The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions.
- metadatas
Sequence[Distributed
Database Distributed Database Catalog Detail Metadata] - Additional metadata related to Globally distributed database resources.
- name str
- Name of the shard.
- peer_
details Sequence[DistributedDatabase Distributed Database Catalog Detail Peer Detail] - The details required for creation of the peer for the ExadbXs infrastructure based catalog.
- peer_
vm_ Sequence[str]cluster_ ids - This field is deprecated. This should not be used while creation of new distributed database. To set the peers on catalog of distributed database please use peerDetails.
- str
- The name of the shardGroup for the shard.
- str
- The shard space name for the Globally distributed database. Shard space for existing shard cannot be changed, once shard is created. Shard space name shall be used while creation of new shards.
- status str
- Status of EXADB_XS based shard.
- supporting_
resource_ strid - the identifier of the underlying supporting resource.
- time_
created str - The time the Globally distributed database was created. An RFC3339 formatted datetime string
- time_
updated str - The time the Globally distributed database was last updated. An RFC3339 formatted datetime string
- vault_
id str - The OCID of the Oracle Cloud Infrastructure vault. This parameter and
kmsKeyIdare required for Customer Managed Keys.
- admin
Password String - The admin password for the cataog associated with Globally distributed database.
- source String
- The source of Globally distributed database type: Use EXADB_XS for the Globally distributed database with Exascale based distributed database.
- vm
Cluster StringId - The OCID of the VmCluster.
- container
Database StringId - the identifier of the container database for underlying supporting resource.
- db
Home StringId - The OCID of the Database Home.
- kms
Key StringId - The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
- kms
Key StringVersion Id - The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions.
- metadatas List<Property Map>
- Additional metadata related to Globally distributed database resources.
- name String
- Name of the shard.
- peer
Details List<Property Map> - The details required for creation of the peer for the ExadbXs infrastructure based catalog.
- peer
Vm List<String>Cluster Ids - This field is deprecated. This should not be used while creation of new distributed database. To set the peers on catalog of distributed database please use peerDetails.
- String
- The name of the shardGroup for the shard.
- String
- The shard space name for the Globally distributed database. Shard space for existing shard cannot be changed, once shard is created. Shard space name shall be used while creation of new shards.
- status String
- Status of EXADB_XS based shard.
- supporting
Resource StringId - the identifier of the underlying supporting resource.
- time
Created String - The time the Globally distributed database was created. An RFC3339 formatted datetime string
- time
Updated String - The time the Globally distributed database was last updated. An RFC3339 formatted datetime string
- vault
Id String - The OCID of the Oracle Cloud Infrastructure vault. This parameter and
kmsKeyIdare required for Customer Managed Keys.
DistributedDatabaseDistributedDatabaseCatalogDetailMetadata, DistributedDatabaseDistributedDatabaseCatalogDetailMetadataArgs
- Map Dictionary<string, string>
- The map containing key-value pair of additional metadata.
- Map map[string]string
- The map containing key-value pair of additional metadata.
- map Map<String,String>
- The map containing key-value pair of additional metadata.
- map {[key: string]: string}
- The map containing key-value pair of additional metadata.
- map Mapping[str, str]
- The map containing key-value pair of additional metadata.
- map Map<String>
- The map containing key-value pair of additional metadata.
DistributedDatabaseDistributedDatabaseCatalogDetailPeerDetail, DistributedDatabaseDistributedDatabaseCatalogDetailPeerDetailArgs
- Vm
Cluster stringId - The OCID of the VM Cluster for the catalog peer.
- Container
Database stringId - the identifier of the container database for underlying supporting resource.
- Metadatas
List<Distributed
Database Distributed Database Catalog Detail Peer Detail Metadata> - Additional metadata related to Globally distributed database resources.
- Protection
Mode string - The protectionMode for the catalog peer.
- string
- The name of the shardGroup for the shard.
- Status string
- Status of EXADB_XS based shard.
- Supporting
Resource stringId - the identifier of the underlying supporting resource.
- Time
Created string - The time the Globally distributed database was created. An RFC3339 formatted datetime string
- Time
Updated string - The time the Globally distributed database was last updated. An RFC3339 formatted datetime string
- Transport
Type string - The redo transport type to use for this Data Guard association.
- Vm
Cluster stringId - The OCID of the VM Cluster for the catalog peer.
- Container
Database stringId - the identifier of the container database for underlying supporting resource.
- Metadatas
[]Distributed
Database Distributed Database Catalog Detail Peer Detail Metadata - Additional metadata related to Globally distributed database resources.
- Protection
Mode string - The protectionMode for the catalog peer.
- string
- The name of the shardGroup for the shard.
- Status string
- Status of EXADB_XS based shard.
- Supporting
Resource stringId - the identifier of the underlying supporting resource.
- Time
Created string - The time the Globally distributed database was created. An RFC3339 formatted datetime string
- Time
Updated string - The time the Globally distributed database was last updated. An RFC3339 formatted datetime string
- Transport
Type string - The redo transport type to use for this Data Guard association.
- vm
Cluster StringId - The OCID of the VM Cluster for the catalog peer.
- container
Database StringId - the identifier of the container database for underlying supporting resource.
- metadatas
List<Distributed
Database Distributed Database Catalog Detail Peer Detail Metadata> - Additional metadata related to Globally distributed database resources.
- protection
Mode String - The protectionMode for the catalog peer.
- String
- The name of the shardGroup for the shard.
- status String
- Status of EXADB_XS based shard.
- supporting
Resource StringId - the identifier of the underlying supporting resource.
- time
Created String - The time the Globally distributed database was created. An RFC3339 formatted datetime string
- time
Updated String - The time the Globally distributed database was last updated. An RFC3339 formatted datetime string
- transport
Type String - The redo transport type to use for this Data Guard association.
- vm
Cluster stringId - The OCID of the VM Cluster for the catalog peer.
- container
Database stringId - the identifier of the container database for underlying supporting resource.
- metadatas
Distributed
Database Distributed Database Catalog Detail Peer Detail Metadata[] - Additional metadata related to Globally distributed database resources.
- protection
Mode string - The protectionMode for the catalog peer.
- string
- The name of the shardGroup for the shard.
- status string
- Status of EXADB_XS based shard.
- supporting
Resource stringId - the identifier of the underlying supporting resource.
- time
Created string - The time the Globally distributed database was created. An RFC3339 formatted datetime string
- time
Updated string - The time the Globally distributed database was last updated. An RFC3339 formatted datetime string
- transport
Type string - The redo transport type to use for this Data Guard association.
- vm_
cluster_ strid - The OCID of the VM Cluster for the catalog peer.
- container_
database_ strid - the identifier of the container database for underlying supporting resource.
- metadatas
Sequence[Distributed
Database Distributed Database Catalog Detail Peer Detail Metadata] - Additional metadata related to Globally distributed database resources.
- protection_
mode str - The protectionMode for the catalog peer.
- str
- The name of the shardGroup for the shard.
- status str
- Status of EXADB_XS based shard.
- supporting_
resource_ strid - the identifier of the underlying supporting resource.
- time_
created str - The time the Globally distributed database was created. An RFC3339 formatted datetime string
- time_
updated str - The time the Globally distributed database was last updated. An RFC3339 formatted datetime string
- transport_
type str - The redo transport type to use for this Data Guard association.
- vm
Cluster StringId - The OCID of the VM Cluster for the catalog peer.
- container
Database StringId - the identifier of the container database for underlying supporting resource.
- metadatas List<Property Map>
- Additional metadata related to Globally distributed database resources.
- protection
Mode String - The protectionMode for the catalog peer.
- String
- The name of the shardGroup for the shard.
- status String
- Status of EXADB_XS based shard.
- supporting
Resource StringId - the identifier of the underlying supporting resource.
- time
Created String - The time the Globally distributed database was created. An RFC3339 formatted datetime string
- time
Updated String - The time the Globally distributed database was last updated. An RFC3339 formatted datetime string
- transport
Type String - The redo transport type to use for this Data Guard association.
DistributedDatabaseDistributedDatabaseCatalogDetailPeerDetailMetadata, DistributedDatabaseDistributedDatabaseCatalogDetailPeerDetailMetadataArgs
- Map Dictionary<string, string>
- The map containing key-value pair of additional metadata.
- Map map[string]string
- The map containing key-value pair of additional metadata.
- map Map<String,String>
- The map containing key-value pair of additional metadata.
- map {[key: string]: string}
- The map containing key-value pair of additional metadata.
- map Mapping[str, str]
- The map containing key-value pair of additional metadata.
- map Map<String>
- The map containing key-value pair of additional metadata.
DistributedDatabaseDistributedDatabaseConnectionString, DistributedDatabaseDistributedDatabaseConnectionStringArgs
- All
Connection Dictionary<string, string>Strings - Collection of connection strings.
- All
Connection map[string]stringStrings - Collection of connection strings.
- all
Connection Map<String,String>Strings - Collection of connection strings.
- all
Connection {[key: string]: string}Strings - Collection of connection strings.
- all_
connection_ Mapping[str, str]strings - Collection of connection strings.
- all
Connection Map<String>Strings - Collection of connection strings.
DistributedDatabaseDistributedDatabaseDbBackupConfig, DistributedDatabaseDistributedDatabaseDbBackupConfigArgs
- Auto
Backup stringWindow - 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 stringBackup Day - 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 stringBackup Window - 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 stringPolicy - 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 List<DistributedDetails Database Distributed Database Db Backup Config Backup Destination Detail> - Backup destination details.
- Can
Run boolImmediate Full Backup - If set to true, configures automatic full backups in the local region (the region of the DB system) for the first backup run immediately.
- Is
Auto boolBackup Enabled - 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.
- Is
Remote boolBackup Enabled - If set to true, configures automatic incremental backups in the local region (the region of the DB system) and the remote region with a default frequency of 1 hour. If you previously used RMAN or dbcli to configure backups, using the Console or the API for manged backups creates a new backup configuration for your database. The new configuration replaces the configuration created with RMAN or dbcli. This means that you can no longer rely on your previously configured unmanaged backups to work.
- Recovery
Window intIn Days - 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.
- Remote
Region string - The name of the remote region where the remote automatic incremental backups will be stored. For information about valid region names, see Regions and Availability Domains.
- Auto
Backup stringWindow - 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 stringBackup Day - 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 stringBackup Window - 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 stringPolicy - 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 []DistributedDetails Database Distributed Database Db Backup Config Backup Destination Detail - Backup destination details.
- Can
Run boolImmediate Full Backup - If set to true, configures automatic full backups in the local region (the region of the DB system) for the first backup run immediately.
- Is
Auto boolBackup Enabled - 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.
- Is
Remote boolBackup Enabled - If set to true, configures automatic incremental backups in the local region (the region of the DB system) and the remote region with a default frequency of 1 hour. If you previously used RMAN or dbcli to configure backups, using the Console or the API for manged backups creates a new backup configuration for your database. The new configuration replaces the configuration created with RMAN or dbcli. This means that you can no longer rely on your previously configured unmanaged backups to work.
- Recovery
Window intIn Days - 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.
- Remote
Region string - The name of the remote region where the remote automatic incremental backups will be stored. For information about valid region names, see Regions and Availability Domains.
- auto
Backup StringWindow - 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 StringBackup Day - 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 StringBackup Window - 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 StringPolicy - 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 List<DistributedDetails Database Distributed Database Db Backup Config Backup Destination Detail> - Backup destination details.
- can
Run BooleanImmediate Full Backup - If set to true, configures automatic full backups in the local region (the region of the DB system) for the first backup run immediately.
- is
Auto BooleanBackup Enabled - 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.
- is
Remote BooleanBackup Enabled - If set to true, configures automatic incremental backups in the local region (the region of the DB system) and the remote region with a default frequency of 1 hour. If you previously used RMAN or dbcli to configure backups, using the Console or the API for manged backups creates a new backup configuration for your database. The new configuration replaces the configuration created with RMAN or dbcli. This means that you can no longer rely on your previously configured unmanaged backups to work.
- recovery
Window IntegerIn Days - 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.
- remote
Region String - The name of the remote region where the remote automatic incremental backups will be stored. For information about valid region names, see Regions and Availability Domains.
- auto
Backup stringWindow - 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 stringBackup Day - 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 stringBackup Window - 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 stringPolicy - 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 DistributedDetails Database Distributed Database Db Backup Config Backup Destination Detail[] - Backup destination details.
- can
Run booleanImmediate Full Backup - If set to true, configures automatic full backups in the local region (the region of the DB system) for the first backup run immediately.
- is
Auto booleanBackup Enabled - 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.
- is
Remote booleanBackup Enabled - If set to true, configures automatic incremental backups in the local region (the region of the DB system) and the remote region with a default frequency of 1 hour. If you previously used RMAN or dbcli to configure backups, using the Console or the API for manged backups creates a new backup configuration for your database. The new configuration replaces the configuration created with RMAN or dbcli. This means that you can no longer rely on your previously configured unmanaged backups to work.
- recovery
Window numberIn Days - 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.
- remote
Region string - The name of the remote region where the remote automatic incremental backups will be stored. For information about valid region names, see Regions and Availability Domains.
- auto_
backup_ strwindow - 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_ strbackup_ day - 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_ strbackup_ window - 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_ strpolicy - 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_ Sequence[Distributeddetails Database Distributed Database Db Backup Config Backup Destination Detail] - Backup destination details.
- can_
run_ boolimmediate_ full_ backup - If set to true, configures automatic full backups in the local region (the region of the DB system) for the first backup run immediately.
- is_
auto_ boolbackup_ enabled - 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.
- is_
remote_ boolbackup_ enabled - If set to true, configures automatic incremental backups in the local region (the region of the DB system) and the remote region with a default frequency of 1 hour. If you previously used RMAN or dbcli to configure backups, using the Console or the API for manged backups creates a new backup configuration for your database. The new configuration replaces the configuration created with RMAN or dbcli. This means that you can no longer rely on your previously configured unmanaged backups to work.
- recovery_
window_ intin_ days - 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.
- remote_
region str - The name of the remote region where the remote automatic incremental backups will be stored. For information about valid region names, see Regions and Availability Domains.
- auto
Backup StringWindow - 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 StringBackup Day - 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 StringBackup Window - 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 StringPolicy - 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 List<Property Map>Details - Backup destination details.
- can
Run BooleanImmediate Full Backup - If set to true, configures automatic full backups in the local region (the region of the DB system) for the first backup run immediately.
- is
Auto BooleanBackup Enabled - 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.
- is
Remote BooleanBackup Enabled - If set to true, configures automatic incremental backups in the local region (the region of the DB system) and the remote region with a default frequency of 1 hour. If you previously used RMAN or dbcli to configure backups, using the Console or the API for manged backups creates a new backup configuration for your database. The new configuration replaces the configuration created with RMAN or dbcli. This means that you can no longer rely on your previously configured unmanaged backups to work.
- recovery
Window NumberIn Days - 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.
- remote
Region String - The name of the remote region where the remote automatic incremental backups will be stored. For information about valid region names, see Regions and Availability Domains.
DistributedDatabaseDistributedDatabaseDbBackupConfigBackupDestinationDetail, DistributedDatabaseDistributedDatabaseDbBackupConfigBackupDestinationDetailArgs
- Type string
- Type of the database backup destination.
- Dbrs
Policy stringId - The OCID of the DBRS policy used for backup.
- Id string
- The OCID of the backup destination.
- Internet
Proxy string - Proxy URL to connect to object store.
- Is
Remote bool - Indicates whether the backup destination is cross-region or local region.
- Is
Zero boolData Loss Enabled - Indicates whether Zero Data Loss functionality is enabled for a Recovery Appliance backup destination in an Autonomous Container Database. When enabled, the database automatically ships all redo logs in real-time to the Recovery Appliance for a Zero Data Loss recovery setup (sub-second RPO). Defaults to
TRUEif no value is given. - Remote
Region string - The name of the remote region where the remote automatic incremental backups will be stored. For information about valid region names, see Regions and Availability Domains.
- Vpc
Password string - For a RECOVERY_APPLIANCE backup destination, the password for the VPC user that is used to access the Recovery Appliance.
- Vpc
User string - For a RECOVERY_APPLIANCE backup destination, the Virtual Private Catalog (VPC) user that is used to access the Recovery Appliance.
- Type string
- Type of the database backup destination.
- Dbrs
Policy stringId - The OCID of the DBRS policy used for backup.
- Id string
- The OCID of the backup destination.
- Internet
Proxy string - Proxy URL to connect to object store.
- Is
Remote bool - Indicates whether the backup destination is cross-region or local region.
- Is
Zero boolData Loss Enabled - Indicates whether Zero Data Loss functionality is enabled for a Recovery Appliance backup destination in an Autonomous Container Database. When enabled, the database automatically ships all redo logs in real-time to the Recovery Appliance for a Zero Data Loss recovery setup (sub-second RPO). Defaults to
TRUEif no value is given. - Remote
Region string - The name of the remote region where the remote automatic incremental backups will be stored. For information about valid region names, see Regions and Availability Domains.
- Vpc
Password string - For a RECOVERY_APPLIANCE backup destination, the password for the VPC user that is used to access the Recovery Appliance.
- Vpc
User string - For a RECOVERY_APPLIANCE backup destination, the Virtual Private Catalog (VPC) user that is used to access the Recovery Appliance.
- type String
- Type of the database backup destination.
- dbrs
Policy StringId - The OCID of the DBRS policy used for backup.
- id String
- The OCID of the backup destination.
- internet
Proxy String - Proxy URL to connect to object store.
- is
Remote Boolean - Indicates whether the backup destination is cross-region or local region.
- is
Zero BooleanData Loss Enabled - Indicates whether Zero Data Loss functionality is enabled for a Recovery Appliance backup destination in an Autonomous Container Database. When enabled, the database automatically ships all redo logs in real-time to the Recovery Appliance for a Zero Data Loss recovery setup (sub-second RPO). Defaults to
TRUEif no value is given. - remote
Region String - The name of the remote region where the remote automatic incremental backups will be stored. For information about valid region names, see Regions and Availability Domains.
- vpc
Password String - For a RECOVERY_APPLIANCE backup destination, the password for the VPC user that is used to access the Recovery Appliance.
- vpc
User String - For a RECOVERY_APPLIANCE backup destination, the Virtual Private Catalog (VPC) user that is used to access the Recovery Appliance.
- type string
- Type of the database backup destination.
- dbrs
Policy stringId - The OCID of the DBRS policy used for backup.
- id string
- The OCID of the backup destination.
- internet
Proxy string - Proxy URL to connect to object store.
- is
Remote boolean - Indicates whether the backup destination is cross-region or local region.
- is
Zero booleanData Loss Enabled - Indicates whether Zero Data Loss functionality is enabled for a Recovery Appliance backup destination in an Autonomous Container Database. When enabled, the database automatically ships all redo logs in real-time to the Recovery Appliance for a Zero Data Loss recovery setup (sub-second RPO). Defaults to
TRUEif no value is given. - remote
Region string - The name of the remote region where the remote automatic incremental backups will be stored. For information about valid region names, see Regions and Availability Domains.
- vpc
Password string - For a RECOVERY_APPLIANCE backup destination, the password for the VPC user that is used to access the Recovery Appliance.
- vpc
User string - For a RECOVERY_APPLIANCE backup destination, the Virtual Private Catalog (VPC) user that is used to access the Recovery Appliance.
- type str
- Type of the database backup destination.
- dbrs_
policy_ strid - The OCID of the DBRS policy used for backup.
- id str
- The OCID of the backup destination.
- internet_
proxy str - Proxy URL to connect to object store.
- is_
remote bool - Indicates whether the backup destination is cross-region or local region.
- is_
zero_ booldata_ loss_ enabled - Indicates whether Zero Data Loss functionality is enabled for a Recovery Appliance backup destination in an Autonomous Container Database. When enabled, the database automatically ships all redo logs in real-time to the Recovery Appliance for a Zero Data Loss recovery setup (sub-second RPO). Defaults to
TRUEif no value is given. - remote_
region str - The name of the remote region where the remote automatic incremental backups will be stored. For information about valid region names, see Regions and Availability Domains.
- 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.
- type String
- Type of the database backup destination.
- dbrs
Policy StringId - The OCID of the DBRS policy used for backup.
- id String
- The OCID of the backup destination.
- internet
Proxy String - Proxy URL to connect to object store.
- is
Remote Boolean - Indicates whether the backup destination is cross-region or local region.
- is
Zero BooleanData Loss Enabled - Indicates whether Zero Data Loss functionality is enabled for a Recovery Appliance backup destination in an Autonomous Container Database. When enabled, the database automatically ships all redo logs in real-time to the Recovery Appliance for a Zero Data Loss recovery setup (sub-second RPO). Defaults to
TRUEif no value is given. - remote
Region String - The name of the remote region where the remote automatic incremental backups will be stored. For information about valid region names, see Regions and Availability Domains.
- vpc
Password String - For a RECOVERY_APPLIANCE backup destination, the password for the VPC user that is used to access the Recovery Appliance.
- vpc
User String - For a RECOVERY_APPLIANCE backup destination, the Virtual Private Catalog (VPC) user that is used to access the Recovery Appliance.
DistributedDatabaseDistributedDatabaseGsmDetail, DistributedDatabaseDistributedDatabaseGsmDetailArgs
- Compute
Count double - The compute count for the Global service manager instance.
- Data
Storage doubleSize In Gbs - The data disk group size to be allocated in GBs for the Global service manager instance.
- Gsm
Image List<DistributedDetails Database Distributed Database Gsm Detail Gsm Image Detail> - The Global service manager image details
- Metadatas
List<Distributed
Database Distributed Database Gsm Detail Metadata> - Additional metadata related to Globally distributed database resources.
- Name string
- Name of the shard.
- Status string
- Status of EXADB_XS based shard.
- Supporting
Resource stringId - the identifier of the underlying supporting resource.
- Time
Created string - The time the Globally distributed database was created. An RFC3339 formatted datetime string
- Time
Ssl stringCertificate Expires - The time the ssl certificate associated with Global service manager expires. An RFC3339 formatted datetime string
- Time
Updated string - The time the Globally distributed database was last updated. An RFC3339 formatted datetime string
- Compute
Count float64 - The compute count for the Global service manager instance.
- Data
Storage float64Size In Gbs - The data disk group size to be allocated in GBs for the Global service manager instance.
- Gsm
Image []DistributedDetails Database Distributed Database Gsm Detail Gsm Image Detail - The Global service manager image details
- Metadatas
[]Distributed
Database Distributed Database Gsm Detail Metadata - Additional metadata related to Globally distributed database resources.
- Name string
- Name of the shard.
- Status string
- Status of EXADB_XS based shard.
- Supporting
Resource stringId - the identifier of the underlying supporting resource.
- Time
Created string - The time the Globally distributed database was created. An RFC3339 formatted datetime string
- Time
Ssl stringCertificate Expires - The time the ssl certificate associated with Global service manager expires. An RFC3339 formatted datetime string
- Time
Updated string - The time the Globally distributed database was last updated. An RFC3339 formatted datetime string
- compute
Count Double - The compute count for the Global service manager instance.
- data
Storage DoubleSize In Gbs - The data disk group size to be allocated in GBs for the Global service manager instance.
- gsm
Image List<DistributedDetails Database Distributed Database Gsm Detail Gsm Image Detail> - The Global service manager image details
- metadatas
List<Distributed
Database Distributed Database Gsm Detail Metadata> - Additional metadata related to Globally distributed database resources.
- name String
- Name of the shard.
- status String
- Status of EXADB_XS based shard.
- supporting
Resource StringId - the identifier of the underlying supporting resource.
- time
Created String - The time the Globally distributed database was created. An RFC3339 formatted datetime string
- time
Ssl StringCertificate Expires - The time the ssl certificate associated with Global service manager expires. An RFC3339 formatted datetime string
- time
Updated String - The time the Globally distributed database was last updated. An RFC3339 formatted datetime string
- compute
Count number - The compute count for the Global service manager instance.
- data
Storage numberSize In Gbs - The data disk group size to be allocated in GBs for the Global service manager instance.
- gsm
Image DistributedDetails Database Distributed Database Gsm Detail Gsm Image Detail[] - The Global service manager image details
- metadatas
Distributed
Database Distributed Database Gsm Detail Metadata[] - Additional metadata related to Globally distributed database resources.
- name string
- Name of the shard.
- status string
- Status of EXADB_XS based shard.
- supporting
Resource stringId - the identifier of the underlying supporting resource.
- time
Created string - The time the Globally distributed database was created. An RFC3339 formatted datetime string
- time
Ssl stringCertificate Expires - The time the ssl certificate associated with Global service manager expires. An RFC3339 formatted datetime string
- time
Updated string - The time the Globally distributed database was last updated. An RFC3339 formatted datetime string
- compute_
count float - The compute count for the Global service manager instance.
- data_
storage_ floatsize_ in_ gbs - The data disk group size to be allocated in GBs for the Global service manager instance.
- gsm_
image_ Sequence[Distributeddetails Database Distributed Database Gsm Detail Gsm Image Detail] - The Global service manager image details
- metadatas
Sequence[Distributed
Database Distributed Database Gsm Detail Metadata] - Additional metadata related to Globally distributed database resources.
- name str
- Name of the shard.
- status str
- Status of EXADB_XS based shard.
- supporting_
resource_ strid - the identifier of the underlying supporting resource.
- time_
created str - The time the Globally distributed database was created. An RFC3339 formatted datetime string
- time_
ssl_ strcertificate_ expires - The time the ssl certificate associated with Global service manager expires. An RFC3339 formatted datetime string
- time_
updated str - The time the Globally distributed database was last updated. An RFC3339 formatted datetime string
- compute
Count Number - The compute count for the Global service manager instance.
- data
Storage NumberSize In Gbs - The data disk group size to be allocated in GBs for the Global service manager instance.
- gsm
Image List<Property Map>Details - The Global service manager image details
- metadatas List<Property Map>
- Additional metadata related to Globally distributed database resources.
- name String
- Name of the shard.
- status String
- Status of EXADB_XS based shard.
- supporting
Resource StringId - the identifier of the underlying supporting resource.
- time
Created String - The time the Globally distributed database was created. An RFC3339 formatted datetime string
- time
Ssl StringCertificate Expires - The time the ssl certificate associated with Global service manager expires. An RFC3339 formatted datetime string
- time
Updated String - The time the Globally distributed database was last updated. An RFC3339 formatted datetime string
DistributedDatabaseDistributedDatabaseGsmDetailGsmImageDetail, DistributedDatabaseDistributedDatabaseGsmDetailGsmImageDetailArgs
- Id string
- The OCID of the Global service manager software image.
- Version
Number int - The version number associated with the image identified by id.
- Id string
- The OCID of the Global service manager software image.
- Version
Number int - The version number associated with the image identified by id.
- id String
- The OCID of the Global service manager software image.
- version
Number Integer - The version number associated with the image identified by id.
- id string
- The OCID of the Global service manager software image.
- version
Number number - The version number associated with the image identified by id.
- id str
- The OCID of the Global service manager software image.
- version_
number int - The version number associated with the image identified by id.
- id String
- The OCID of the Global service manager software image.
- version
Number Number - The version number associated with the image identified by id.
DistributedDatabaseDistributedDatabaseGsmDetailMetadata, DistributedDatabaseDistributedDatabaseGsmDetailMetadataArgs
- Map Dictionary<string, string>
- The map containing key-value pair of additional metadata.
- Map map[string]string
- The map containing key-value pair of additional metadata.
- map Map<String,String>
- The map containing key-value pair of additional metadata.
- map {[key: string]: string}
- The map containing key-value pair of additional metadata.
- map Mapping[str, str]
- The map containing key-value pair of additional metadata.
- map Map<String>
- The map containing key-value pair of additional metadata.
DistributedDatabaseDistributedDatabaseLatestGsmImageDetail, DistributedDatabaseDistributedDatabaseLatestGsmImageDetailArgs
- Id string
- The OCID of the Global service manager software image.
- Version
Number int - The version number associated with the image identified by id.
- Id string
- The OCID of the Global service manager software image.
- Version
Number int - The version number associated with the image identified by id.
- id String
- The OCID of the Global service manager software image.
- version
Number Integer - The version number associated with the image identified by id.
- id string
- The OCID of the Global service manager software image.
- version
Number number - The version number associated with the image identified by id.
- id str
- The OCID of the Global service manager software image.
- version_
number int - The version number associated with the image identified by id.
- id String
- The OCID of the Global service manager software image.
- version
Number Number - The version number associated with the image identified by id.
DistributedDatabaseDistributedDatabaseMetadata, DistributedDatabaseDistributedDatabaseMetadataArgs
- Map Dictionary<string, string>
- The map containing key-value pair of additional metadata.
- Map map[string]string
- The map containing key-value pair of additional metadata.
- map Map<String,String>
- The map containing key-value pair of additional metadata.
- map {[key: string]: string}
- The map containing key-value pair of additional metadata.
- map Mapping[str, str]
- The map containing key-value pair of additional metadata.
- map Map<String>
- The map containing key-value pair of additional metadata.
DistributedDatabaseDistributedDatabasePatchOperation, DistributedDatabaseDistributedDatabasePatchOperationArgs
DistributedDatabaseDistributedDatabaseShardDetail, DistributedDatabaseDistributedDatabaseShardDetailArgs
- Admin
Password string - The admin password for the shard associated with Globally distributed database.
- Source string
- The source of Globally distributed database type: Use EXADB_XS for the Globally distributed database with Exascale based distributed database.
- Vm
Cluster stringId - The OCID of the VmCluster.
- Container
Database stringId - the identifier of the container database for underlying supporting resource.
- Db
Home stringId - The OCID of the Database Home.
- Kms
Key stringId - The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
- Kms
Key stringVersion Id - The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions.
- Metadatas
List<Distributed
Database Distributed Database Shard Detail Metadata> - Additional metadata related to Globally distributed database resources.
- Name string
- Name of the shard.
- Peer
Details List<DistributedDatabase Distributed Database Shard Detail Peer Detail> - The details required for creation of the peer for the ExadbXs infrastructure based shard.
- Peer
Vm List<string>Cluster Ids - This field is deprecated. This should not be used while creation of new distributed database. To set the peers on new shards of distributed database please use peerDetails.
- string
- The name of the shardGroup for the shard.
- string
- The shard space name for the Globally distributed database. Shard space for existing shard cannot be changed, once shard is created. Shard space name shall be used while creation of new shards.
- Status string
- Status of EXADB_XS based shard.
- Supporting
Resource stringId - the identifier of the underlying supporting resource.
- Time
Created string - The time the Globally distributed database was created. An RFC3339 formatted datetime string
- Time
Updated string - The time the Globally distributed database was last updated. An RFC3339 formatted datetime string
- Vault
Id string - The OCID of the Oracle Cloud Infrastructure vault. This parameter and
kmsKeyIdare required for Customer Managed Keys.
- Admin
Password string - The admin password for the shard associated with Globally distributed database.
- Source string
- The source of Globally distributed database type: Use EXADB_XS for the Globally distributed database with Exascale based distributed database.
- Vm
Cluster stringId - The OCID of the VmCluster.
- Container
Database stringId - the identifier of the container database for underlying supporting resource.
- Db
Home stringId - The OCID of the Database Home.
- Kms
Key stringId - The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
- Kms
Key stringVersion Id - The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions.
- Metadatas
[]Distributed
Database Distributed Database Shard Detail Metadata - Additional metadata related to Globally distributed database resources.
- Name string
- Name of the shard.
- Peer
Details []DistributedDatabase Distributed Database Shard Detail Peer Detail - The details required for creation of the peer for the ExadbXs infrastructure based shard.
- Peer
Vm []stringCluster Ids - This field is deprecated. This should not be used while creation of new distributed database. To set the peers on new shards of distributed database please use peerDetails.
- string
- The name of the shardGroup for the shard.
- string
- The shard space name for the Globally distributed database. Shard space for existing shard cannot be changed, once shard is created. Shard space name shall be used while creation of new shards.
- Status string
- Status of EXADB_XS based shard.
- Supporting
Resource stringId - the identifier of the underlying supporting resource.
- Time
Created string - The time the Globally distributed database was created. An RFC3339 formatted datetime string
- Time
Updated string - The time the Globally distributed database was last updated. An RFC3339 formatted datetime string
- Vault
Id string - The OCID of the Oracle Cloud Infrastructure vault. This parameter and
kmsKeyIdare required for Customer Managed Keys.
- admin
Password String - The admin password for the shard associated with Globally distributed database.
- source String
- The source of Globally distributed database type: Use EXADB_XS for the Globally distributed database with Exascale based distributed database.
- vm
Cluster StringId - The OCID of the VmCluster.
- container
Database StringId - the identifier of the container database for underlying supporting resource.
- db
Home StringId - The OCID of the Database Home.
- kms
Key StringId - The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
- kms
Key StringVersion Id - The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions.
- metadatas
List<Distributed
Database Distributed Database Shard Detail Metadata> - Additional metadata related to Globally distributed database resources.
- name String
- Name of the shard.
- peer
Details List<DistributedDatabase Distributed Database Shard Detail Peer Detail> - The details required for creation of the peer for the ExadbXs infrastructure based shard.
- peer
Vm List<String>Cluster Ids - This field is deprecated. This should not be used while creation of new distributed database. To set the peers on new shards of distributed database please use peerDetails.
- String
- The name of the shardGroup for the shard.
- String
- The shard space name for the Globally distributed database. Shard space for existing shard cannot be changed, once shard is created. Shard space name shall be used while creation of new shards.
- status String
- Status of EXADB_XS based shard.
- supporting
Resource StringId - the identifier of the underlying supporting resource.
- time
Created String - The time the Globally distributed database was created. An RFC3339 formatted datetime string
- time
Updated String - The time the Globally distributed database was last updated. An RFC3339 formatted datetime string
- vault
Id String - The OCID of the Oracle Cloud Infrastructure vault. This parameter and
kmsKeyIdare required for Customer Managed Keys.
- admin
Password string - The admin password for the shard associated with Globally distributed database.
- source string
- The source of Globally distributed database type: Use EXADB_XS for the Globally distributed database with Exascale based distributed database.
- vm
Cluster stringId - The OCID of the VmCluster.
- container
Database stringId - the identifier of the container database for underlying supporting resource.
- db
Home stringId - The OCID of the Database Home.
- kms
Key stringId - The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
- kms
Key stringVersion Id - The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions.
- metadatas
Distributed
Database Distributed Database Shard Detail Metadata[] - Additional metadata related to Globally distributed database resources.
- name string
- Name of the shard.
- peer
Details DistributedDatabase Distributed Database Shard Detail Peer Detail[] - The details required for creation of the peer for the ExadbXs infrastructure based shard.
- peer
Vm string[]Cluster Ids - This field is deprecated. This should not be used while creation of new distributed database. To set the peers on new shards of distributed database please use peerDetails.
- string
- The name of the shardGroup for the shard.
- string
- The shard space name for the Globally distributed database. Shard space for existing shard cannot be changed, once shard is created. Shard space name shall be used while creation of new shards.
- status string
- Status of EXADB_XS based shard.
- supporting
Resource stringId - the identifier of the underlying supporting resource.
- time
Created string - The time the Globally distributed database was created. An RFC3339 formatted datetime string
- time
Updated string - The time the Globally distributed database was last updated. An RFC3339 formatted datetime string
- vault
Id string - The OCID of the Oracle Cloud Infrastructure vault. This parameter and
kmsKeyIdare required for Customer Managed Keys.
- admin_
password str - The admin password for the shard associated with Globally distributed database.
- source str
- The source of Globally distributed database type: Use EXADB_XS for the Globally distributed database with Exascale based distributed database.
- vm_
cluster_ strid - The OCID of the VmCluster.
- container_
database_ strid - the identifier of the container database for underlying supporting resource.
- db_
home_ strid - The OCID of the Database Home.
- kms_
key_ strid - The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
- kms_
key_ strversion_ id - The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions.
- metadatas
Sequence[Distributed
Database Distributed Database Shard Detail Metadata] - Additional metadata related to Globally distributed database resources.
- name str
- Name of the shard.
- peer_
details Sequence[DistributedDatabase Distributed Database Shard Detail Peer Detail] - The details required for creation of the peer for the ExadbXs infrastructure based shard.
- peer_
vm_ Sequence[str]cluster_ ids - This field is deprecated. This should not be used while creation of new distributed database. To set the peers on new shards of distributed database please use peerDetails.
- str
- The name of the shardGroup for the shard.
- str
- The shard space name for the Globally distributed database. Shard space for existing shard cannot be changed, once shard is created. Shard space name shall be used while creation of new shards.
- status str
- Status of EXADB_XS based shard.
- supporting_
resource_ strid - the identifier of the underlying supporting resource.
- time_
created str - The time the Globally distributed database was created. An RFC3339 formatted datetime string
- time_
updated str - The time the Globally distributed database was last updated. An RFC3339 formatted datetime string
- vault_
id str - The OCID of the Oracle Cloud Infrastructure vault. This parameter and
kmsKeyIdare required for Customer Managed Keys.
- admin
Password String - The admin password for the shard associated with Globally distributed database.
- source String
- The source of Globally distributed database type: Use EXADB_XS for the Globally distributed database with Exascale based distributed database.
- vm
Cluster StringId - The OCID of the VmCluster.
- container
Database StringId - the identifier of the container database for underlying supporting resource.
- db
Home StringId - The OCID of the Database Home.
- kms
Key StringId - The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
- kms
Key StringVersion Id - The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions.
- metadatas List<Property Map>
- Additional metadata related to Globally distributed database resources.
- name String
- Name of the shard.
- peer
Details List<Property Map> - The details required for creation of the peer for the ExadbXs infrastructure based shard.
- peer
Vm List<String>Cluster Ids - This field is deprecated. This should not be used while creation of new distributed database. To set the peers on new shards of distributed database please use peerDetails.
- String
- The name of the shardGroup for the shard.
- String
- The shard space name for the Globally distributed database. Shard space for existing shard cannot be changed, once shard is created. Shard space name shall be used while creation of new shards.
- status String
- Status of EXADB_XS based shard.
- supporting
Resource StringId - the identifier of the underlying supporting resource.
- time
Created String - The time the Globally distributed database was created. An RFC3339 formatted datetime string
- time
Updated String - The time the Globally distributed database was last updated. An RFC3339 formatted datetime string
- vault
Id String - The OCID of the Oracle Cloud Infrastructure vault. This parameter and
kmsKeyIdare required for Customer Managed Keys.
DistributedDatabaseDistributedDatabaseShardDetailMetadata, DistributedDatabaseDistributedDatabaseShardDetailMetadataArgs
- Map Dictionary<string, string>
- The map containing key-value pair of additional metadata.
- Map map[string]string
- The map containing key-value pair of additional metadata.
- map Map<String,String>
- The map containing key-value pair of additional metadata.
- map {[key: string]: string}
- The map containing key-value pair of additional metadata.
- map Mapping[str, str]
- The map containing key-value pair of additional metadata.
- map Map<String>
- The map containing key-value pair of additional metadata.
DistributedDatabaseDistributedDatabaseShardDetailPeerDetail, DistributedDatabaseDistributedDatabaseShardDetailPeerDetailArgs
- Vm
Cluster stringId - The OCID of the VM Cluster for the shard peer.
- Container
Database stringId - the identifier of the container database for underlying supporting resource.
- Metadatas
List<Distributed
Database Distributed Database Shard Detail Peer Detail Metadata> - Additional metadata related to Globally distributed database resources.
- Protection
Mode string - The protectionMode for the shard peer.
- string
- The name of the shardGroup for the shard.
- Status string
- Status of EXADB_XS based shard.
- Supporting
Resource stringId - the identifier of the underlying supporting resource.
- Time
Created string - The time the Globally distributed database was created. An RFC3339 formatted datetime string
- Time
Updated string - The time the Globally distributed database was last updated. An RFC3339 formatted datetime string
- Transport
Type string - The redo transport type to use for this Data Guard association.
- Vm
Cluster stringId - The OCID of the VM Cluster for the shard peer.
- Container
Database stringId - the identifier of the container database for underlying supporting resource.
- Metadatas
[]Distributed
Database Distributed Database Shard Detail Peer Detail Metadata - Additional metadata related to Globally distributed database resources.
- Protection
Mode string - The protectionMode for the shard peer.
- string
- The name of the shardGroup for the shard.
- Status string
- Status of EXADB_XS based shard.
- Supporting
Resource stringId - the identifier of the underlying supporting resource.
- Time
Created string - The time the Globally distributed database was created. An RFC3339 formatted datetime string
- Time
Updated string - The time the Globally distributed database was last updated. An RFC3339 formatted datetime string
- Transport
Type string - The redo transport type to use for this Data Guard association.
- vm
Cluster StringId - The OCID of the VM Cluster for the shard peer.
- container
Database StringId - the identifier of the container database for underlying supporting resource.
- metadatas
List<Distributed
Database Distributed Database Shard Detail Peer Detail Metadata> - Additional metadata related to Globally distributed database resources.
- protection
Mode String - The protectionMode for the shard peer.
- String
- The name of the shardGroup for the shard.
- status String
- Status of EXADB_XS based shard.
- supporting
Resource StringId - the identifier of the underlying supporting resource.
- time
Created String - The time the Globally distributed database was created. An RFC3339 formatted datetime string
- time
Updated String - The time the Globally distributed database was last updated. An RFC3339 formatted datetime string
- transport
Type String - The redo transport type to use for this Data Guard association.
- vm
Cluster stringId - The OCID of the VM Cluster for the shard peer.
- container
Database stringId - the identifier of the container database for underlying supporting resource.
- metadatas
Distributed
Database Distributed Database Shard Detail Peer Detail Metadata[] - Additional metadata related to Globally distributed database resources.
- protection
Mode string - The protectionMode for the shard peer.
- string
- The name of the shardGroup for the shard.
- status string
- Status of EXADB_XS based shard.
- supporting
Resource stringId - the identifier of the underlying supporting resource.
- time
Created string - The time the Globally distributed database was created. An RFC3339 formatted datetime string
- time
Updated string - The time the Globally distributed database was last updated. An RFC3339 formatted datetime string
- transport
Type string - The redo transport type to use for this Data Guard association.
- vm_
cluster_ strid - The OCID of the VM Cluster for the shard peer.
- container_
database_ strid - the identifier of the container database for underlying supporting resource.
- metadatas
Sequence[Distributed
Database Distributed Database Shard Detail Peer Detail Metadata] - Additional metadata related to Globally distributed database resources.
- protection_
mode str - The protectionMode for the shard peer.
- str
- The name of the shardGroup for the shard.
- status str
- Status of EXADB_XS based shard.
- supporting_
resource_ strid - the identifier of the underlying supporting resource.
- time_
created str - The time the Globally distributed database was created. An RFC3339 formatted datetime string
- time_
updated str - The time the Globally distributed database was last updated. An RFC3339 formatted datetime string
- transport_
type str - The redo transport type to use for this Data Guard association.
- vm
Cluster StringId - The OCID of the VM Cluster for the shard peer.
- container
Database StringId - the identifier of the container database for underlying supporting resource.
- metadatas List<Property Map>
- Additional metadata related to Globally distributed database resources.
- protection
Mode String - The protectionMode for the shard peer.
- String
- The name of the shardGroup for the shard.
- status String
- Status of EXADB_XS based shard.
- supporting
Resource StringId - the identifier of the underlying supporting resource.
- time
Created String - The time the Globally distributed database was created. An RFC3339 formatted datetime string
- time
Updated String - The time the Globally distributed database was last updated. An RFC3339 formatted datetime string
- transport
Type String - The redo transport type to use for this Data Guard association.
DistributedDatabaseDistributedDatabaseShardDetailPeerDetailMetadata, DistributedDatabaseDistributedDatabaseShardDetailPeerDetailMetadataArgs
- Map Dictionary<string, string>
- The map containing key-value pair of additional metadata.
- Map map[string]string
- The map containing key-value pair of additional metadata.
- map Map<String,String>
- The map containing key-value pair of additional metadata.
- map {[key: string]: string}
- The map containing key-value pair of additional metadata.
- map Mapping[str, str]
- The map containing key-value pair of additional metadata.
- map Map<String>
- The map containing key-value pair of additional metadata.
DistributedDatabaseDistributedDatabaseValidateNetworkDetails, DistributedDatabaseDistributedDatabaseValidateNetworkDetailsArgs
- Is
Surrogate bool - Resource
Name string - string
- The name of the shardGroup for the shard.
- Is
Surrogate bool - Resource
Name string - string
- The name of the shardGroup for the shard.
- is
Surrogate Boolean - resource
Name String - String
- The name of the shardGroup for the shard.
- is
Surrogate boolean - resource
Name string - string
- The name of the shardGroup for the shard.
- is_
surrogate bool - resource_
name str - str
- The name of the shardGroup for the shard.
- is
Surrogate Boolean - resource
Name String - String
- The name of the shardGroup for the shard.
Import
DistributedDatabases can be imported using the id, e.g.
$ pulumi import oci:oci/distributedDatabaseDistributedDatabase:DistributedDatabaseDistributedDatabase test_distributed_database "id"
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- oci pulumi/pulumi-oci
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
ociTerraform Provider.
published on Friday, Apr 3, 2026 by Pulumi
