oci.oci.getDistributedDatabaseDistributedDatabase

Oracle Cloud Infrastructure v4.5.1, Apr 3 26

Viewing docs for Oracle Cloud Infrastructure v4.5.1
published on Friday, Apr 3, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-oci

Viewing docs for Oracle Cloud Infrastructure v4.5.1
published on Friday, Apr 3, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-oci

Using getDistributedDatabaseDistributedDatabase

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getDistributedDatabaseDistributedDatabase(args: GetDistributedDatabaseDistributedDatabaseArgs, opts?: InvokeOptions): Promise<GetDistributedDatabaseDistributedDatabaseResult>
function getDistributedDatabaseDistributedDatabaseOutput(args: GetDistributedDatabaseDistributedDatabaseOutputArgs, opts?: InvokeOptions): Output<GetDistributedDatabaseDistributedDatabaseResult>

def get_distributed_database_distributed_database(distributed_database_id: Optional[str] = None,
                                                  metadata: Optional[str] = None,
                                                  opts: Optional[InvokeOptions] = None) -> GetDistributedDatabaseDistributedDatabaseResult
def get_distributed_database_distributed_database_output(distributed_database_id: Optional[pulumi.Input[str]] = None,
                                                  metadata: Optional[pulumi.Input[str]] = None,
                                                  opts: Optional[InvokeOptions] = None) -> Output[GetDistributedDatabaseDistributedDatabaseResult]

func LookupDistributedDatabaseDistributedDatabase(ctx *Context, args *LookupDistributedDatabaseDistributedDatabaseArgs, opts ...InvokeOption) (*LookupDistributedDatabaseDistributedDatabaseResult, error)
func LookupDistributedDatabaseDistributedDatabaseOutput(ctx *Context, args *LookupDistributedDatabaseDistributedDatabaseOutputArgs, opts ...InvokeOption) LookupDistributedDatabaseDistributedDatabaseResultOutput

> Note: This function is named LookupDistributedDatabaseDistributedDatabase in the Go SDK.

public static class GetDistributedDatabaseDistributedDatabase 
{
    public static Task<GetDistributedDatabaseDistributedDatabaseResult> InvokeAsync(GetDistributedDatabaseDistributedDatabaseArgs args, InvokeOptions? opts = null)
    public static Output<GetDistributedDatabaseDistributedDatabaseResult> Invoke(GetDistributedDatabaseDistributedDatabaseInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetDistributedDatabaseDistributedDatabaseResult> getDistributedDatabaseDistributedDatabase(GetDistributedDatabaseDistributedDatabaseArgs args, InvokeOptions options)
public static Output<GetDistributedDatabaseDistributedDatabaseResult> getDistributedDatabaseDistributedDatabase(GetDistributedDatabaseDistributedDatabaseArgs args, InvokeOptions options)

fn::invoke:
  function: oci:oci/getDistributedDatabaseDistributedDatabase:getDistributedDatabaseDistributedDatabase
  arguments:
    # arguments dictionary

The following arguments are supported:

DistributedDatabaseId string: Globally distributed database identifier
Metadata string: Comma separated names of argument corresponding to which metadata need to be retrived.

DistributedDatabaseId string: Globally distributed database identifier
Metadata string: Comma separated names of argument corresponding to which metadata need to be retrived.

distributedDatabaseId String: Globally distributed database identifier
metadata String: Comma separated names of argument corresponding to which metadata need to be retrived.

distributedDatabaseId string: Globally distributed database identifier
metadata string: Comma separated names of argument corresponding to which metadata need to be retrived.

distributed_database_id str: Globally distributed database identifier
metadata str: Comma separated names of argument corresponding to which metadata need to be retrived.

distributedDatabaseId String: Globally distributed database identifier
metadata String: Comma separated names of argument corresponding to which metadata need to be retrived.

getDistributedDatabaseDistributedDatabase Result

The following output properties are available:

CatalogDetails List<GetDistributedDatabaseDistributedDatabaseCatalogDetail>: Collection of catalogs associated with the Globally distributed database.
ChangeDbBackupConfigTrigger int
CharacterSet string: The character set for the database.
Chunks int: The default number of unique chunks in a shardspace. The value of chunks must be greater than 2 times the size of the largest shardgroup in any shardspace.
CompartmentId string: The OCID of the Globally distributed database compartment.
ConfigureShardingIsRebalanceRequired bool
ConfigureShardingTrigger int
ConnectionStrings List<GetDistributedDatabaseDistributedDatabaseConnectionString>: Details of Globally distributed database connection String.
DatabaseVersion string: Oracle Database version for the shards and catalog used in Globally distributed database.
DbBackupConfigs List<GetDistributedDatabaseDistributedDatabaseDbBackupConfig>: 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.
DbDeploymentType string: The distributed database deployment type.
DefinedTags Dictionary<string, string>: Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
DisplayName string: The display name of the Globally distributed database.
DistributedDatabaseId string
DownloadGsmCertificateSigningRequestTrigger int: Deprecated: This trigger/action API is deprecated.
FreeformTags Dictionary<string, string>: Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
GenerateGsmCertificateSigningRequestTrigger int: Deprecated: This trigger/action API is deprecated.
GenerateWalletDownloadedWalletContentLength int
GenerateWalletDownloadedWalletEtag string
GenerateWalletDownloadedWalletLastModified string
GenerateWalletDownloadedWalletZipBase64 string
GenerateWalletPassword string
GenerateWalletTrigger int
GsmDetails List<GetDistributedDatabaseDistributedDatabaseGsmDetail>: Collection of catalogs associated with the Globally distributed database.
GsmSshPublicKey string: The SSH public key for Global service manager instances.
Id string: The OCID of the Global service manager software image.
LatestGsmImageDetails List<GetDistributedDatabaseDistributedDatabaseLatestGsmImageDetail>: The Global service manager image details
LifecycleDetails string: The lifecycleDetails for the Globally distributed database.
ListenerPort int: The Global service manager listener port number for the Globally distributed database.
ListenerPortTls int: The TLS listener port number for Globally distributed database.
NcharacterSet string: The national character set for the database.
OnsPortLocal int: Ons local port number.
OnsPortRemote int: Ons remote port number.
PatchOperations List<GetDistributedDatabaseDistributedDatabasePatchOperation>
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.
PrivateEndpointIds List<string>: The collection of OCID of the private endpoint associated with Globally distributed autonomous database.
ReplicationFactor int: The Replication factor for RAFT replication based Globally distributed database. Currently supported values are 3, 5 and 7.
ReplicationMethod string: The Replication method for Globally distributed database. Use RAFT for Raft replication, and DG for DataGuard. If replicationMethod is not provided, it defaults to DG.
ReplicationUnit 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.
ShardDetails List<GetDistributedDatabaseDistributedDatabaseShardDetail>: Collection of shards associated with the Globally distributed database.
ShardingMethod string: Sharding Methods for the Globally distributed database.
StartDatabaseTrigger int
State string: Lifecycle states for the Globally distributed database.
StopDatabaseTrigger int
SystemTags Dictionary<string, string>: Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
TimeCreated string: The time the Globally distributed database was created. An RFC3339 formatted datetime string
TimeUpdated string: The time the Globally distributed database was last updated. An RFC3339 formatted datetime string
UploadSignedCertificateAndGenerateWalletTrigger int: Deprecated: This trigger/action API is deprecated.
ValidateNetworkDetails List<GetDistributedDatabaseDistributedDatabaseValidateNetworkDetail>
ValidateNetworkTrigger int
Metadata string: Additional metadata related to Globally distributed database resources.

CatalogDetails []GetDistributedDatabaseDistributedDatabaseCatalogDetail: Collection of catalogs associated with the Globally distributed database.
ChangeDbBackupConfigTrigger int
CharacterSet string: The character set for the database.
Chunks int: The default number of unique chunks in a shardspace. The value of chunks must be greater than 2 times the size of the largest shardgroup in any shardspace.
CompartmentId string: The OCID of the Globally distributed database compartment.
ConfigureShardingIsRebalanceRequired bool
ConfigureShardingTrigger int
ConnectionStrings []GetDistributedDatabaseDistributedDatabaseConnectionString: Details of Globally distributed database connection String.
DatabaseVersion string: Oracle Database version for the shards and catalog used in Globally distributed database.
DbBackupConfigs []GetDistributedDatabaseDistributedDatabaseDbBackupConfig: 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.
DbDeploymentType string: The distributed database deployment type.
DefinedTags map[string]string: Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
DisplayName string: The display name of the Globally distributed database.
DistributedDatabaseId string
DownloadGsmCertificateSigningRequestTrigger int: Deprecated: This trigger/action API is deprecated.
FreeformTags map[string]string: Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
GenerateGsmCertificateSigningRequestTrigger int: Deprecated: This trigger/action API is deprecated.
GenerateWalletDownloadedWalletContentLength int
GenerateWalletDownloadedWalletEtag string
GenerateWalletDownloadedWalletLastModified string
GenerateWalletDownloadedWalletZipBase64 string
GenerateWalletPassword string
GenerateWalletTrigger int
GsmDetails []GetDistributedDatabaseDistributedDatabaseGsmDetail: Collection of catalogs associated with the Globally distributed database.
GsmSshPublicKey string: The SSH public key for Global service manager instances.
Id string: The OCID of the Global service manager software image.
LatestGsmImageDetails []GetDistributedDatabaseDistributedDatabaseLatestGsmImageDetail: The Global service manager image details
LifecycleDetails string: The lifecycleDetails for the Globally distributed database.
ListenerPort int: The Global service manager listener port number for the Globally distributed database.
ListenerPortTls int: The TLS listener port number for Globally distributed database.
NcharacterSet string: The national character set for the database.
OnsPortLocal int: Ons local port number.
OnsPortRemote int: Ons remote port number.
PatchOperations []GetDistributedDatabaseDistributedDatabasePatchOperation
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.
PrivateEndpointIds []string: The collection of OCID of the private endpoint associated with Globally distributed autonomous database.
ReplicationFactor int: The Replication factor for RAFT replication based Globally distributed database. Currently supported values are 3, 5 and 7.
ReplicationMethod string: The Replication method for Globally distributed database. Use RAFT for Raft replication, and DG for DataGuard. If replicationMethod is not provided, it defaults to DG.
ReplicationUnit 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.
ShardDetails []GetDistributedDatabaseDistributedDatabaseShardDetail: Collection of shards associated with the Globally distributed database.
ShardingMethod string: Sharding Methods for the Globally distributed database.
StartDatabaseTrigger int
State string: Lifecycle states for the Globally distributed database.
StopDatabaseTrigger int
SystemTags map[string]string: Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
TimeCreated string: The time the Globally distributed database was created. An RFC3339 formatted datetime string
TimeUpdated string: The time the Globally distributed database was last updated. An RFC3339 formatted datetime string
UploadSignedCertificateAndGenerateWalletTrigger int: Deprecated: This trigger/action API is deprecated.
ValidateNetworkDetails []GetDistributedDatabaseDistributedDatabaseValidateNetworkDetail
ValidateNetworkTrigger int
Metadata string: Additional metadata related to Globally distributed database resources.

catalogDetails List<GetDistributedDatabaseDistributedDatabaseCatalogDetail>: Collection of catalogs associated with the Globally distributed database.
changeDbBackupConfigTrigger Integer
characterSet String: The character set for the database.
chunks Integer: The default number of unique chunks in a shardspace. The value of chunks must be greater than 2 times the size of the largest shardgroup in any shardspace.
compartmentId String: The OCID of the Globally distributed database compartment.
configureShardingIsRebalanceRequired Boolean
configureShardingTrigger Integer
connectionStrings List<GetDistributedDatabaseDistributedDatabaseConnectionString>: Details of Globally distributed database connection String.
databaseVersion String: Oracle Database version for the shards and catalog used in Globally distributed database.
dbBackupConfigs List<GetDistributedDatabaseDistributedDatabaseDbBackupConfig>: 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.
dbDeploymentType String: The distributed database deployment type.
definedTags Map<String,String>: Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
displayName String: The display name of the Globally distributed database.
distributedDatabaseId String
downloadGsmCertificateSigningRequestTrigger Integer: Deprecated: This trigger/action API is deprecated.
freeformTags Map<String,String>: Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
generateGsmCertificateSigningRequestTrigger Integer: Deprecated: This trigger/action API is deprecated.
generateWalletDownloadedWalletContentLength Integer
generateWalletDownloadedWalletEtag String
generateWalletDownloadedWalletLastModified String
generateWalletDownloadedWalletZipBase64 String
generateWalletPassword String
generateWalletTrigger Integer
gsmDetails List<GetDistributedDatabaseDistributedDatabaseGsmDetail>: Collection of catalogs associated with the Globally distributed database.
gsmSshPublicKey String: The SSH public key for Global service manager instances.
id String: The OCID of the Global service manager software image.
latestGsmImageDetails List<GetDistributedDatabaseDistributedDatabaseLatestGsmImageDetail>: The Global service manager image details
lifecycleDetails String: The lifecycleDetails for the Globally distributed database.
listenerPort Integer: The Global service manager listener port number for the Globally distributed database.
listenerPortTls Integer: The TLS listener port number for Globally distributed database.
ncharacterSet String: The national character set for the database.
onsPortLocal Integer: Ons local port number.
onsPortRemote Integer: Ons remote port number.
patchOperations List<GetDistributedDatabaseDistributedDatabasePatchOperation>
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.
privateEndpointIds List<String>: The collection of OCID of the private endpoint associated with Globally distributed autonomous database.
replicationFactor Integer: The Replication factor for RAFT replication based Globally distributed database. Currently supported values are 3, 5 and 7.
replicationMethod String: The Replication method for Globally distributed database. Use RAFT for Raft replication, and DG for DataGuard. If replicationMethod is not provided, it defaults to DG.
replicationUnit 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.
shardDetails List<GetDistributedDatabaseDistributedDatabaseShardDetail>: Collection of shards associated with the Globally distributed database.
shardingMethod String: Sharding Methods for the Globally distributed database.
startDatabaseTrigger Integer
state String: Lifecycle states for the Globally distributed database.
stopDatabaseTrigger Integer
systemTags Map<String,String>: Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
timeCreated String: The time the Globally distributed database was created. An RFC3339 formatted datetime string
timeUpdated String: The time the Globally distributed database was last updated. An RFC3339 formatted datetime string
uploadSignedCertificateAndGenerateWalletTrigger Integer: Deprecated: This trigger/action API is deprecated.
validateNetworkDetails List<GetDistributedDatabaseDistributedDatabaseValidateNetworkDetail>
validateNetworkTrigger Integer
metadata String: Additional metadata related to Globally distributed database resources.

catalogDetails GetDistributedDatabaseDistributedDatabaseCatalogDetail[]: Collection of catalogs associated with the Globally distributed database.
changeDbBackupConfigTrigger number
characterSet string: The character set for the database.
chunks number: The default number of unique chunks in a shardspace. The value of chunks must be greater than 2 times the size of the largest shardgroup in any shardspace.
compartmentId string: The OCID of the Globally distributed database compartment.
configureShardingIsRebalanceRequired boolean
configureShardingTrigger number
connectionStrings GetDistributedDatabaseDistributedDatabaseConnectionString[]: Details of Globally distributed database connection String.
databaseVersion string: Oracle Database version for the shards and catalog used in Globally distributed database.
dbBackupConfigs GetDistributedDatabaseDistributedDatabaseDbBackupConfig[]: 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.
dbDeploymentType string: The distributed database deployment type.
definedTags {[key: string]: string}: Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
displayName string: The display name of the Globally distributed database.
distributedDatabaseId string
downloadGsmCertificateSigningRequestTrigger number: Deprecated: This trigger/action API is deprecated.
freeformTags {[key: string]: string}: Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
generateGsmCertificateSigningRequestTrigger number: Deprecated: This trigger/action API is deprecated.
generateWalletDownloadedWalletContentLength number
generateWalletDownloadedWalletEtag string
generateWalletDownloadedWalletLastModified string
generateWalletDownloadedWalletZipBase64 string
generateWalletPassword string
generateWalletTrigger number
gsmDetails GetDistributedDatabaseDistributedDatabaseGsmDetail[]: Collection of catalogs associated with the Globally distributed database.
gsmSshPublicKey string: The SSH public key for Global service manager instances.
id string: The OCID of the Global service manager software image.
latestGsmImageDetails GetDistributedDatabaseDistributedDatabaseLatestGsmImageDetail[]: The Global service manager image details
lifecycleDetails string: The lifecycleDetails for the Globally distributed database.
listenerPort number: The Global service manager listener port number for the Globally distributed database.
listenerPortTls number: The TLS listener port number for Globally distributed database.
ncharacterSet string: The national character set for the database.
onsPortLocal number: Ons local port number.
onsPortRemote number: Ons remote port number.
patchOperations GetDistributedDatabaseDistributedDatabasePatchOperation[]
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.
privateEndpointIds string[]: The collection of OCID of the private endpoint associated with Globally distributed autonomous database.
replicationFactor number: The Replication factor for RAFT replication based Globally distributed database. Currently supported values are 3, 5 and 7.
replicationMethod string: The Replication method for Globally distributed database. Use RAFT for Raft replication, and DG for DataGuard. If replicationMethod is not provided, it defaults to DG.
replicationUnit 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.
shardDetails GetDistributedDatabaseDistributedDatabaseShardDetail[]: Collection of shards associated with the Globally distributed database.
shardingMethod string: Sharding Methods for the Globally distributed database.
startDatabaseTrigger number
state string: Lifecycle states for the Globally distributed database.
stopDatabaseTrigger number
systemTags {[key: string]: string}: Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
timeCreated string: The time the Globally distributed database was created. An RFC3339 formatted datetime string
timeUpdated string: The time the Globally distributed database was last updated. An RFC3339 formatted datetime string
uploadSignedCertificateAndGenerateWalletTrigger number: Deprecated: This trigger/action API is deprecated.
validateNetworkDetails GetDistributedDatabaseDistributedDatabaseValidateNetworkDetail[]
validateNetworkTrigger number
metadata string: Additional metadata related to Globally distributed database resources.

catalog_details Sequence[GetDistributedDatabaseDistributedDatabaseCatalogDetail]: Collection of catalogs associated with the Globally distributed database.
change_db_backup_config_trigger int
character_set str: The character set for the database.
chunks int: The default number of unique chunks in a shardspace. The value of chunks must be greater than 2 times the size of the largest shardgroup in any shardspace.
compartment_id str: The OCID of the Globally distributed database compartment.
configure_sharding_is_rebalance_required bool
configure_sharding_trigger int
connection_strings Sequence[GetDistributedDatabaseDistributedDatabaseConnectionString]: 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_configs Sequence[GetDistributedDatabaseDistributedDatabaseDbBackupConfig]: 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_type str: The distributed database deployment type.
defined_tags Mapping[str, str]: Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
display_name str: The display name of the Globally distributed database.
distributed_database_id str
download_gsm_certificate_signing_request_trigger int: Deprecated: This trigger/action API is deprecated.
freeform_tags Mapping[str, str]: 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_certificate_signing_request_trigger int: Deprecated: This trigger/action API is deprecated.
generate_wallet_downloaded_wallet_content_length int
generate_wallet_downloaded_wallet_etag str
generate_wallet_downloaded_wallet_last_modified str
generate_wallet_downloaded_wallet_zip_base64 str
generate_wallet_password str
generate_wallet_trigger int
gsm_details Sequence[GetDistributedDatabaseDistributedDatabaseGsmDetail]: Collection of catalogs associated with the Globally distributed database.
gsm_ssh_public_key str: The SSH public key for Global service manager instances.
id str: The OCID of the Global service manager software image.
latest_gsm_image_details Sequence[GetDistributedDatabaseDistributedDatabaseLatestGsmImageDetail]: The Global service manager image details
lifecycle_details str: The lifecycleDetails for the Globally distributed database.
listener_port int: The Global service manager listener port number for the Globally distributed database.
listener_port_tls int: The TLS listener port number for Globally distributed database.
ncharacter_set str: The national character set for the database.
ons_port_local int: Ons local port number.
ons_port_remote int: Ons remote port number.
patch_operations Sequence[GetDistributedDatabaseDistributedDatabasePatchOperation]
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_ids Sequence[str]: 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 replication, and DG for DataGuard. If replicationMethod is not provided, it defaults to DG.
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[GetDistributedDatabaseDistributedDatabaseShardDetail]: Collection of shards associated with the Globally distributed database.
sharding_method str: Sharding Methods for the Globally distributed database.
start_database_trigger int
state str: Lifecycle states for the Globally distributed database.
stop_database_trigger int
system_tags 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_certificate_and_generate_wallet_trigger int: Deprecated: This trigger/action API is deprecated.
validate_network_details Sequence[GetDistributedDatabaseDistributedDatabaseValidateNetworkDetail]
validate_network_trigger int
metadata str: Additional metadata related to Globally distributed database resources.

catalogDetails List<Property Map>: Collection of catalogs associated with the Globally distributed database.
changeDbBackupConfigTrigger Number
characterSet String: The character set for the database.
chunks Number: The default number of unique chunks in a shardspace. The value of chunks must be greater than 2 times the size of the largest shardgroup in any shardspace.
compartmentId String: The OCID of the Globally distributed database compartment.
configureShardingIsRebalanceRequired Boolean
configureShardingTrigger Number
connectionStrings List<Property Map>: Details of Globally distributed database connection String.
databaseVersion String: Oracle Database version for the shards and catalog used in Globally distributed database.
dbBackupConfigs List<Property Map>: Backup Options To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.
dbDeploymentType String: The distributed database deployment type.
definedTags Map<String>: Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
displayName String: The display name of the Globally distributed database.
distributedDatabaseId String
downloadGsmCertificateSigningRequestTrigger Number: Deprecated: This trigger/action API is deprecated.
freeformTags Map<String>: Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
generateGsmCertificateSigningRequestTrigger Number: Deprecated: This trigger/action API is deprecated.
generateWalletDownloadedWalletContentLength Number
generateWalletDownloadedWalletEtag String
generateWalletDownloadedWalletLastModified String
generateWalletDownloadedWalletZipBase64 String
generateWalletPassword String
generateWalletTrigger Number
gsmDetails List<Property Map>: Collection of catalogs associated with the Globally distributed database.
gsmSshPublicKey String: The SSH public key for Global service manager instances.
id String: The OCID of the Global service manager software image.
latestGsmImageDetails List<Property Map>: The Global service manager image details
lifecycleDetails String: The lifecycleDetails for the Globally distributed database.
listenerPort Number: The Global service manager listener port number for the Globally distributed database.
listenerPortTls Number: The TLS listener port number for Globally distributed database.
ncharacterSet String: The national character set for the database.
onsPortLocal Number: Ons local port number.
onsPortRemote Number: Ons remote port number.
patchOperations List<Property Map>
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.
privateEndpointIds List<String>: The collection of OCID of the private endpoint associated with Globally distributed autonomous database.
replicationFactor Number: The Replication factor for RAFT replication based Globally distributed database. Currently supported values are 3, 5 and 7.
replicationMethod String: The Replication method for Globally distributed database. Use RAFT for Raft replication, and DG for DataGuard. If replicationMethod is not provided, it defaults to DG.
replicationUnit 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.
shardDetails List<Property Map>: Collection of shards associated with the Globally distributed database.
shardingMethod String: Sharding Methods for the Globally distributed database.
startDatabaseTrigger Number
state String: Lifecycle states for the Globally distributed database.
stopDatabaseTrigger Number
systemTags Map<String>: Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
timeCreated String: The time the Globally distributed database was created. An RFC3339 formatted datetime string
timeUpdated String: The time the Globally distributed database was last updated. An RFC3339 formatted datetime string
uploadSignedCertificateAndGenerateWalletTrigger Number: Deprecated: This trigger/action API is deprecated.
validateNetworkDetails List<Property Map>
validateNetworkTrigger Number
metadata String: Additional metadata related to Globally distributed database resources.

Supporting Types

GetDistributedDatabaseDistributedDatabaseCatalogDetail

AdminPassword string
ContainerDatabaseId string: the identifier of the container database for underlying supporting resource.
DbHomeId string: The OCID of the Database Home.
KmsKeyId string: The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
KmsKeyVersionId string: The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions.
Metadatas List<GetDistributedDatabaseDistributedDatabaseCatalogDetailMetadata>: Comma separated names of argument corresponding to which metadata need to be retrived.
Name string: Name of the shard.
PeerDetails List<GetDistributedDatabaseDistributedDatabaseCatalogDetailPeerDetail>: Peer details for the shard.
PeerVmClusterIds List<string>
ShardGroup string: The name of the shardGroup for the shard.
ShardSpace 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.
Source string: The source of Globally distributed database type: Use EXADB_XS for the Globally distributed database with Exascale based distributed database.
Status string: Status of EXADB_XS based shard.
SupportingResourceId string: the identifier of the underlying supporting resource.
TimeCreated string: The time the Globally distributed database was created. An RFC3339 formatted datetime string
TimeUpdated string: The time the Globally distributed database was last updated. An RFC3339 formatted datetime string
VaultId string: The OCID of the Oracle Cloud Infrastructure vault. This parameter and kmsKeyId are required for Customer Managed Keys.
VmClusterId string: The OCID of the VmCluster.

AdminPassword string
ContainerDatabaseId string: the identifier of the container database for underlying supporting resource.
DbHomeId string: The OCID of the Database Home.
KmsKeyId string: The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
KmsKeyVersionId string: The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions.
Metadatas []GetDistributedDatabaseDistributedDatabaseCatalogDetailMetadata: Comma separated names of argument corresponding to which metadata need to be retrived.
Name string: Name of the shard.
PeerDetails []GetDistributedDatabaseDistributedDatabaseCatalogDetailPeerDetail: Peer details for the shard.
PeerVmClusterIds []string
ShardGroup string: The name of the shardGroup for the shard.
ShardSpace 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.
Source string: The source of Globally distributed database type: Use EXADB_XS for the Globally distributed database with Exascale based distributed database.
Status string: Status of EXADB_XS based shard.
SupportingResourceId string: the identifier of the underlying supporting resource.
TimeCreated string: The time the Globally distributed database was created. An RFC3339 formatted datetime string
TimeUpdated string: The time the Globally distributed database was last updated. An RFC3339 formatted datetime string
VaultId string: The OCID of the Oracle Cloud Infrastructure vault. This parameter and kmsKeyId are required for Customer Managed Keys.
VmClusterId string: The OCID of the VmCluster.

adminPassword String
containerDatabaseId String: the identifier of the container database for underlying supporting resource.
dbHomeId String: The OCID of the Database Home.
kmsKeyId String: The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
kmsKeyVersionId String: The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions.
metadatas List<GetDistributedDatabaseDistributedDatabaseCatalogDetailMetadata>: Comma separated names of argument corresponding to which metadata need to be retrived.
name String: Name of the shard.
peerDetails List<GetDistributedDatabaseDistributedDatabaseCatalogDetailPeerDetail>: Peer details for the shard.
peerVmClusterIds List<String>
shardGroup String: The name of the shardGroup for the shard.
shardSpace 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.
source String: The source of Globally distributed database type: Use EXADB_XS for the Globally distributed database with Exascale based distributed database.
status String: Status of EXADB_XS based shard.
supportingResourceId String: the identifier of the underlying supporting resource.
timeCreated String: The time the Globally distributed database was created. An RFC3339 formatted datetime string
timeUpdated String: The time the Globally distributed database was last updated. An RFC3339 formatted datetime string
vaultId String: The OCID of the Oracle Cloud Infrastructure vault. This parameter and kmsKeyId are required for Customer Managed Keys.
vmClusterId String: The OCID of the VmCluster.

adminPassword string
containerDatabaseId string: the identifier of the container database for underlying supporting resource.
dbHomeId string: The OCID of the Database Home.
kmsKeyId string: The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
kmsKeyVersionId string: The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions.
metadatas GetDistributedDatabaseDistributedDatabaseCatalogDetailMetadata[]: Comma separated names of argument corresponding to which metadata need to be retrived.
name string: Name of the shard.
peerDetails GetDistributedDatabaseDistributedDatabaseCatalogDetailPeerDetail[]: Peer details for the shard.
peerVmClusterIds string[]
shardGroup string: The name of the shardGroup for the shard.
shardSpace 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.
source string: The source of Globally distributed database type: Use EXADB_XS for the Globally distributed database with Exascale based distributed database.
status string: Status of EXADB_XS based shard.
supportingResourceId string: the identifier of the underlying supporting resource.
timeCreated string: The time the Globally distributed database was created. An RFC3339 formatted datetime string
timeUpdated string: The time the Globally distributed database was last updated. An RFC3339 formatted datetime string
vaultId string: The OCID of the Oracle Cloud Infrastructure vault. This parameter and kmsKeyId are required for Customer Managed Keys.
vmClusterId string: The OCID of the VmCluster.

admin_password str
container_database_id str: the identifier of the container database for underlying supporting resource.
db_home_id str: The OCID of the Database Home.
kms_key_id str: The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
kms_key_version_id str: The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions.
metadatas Sequence[GetDistributedDatabaseDistributedDatabaseCatalogDetailMetadata]: Comma separated names of argument corresponding to which metadata need to be retrived.
name str: Name of the shard.
peer_details Sequence[GetDistributedDatabaseDistributedDatabaseCatalogDetailPeerDetail]: Peer details for the shard.
peer_vm_cluster_ids Sequence[str]
shard_group str: The name of the shardGroup for the shard.
shard_space 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.
source str: The source of Globally distributed database type: Use EXADB_XS for the Globally distributed database with Exascale based distributed database.
status str: Status of EXADB_XS based shard.
supporting_resource_id str: 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 kmsKeyId are required for Customer Managed Keys.
vm_cluster_id str: The OCID of the VmCluster.

adminPassword String
containerDatabaseId String: the identifier of the container database for underlying supporting resource.
dbHomeId String: The OCID of the Database Home.
kmsKeyId String: The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
kmsKeyVersionId String: The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions.
metadatas List<Property Map>: Comma separated names of argument corresponding to which metadata need to be retrived.
name String: Name of the shard.
peerDetails List<Property Map>: Peer details for the shard.
peerVmClusterIds List<String>
shardGroup String: The name of the shardGroup for the shard.
shardSpace 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.
source String: The source of Globally distributed database type: Use EXADB_XS for the Globally distributed database with Exascale based distributed database.
status String: Status of EXADB_XS based shard.
supportingResourceId String: the identifier of the underlying supporting resource.
timeCreated String: The time the Globally distributed database was created. An RFC3339 formatted datetime string
timeUpdated String: The time the Globally distributed database was last updated. An RFC3339 formatted datetime string
vaultId String: The OCID of the Oracle Cloud Infrastructure vault. This parameter and kmsKeyId are required for Customer Managed Keys.
vmClusterId String: The OCID of the VmCluster.

GetDistributedDatabaseDistributedDatabaseCatalogDetailMetadata

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.

GetDistributedDatabaseDistributedDatabaseCatalogDetailPeerDetail

ContainerDatabaseId string: the identifier of the container database for underlying supporting resource.
Metadatas List<GetDistributedDatabaseDistributedDatabaseCatalogDetailPeerDetailMetadata>: Comma separated names of argument corresponding to which metadata need to be retrived.
ProtectionMode string: The protectionMode for the shard peer.
ShardGroup string: The name of the shardGroup for the shard.
Status string: Status of EXADB_XS based shard.
SupportingResourceId string: the identifier of the underlying supporting resource.
TimeCreated string: The time the Globally distributed database was created. An RFC3339 formatted datetime string
TimeUpdated string: The time the Globally distributed database was last updated. An RFC3339 formatted datetime string
TransportType string: The redo transport type to use for this Data Guard association.
VmClusterId string: The OCID of the VmCluster.

ContainerDatabaseId string: the identifier of the container database for underlying supporting resource.
Metadatas []GetDistributedDatabaseDistributedDatabaseCatalogDetailPeerDetailMetadata: Comma separated names of argument corresponding to which metadata need to be retrived.
ProtectionMode string: The protectionMode for the shard peer.
ShardGroup string: The name of the shardGroup for the shard.
Status string: Status of EXADB_XS based shard.
SupportingResourceId string: the identifier of the underlying supporting resource.
TimeCreated string: The time the Globally distributed database was created. An RFC3339 formatted datetime string
TimeUpdated string: The time the Globally distributed database was last updated. An RFC3339 formatted datetime string
TransportType string: The redo transport type to use for this Data Guard association.
VmClusterId string: The OCID of the VmCluster.

containerDatabaseId String: the identifier of the container database for underlying supporting resource.
metadatas List<GetDistributedDatabaseDistributedDatabaseCatalogDetailPeerDetailMetadata>: Comma separated names of argument corresponding to which metadata need to be retrived.
protectionMode String: The protectionMode for the shard peer.
shardGroup String: The name of the shardGroup for the shard.
status String: Status of EXADB_XS based shard.
supportingResourceId String: the identifier of the underlying supporting resource.
timeCreated String: The time the Globally distributed database was created. An RFC3339 formatted datetime string
timeUpdated String: The time the Globally distributed database was last updated. An RFC3339 formatted datetime string
transportType String: The redo transport type to use for this Data Guard association.
vmClusterId String: The OCID of the VmCluster.

containerDatabaseId string: the identifier of the container database for underlying supporting resource.
metadatas GetDistributedDatabaseDistributedDatabaseCatalogDetailPeerDetailMetadata[]: Comma separated names of argument corresponding to which metadata need to be retrived.
protectionMode string: The protectionMode for the shard peer.
shardGroup string: The name of the shardGroup for the shard.
status string: Status of EXADB_XS based shard.
supportingResourceId string: the identifier of the underlying supporting resource.
timeCreated string: The time the Globally distributed database was created. An RFC3339 formatted datetime string
timeUpdated string: The time the Globally distributed database was last updated. An RFC3339 formatted datetime string
transportType string: The redo transport type to use for this Data Guard association.
vmClusterId string: The OCID of the VmCluster.

container_database_id str: the identifier of the container database for underlying supporting resource.
metadatas Sequence[GetDistributedDatabaseDistributedDatabaseCatalogDetailPeerDetailMetadata]: Comma separated names of argument corresponding to which metadata need to be retrived.
protection_mode str: The protectionMode for the shard peer.
shard_group str: The name of the shardGroup for the shard.
status str: Status of EXADB_XS based shard.
supporting_resource_id str: 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_id str: The OCID of the VmCluster.

containerDatabaseId String: the identifier of the container database for underlying supporting resource.
metadatas List<Property Map>: Comma separated names of argument corresponding to which metadata need to be retrived.
protectionMode String: The protectionMode for the shard peer.
shardGroup String: The name of the shardGroup for the shard.
status String: Status of EXADB_XS based shard.
supportingResourceId String: the identifier of the underlying supporting resource.
timeCreated String: The time the Globally distributed database was created. An RFC3339 formatted datetime string
timeUpdated String: The time the Globally distributed database was last updated. An RFC3339 formatted datetime string
transportType String: The redo transport type to use for this Data Guard association.
vmClusterId String: The OCID of the VmCluster.

GetDistributedDatabaseDistributedDatabaseCatalogDetailPeerDetailMetadata

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.

GetDistributedDatabaseDistributedDatabaseConnectionString

AllConnectionStrings Dictionary<string, string>: Collection of connection strings.

AllConnectionStrings map[string]string: Collection of connection strings.

allConnectionStrings Map<String,String>: Collection of connection strings.

allConnectionStrings {[key: string]: string}: Collection of connection strings.

all_connection_strings Mapping[str, str]: Collection of connection strings.

allConnectionStrings Map<String>: Collection of connection strings.

GetDistributedDatabaseDistributedDatabaseDbBackupConfig

AutoBackupWindow string: Time window selected for initiating automatic backup for the database system. There are twelve available two-hour time windows. If no option is selected, a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example: SLOT_TWO
AutoFullBackupDay string: Day of the week the full backup should be applied on the database system. If no option is selected, the value is null and we will default to Sunday.
AutoFullBackupWindow string: Time window selected for initiating full backup for the database system. There are twelve available two-hour time windows. If no option is selected, the value is null and a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example: SLOT_TWO
BackupDeletionPolicy string: This defines when the backups will be deleted. - IMMEDIATE option keep the backup for predefined time i.e 72 hours and then delete permanently... - RETAIN will keep the backups as per the policy defined for database backups.
BackupDestinationDetails List<GetDistributedDatabaseDistributedDatabaseDbBackupConfigBackupDestinationDetail>: Backup destination details.
CanRunImmediateFullBackup bool: If set to true, configures automatic full backups in the local region (the region of the DB system) for the first backup run immediately.
IsAutoBackupEnabled bool: If set to true, configures automatic backups. If you previously used RMAN or dbcli to configure backups and then you switch to using the Console or the API for backups, a new backup configuration is created and associated with your database. This means that you can no longer rely on your previously configured unmanaged backups to work.
IsRemoteBackupEnabled bool: 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.
RecoveryWindowInDays int: Number of days between the current and the earliest point of recoverability covered by automatic backups. This value applies to automatic backups only. After a new automatic backup has been created, Oracle removes old automatic backups that are created before the window. When the value is updated, it is applied to all existing automatic backups.
RemoteRegion 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.

AutoBackupWindow string: Time window selected for initiating automatic backup for the database system. There are twelve available two-hour time windows. If no option is selected, a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example: SLOT_TWO
AutoFullBackupDay string: Day of the week the full backup should be applied on the database system. If no option is selected, the value is null and we will default to Sunday.
AutoFullBackupWindow string: Time window selected for initiating full backup for the database system. There are twelve available two-hour time windows. If no option is selected, the value is null and a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example: SLOT_TWO
BackupDeletionPolicy string: This defines when the backups will be deleted. - IMMEDIATE option keep the backup for predefined time i.e 72 hours and then delete permanently... - RETAIN will keep the backups as per the policy defined for database backups.
BackupDestinationDetails []GetDistributedDatabaseDistributedDatabaseDbBackupConfigBackupDestinationDetail: Backup destination details.
CanRunImmediateFullBackup bool: If set to true, configures automatic full backups in the local region (the region of the DB system) for the first backup run immediately.
IsAutoBackupEnabled bool: If set to true, configures automatic backups. If you previously used RMAN or dbcli to configure backups and then you switch to using the Console or the API for backups, a new backup configuration is created and associated with your database. This means that you can no longer rely on your previously configured unmanaged backups to work.
IsRemoteBackupEnabled bool: 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.
RecoveryWindowInDays int: Number of days between the current and the earliest point of recoverability covered by automatic backups. This value applies to automatic backups only. After a new automatic backup has been created, Oracle removes old automatic backups that are created before the window. When the value is updated, it is applied to all existing automatic backups.
RemoteRegion 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.

autoBackupWindow String: Time window selected for initiating automatic backup for the database system. There are twelve available two-hour time windows. If no option is selected, a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example: SLOT_TWO
autoFullBackupDay String: Day of the week the full backup should be applied on the database system. If no option is selected, the value is null and we will default to Sunday.
autoFullBackupWindow String: Time window selected for initiating full backup for the database system. There are twelve available two-hour time windows. If no option is selected, the value is null and a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example: SLOT_TWO
backupDeletionPolicy String: This defines when the backups will be deleted. - IMMEDIATE option keep the backup for predefined time i.e 72 hours and then delete permanently... - RETAIN will keep the backups as per the policy defined for database backups.
backupDestinationDetails List<GetDistributedDatabaseDistributedDatabaseDbBackupConfigBackupDestinationDetail>: Backup destination details.
canRunImmediateFullBackup Boolean: If set to true, configures automatic full backups in the local region (the region of the DB system) for the first backup run immediately.
isAutoBackupEnabled Boolean: If set to true, configures automatic backups. If you previously used RMAN or dbcli to configure backups and then you switch to using the Console or the API for backups, a new backup configuration is created and associated with your database. This means that you can no longer rely on your previously configured unmanaged backups to work.
isRemoteBackupEnabled Boolean: 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.
recoveryWindowInDays Integer: Number of days between the current and the earliest point of recoverability covered by automatic backups. This value applies to automatic backups only. After a new automatic backup has been created, Oracle removes old automatic backups that are created before the window. When the value is updated, it is applied to all existing automatic backups.
remoteRegion 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.

autoBackupWindow string: Time window selected for initiating automatic backup for the database system. There are twelve available two-hour time windows. If no option is selected, a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example: SLOT_TWO
autoFullBackupDay string: Day of the week the full backup should be applied on the database system. If no option is selected, the value is null and we will default to Sunday.
autoFullBackupWindow string: Time window selected for initiating full backup for the database system. There are twelve available two-hour time windows. If no option is selected, the value is null and a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example: SLOT_TWO
backupDeletionPolicy string: This defines when the backups will be deleted. - IMMEDIATE option keep the backup for predefined time i.e 72 hours and then delete permanently... - RETAIN will keep the backups as per the policy defined for database backups.
backupDestinationDetails GetDistributedDatabaseDistributedDatabaseDbBackupConfigBackupDestinationDetail[]: Backup destination details.
canRunImmediateFullBackup boolean: If set to true, configures automatic full backups in the local region (the region of the DB system) for the first backup run immediately.
isAutoBackupEnabled boolean: If set to true, configures automatic backups. If you previously used RMAN or dbcli to configure backups and then you switch to using the Console or the API for backups, a new backup configuration is created and associated with your database. This means that you can no longer rely on your previously configured unmanaged backups to work.
isRemoteBackupEnabled boolean: 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.
recoveryWindowInDays number: Number of days between the current and the earliest point of recoverability covered by automatic backups. This value applies to automatic backups only. After a new automatic backup has been created, Oracle removes old automatic backups that are created before the window. When the value is updated, it is applied to all existing automatic backups.
remoteRegion 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_window str: Time window selected for initiating automatic backup for the database system. There are twelve available two-hour time windows. If no option is selected, a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example: SLOT_TWO
auto_full_backup_day str: Day of the week the full backup should be applied on the database system. If no option is selected, the value is null and we will default to Sunday.
auto_full_backup_window str: Time window selected for initiating full backup for the database system. There are twelve available two-hour time windows. If no option is selected, the value is null and a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example: SLOT_TWO
backup_deletion_policy str: This defines when the backups will be deleted. - IMMEDIATE option keep the backup for predefined time i.e 72 hours and then delete permanently... - RETAIN will keep the backups as per the policy defined for database backups.
backup_destination_details Sequence[GetDistributedDatabaseDistributedDatabaseDbBackupConfigBackupDestinationDetail]: Backup destination details.
can_run_immediate_full_backup bool: If set to true, configures automatic full backups in the local region (the region of the DB system) for the first backup run immediately.
is_auto_backup_enabled bool: If set to true, configures automatic backups. If you previously used RMAN or dbcli to configure backups and then you switch to using the Console or the API for backups, a new backup configuration is created and associated with your database. This means that you can no longer rely on your previously configured unmanaged backups to work.
is_remote_backup_enabled bool: 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_in_days int: Number of days between the current and the earliest point of recoverability covered by automatic backups. This value applies to automatic backups only. After a new automatic backup has been created, Oracle removes old automatic backups that are created before the window. When the value is updated, it is applied to all existing automatic backups.
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.

autoBackupWindow String: Time window selected for initiating automatic backup for the database system. There are twelve available two-hour time windows. If no option is selected, a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example: SLOT_TWO
autoFullBackupDay String: Day of the week the full backup should be applied on the database system. If no option is selected, the value is null and we will default to Sunday.
autoFullBackupWindow String: Time window selected for initiating full backup for the database system. There are twelve available two-hour time windows. If no option is selected, the value is null and a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example: SLOT_TWO
backupDeletionPolicy String: This defines when the backups will be deleted. - IMMEDIATE option keep the backup for predefined time i.e 72 hours and then delete permanently... - RETAIN will keep the backups as per the policy defined for database backups.
backupDestinationDetails List<Property Map>: Backup destination details.
canRunImmediateFullBackup Boolean: If set to true, configures automatic full backups in the local region (the region of the DB system) for the first backup run immediately.
isAutoBackupEnabled Boolean: If set to true, configures automatic backups. If you previously used RMAN or dbcli to configure backups and then you switch to using the Console or the API for backups, a new backup configuration is created and associated with your database. This means that you can no longer rely on your previously configured unmanaged backups to work.
isRemoteBackupEnabled Boolean: 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.
recoveryWindowInDays Number: Number of days between the current and the earliest point of recoverability covered by automatic backups. This value applies to automatic backups only. After a new automatic backup has been created, Oracle removes old automatic backups that are created before the window. When the value is updated, it is applied to all existing automatic backups.
remoteRegion 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.

GetDistributedDatabaseDistributedDatabaseDbBackupConfigBackupDestinationDetail

DbrsPolicyId string: The OCID of the DBRS policy used for backup.
Id string: The OCID of the Global service manager software image.
InternetProxy string: Proxy URL to connect to object store.
IsRemote bool: Indicates whether the backup destination is cross-region or local region.
IsZeroDataLossEnabled bool: 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 TRUE if no value is given.
RemoteRegion 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.
Type string: Type of the database backup destination.
VpcPassword string: For a RECOVERY_APPLIANCE backup destination, the password for the VPC user that is used to access the Recovery Appliance.
VpcUser string: For a RECOVERY_APPLIANCE backup destination, the Virtual Private Catalog (VPC) user that is used to access the Recovery Appliance.

DbrsPolicyId string: The OCID of the DBRS policy used for backup.
Id string: The OCID of the Global service manager software image.
InternetProxy string: Proxy URL to connect to object store.
IsRemote bool: Indicates whether the backup destination is cross-region or local region.
IsZeroDataLossEnabled bool: 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 TRUE if no value is given.
RemoteRegion 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.
Type string: Type of the database backup destination.
VpcPassword string: For a RECOVERY_APPLIANCE backup destination, the password for the VPC user that is used to access the Recovery Appliance.
VpcUser string: For a RECOVERY_APPLIANCE backup destination, the Virtual Private Catalog (VPC) user that is used to access the Recovery Appliance.

dbrsPolicyId String: The OCID of the DBRS policy used for backup.
id String: The OCID of the Global service manager software image.
internetProxy String: Proxy URL to connect to object store.
isRemote Boolean: Indicates whether the backup destination is cross-region or local region.
isZeroDataLossEnabled Boolean: 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 TRUE if no value is given.
remoteRegion 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.
type String: Type of the database backup destination.
vpcPassword String: For a RECOVERY_APPLIANCE backup destination, the password for the VPC user that is used to access the Recovery Appliance.
vpcUser String: For a RECOVERY_APPLIANCE backup destination, the Virtual Private Catalog (VPC) user that is used to access the Recovery Appliance.

dbrsPolicyId string: The OCID of the DBRS policy used for backup.
id string: The OCID of the Global service manager software image.
internetProxy string: Proxy URL to connect to object store.
isRemote boolean: Indicates whether the backup destination is cross-region or local region.
isZeroDataLossEnabled boolean: 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 TRUE if no value is given.
remoteRegion 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.
type string: Type of the database backup destination.
vpcPassword string: For a RECOVERY_APPLIANCE backup destination, the password for the VPC user that is used to access the Recovery Appliance.
vpcUser string: For a RECOVERY_APPLIANCE backup destination, the Virtual Private Catalog (VPC) user that is used to access the Recovery Appliance.

dbrs_policy_id str: The OCID of the DBRS policy used for backup.
id str: The OCID of the Global service manager software image.
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_data_loss_enabled bool: 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 TRUE if 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.
type str: Type of the database backup destination.
vpc_password str: For a RECOVERY_APPLIANCE backup destination, the password for the VPC user that is used to access the Recovery Appliance.
vpc_user str: For a RECOVERY_APPLIANCE backup destination, the Virtual Private Catalog (VPC) user that is used to access the Recovery Appliance.

dbrsPolicyId String: The OCID of the DBRS policy used for backup.
id String: The OCID of the Global service manager software image.
internetProxy String: Proxy URL to connect to object store.
isRemote Boolean: Indicates whether the backup destination is cross-region or local region.
isZeroDataLossEnabled Boolean: 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 TRUE if no value is given.
remoteRegion 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.
type String: Type of the database backup destination.
vpcPassword String: For a RECOVERY_APPLIANCE backup destination, the password for the VPC user that is used to access the Recovery Appliance.
vpcUser String: For a RECOVERY_APPLIANCE backup destination, the Virtual Private Catalog (VPC) user that is used to access the Recovery Appliance.

GetDistributedDatabaseDistributedDatabaseGsmDetail

ComputeCount double: The compute count for the Global service manager instance.
DataStorageSizeInGbs double: The data disk group size to be allocated in GBs for the Global service manager instance.
GsmImageDetails List<GetDistributedDatabaseDistributedDatabaseGsmDetailGsmImageDetail>: The Global service manager image details
Metadatas List<GetDistributedDatabaseDistributedDatabaseGsmDetailMetadata>: Comma separated names of argument corresponding to which metadata need to be retrived.
Name string: Name of the shard.
Status string: Status of EXADB_XS based shard.
SupportingResourceId string: the identifier of the underlying supporting resource.
TimeCreated string: The time the Globally distributed database was created. An RFC3339 formatted datetime string
TimeSslCertificateExpires string: The time the ssl certificate associated with Global service manager expires. An RFC3339 formatted datetime string
TimeUpdated string: The time the Globally distributed database was last updated. An RFC3339 formatted datetime string

ComputeCount float64: The compute count for the Global service manager instance.
DataStorageSizeInGbs float64: The data disk group size to be allocated in GBs for the Global service manager instance.
GsmImageDetails []GetDistributedDatabaseDistributedDatabaseGsmDetailGsmImageDetail: The Global service manager image details
Metadatas []GetDistributedDatabaseDistributedDatabaseGsmDetailMetadata: Comma separated names of argument corresponding to which metadata need to be retrived.
Name string: Name of the shard.
Status string: Status of EXADB_XS based shard.
SupportingResourceId string: the identifier of the underlying supporting resource.
TimeCreated string: The time the Globally distributed database was created. An RFC3339 formatted datetime string
TimeSslCertificateExpires string: The time the ssl certificate associated with Global service manager expires. An RFC3339 formatted datetime string
TimeUpdated string: The time the Globally distributed database was last updated. An RFC3339 formatted datetime string

computeCount Double: The compute count for the Global service manager instance.
dataStorageSizeInGbs Double: The data disk group size to be allocated in GBs for the Global service manager instance.
gsmImageDetails List<GetDistributedDatabaseDistributedDatabaseGsmDetailGsmImageDetail>: The Global service manager image details
metadatas List<GetDistributedDatabaseDistributedDatabaseGsmDetailMetadata>: Comma separated names of argument corresponding to which metadata need to be retrived.
name String: Name of the shard.
status String: Status of EXADB_XS based shard.
supportingResourceId String: the identifier of the underlying supporting resource.
timeCreated String: The time the Globally distributed database was created. An RFC3339 formatted datetime string
timeSslCertificateExpires String: The time the ssl certificate associated with Global service manager expires. An RFC3339 formatted datetime string
timeUpdated String: The time the Globally distributed database was last updated. An RFC3339 formatted datetime string

computeCount number: The compute count for the Global service manager instance.
dataStorageSizeInGbs number: The data disk group size to be allocated in GBs for the Global service manager instance.
gsmImageDetails GetDistributedDatabaseDistributedDatabaseGsmDetailGsmImageDetail[]: The Global service manager image details
metadatas GetDistributedDatabaseDistributedDatabaseGsmDetailMetadata[]: Comma separated names of argument corresponding to which metadata need to be retrived.
name string: Name of the shard.
status string: Status of EXADB_XS based shard.
supportingResourceId string: the identifier of the underlying supporting resource.
timeCreated string: The time the Globally distributed database was created. An RFC3339 formatted datetime string
timeSslCertificateExpires string: The time the ssl certificate associated with Global service manager expires. An RFC3339 formatted datetime string
timeUpdated 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_size_in_gbs float: The data disk group size to be allocated in GBs for the Global service manager instance.
gsm_image_details Sequence[GetDistributedDatabaseDistributedDatabaseGsmDetailGsmImageDetail]: The Global service manager image details
metadatas Sequence[GetDistributedDatabaseDistributedDatabaseGsmDetailMetadata]: Comma separated names of argument corresponding to which metadata need to be retrived.
name str: Name of the shard.
status str: Status of EXADB_XS based shard.
supporting_resource_id str: 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_certificate_expires str: 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

computeCount Number: The compute count for the Global service manager instance.
dataStorageSizeInGbs Number: The data disk group size to be allocated in GBs for the Global service manager instance.
gsmImageDetails List<Property Map>: The Global service manager image details
metadatas List<Property Map>: Comma separated names of argument corresponding to which metadata need to be retrived.
name String: Name of the shard.
status String: Status of EXADB_XS based shard.
supportingResourceId String: the identifier of the underlying supporting resource.
timeCreated String: The time the Globally distributed database was created. An RFC3339 formatted datetime string
timeSslCertificateExpires String: The time the ssl certificate associated with Global service manager expires. An RFC3339 formatted datetime string
timeUpdated String: The time the Globally distributed database was last updated. An RFC3339 formatted datetime string

GetDistributedDatabaseDistributedDatabaseGsmDetailGsmImageDetail

Id string: The OCID of the Global service manager software image.
VersionNumber int: The version number associated with the image identified by id.

Id string: The OCID of the Global service manager software image.
VersionNumber int: The version number associated with the image identified by id.

id String: The OCID of the Global service manager software image.
versionNumber Integer: The version number associated with the image identified by id.

id string: The OCID of the Global service manager software image.
versionNumber 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.
versionNumber Number: The version number associated with the image identified by id.

GetDistributedDatabaseDistributedDatabaseGsmDetailMetadata

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.

GetDistributedDatabaseDistributedDatabaseLatestGsmImageDetail

Id string: The OCID of the Global service manager software image.
VersionNumber int: The version number associated with the image identified by id.

Id string: The OCID of the Global service manager software image.
VersionNumber int: The version number associated with the image identified by id.

id String: The OCID of the Global service manager software image.
versionNumber Integer: The version number associated with the image identified by id.

id string: The OCID of the Global service manager software image.
versionNumber 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.
versionNumber Number: The version number associated with the image identified by id.

GetDistributedDatabaseDistributedDatabasePatchOperation

Operation string
Selection string
Value string

Operation string
Selection string
Value string

operation String
selection String
value String

operation string
selection string
value string

operation str
selection str
value str

operation String
selection String
value String

GetDistributedDatabaseDistributedDatabaseShardDetail

AdminPassword string
ContainerDatabaseId string: the identifier of the container database for underlying supporting resource.
DbHomeId string: The OCID of the Database Home.
KmsKeyId string: The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
KmsKeyVersionId string: The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions.
Metadatas List<GetDistributedDatabaseDistributedDatabaseShardDetailMetadata>: Comma separated names of argument corresponding to which metadata need to be retrived.
Name string: Name of the shard.
PeerDetails List<GetDistributedDatabaseDistributedDatabaseShardDetailPeerDetail>: Peer details for the shard.
PeerVmClusterIds List<string>
ShardGroup string: The name of the shardGroup for the shard.
ShardSpace 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.
Source string: The source of Globally distributed database type: Use EXADB_XS for the Globally distributed database with Exascale based distributed database.
Status string: Status of EXADB_XS based shard.
SupportingResourceId string: the identifier of the underlying supporting resource.
TimeCreated string: The time the Globally distributed database was created. An RFC3339 formatted datetime string
TimeUpdated string: The time the Globally distributed database was last updated. An RFC3339 formatted datetime string
VaultId string: The OCID of the Oracle Cloud Infrastructure vault. This parameter and kmsKeyId are required for Customer Managed Keys.
VmClusterId string: The OCID of the VmCluster.

AdminPassword string
ContainerDatabaseId string: the identifier of the container database for underlying supporting resource.
DbHomeId string: The OCID of the Database Home.
KmsKeyId string: The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
KmsKeyVersionId string: The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions.
Metadatas []GetDistributedDatabaseDistributedDatabaseShardDetailMetadata: Comma separated names of argument corresponding to which metadata need to be retrived.
Name string: Name of the shard.
PeerDetails []GetDistributedDatabaseDistributedDatabaseShardDetailPeerDetail: Peer details for the shard.
PeerVmClusterIds []string
ShardGroup string: The name of the shardGroup for the shard.
ShardSpace 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.
Source string: The source of Globally distributed database type: Use EXADB_XS for the Globally distributed database with Exascale based distributed database.
Status string: Status of EXADB_XS based shard.
SupportingResourceId string: the identifier of the underlying supporting resource.
TimeCreated string: The time the Globally distributed database was created. An RFC3339 formatted datetime string
TimeUpdated string: The time the Globally distributed database was last updated. An RFC3339 formatted datetime string
VaultId string: The OCID of the Oracle Cloud Infrastructure vault. This parameter and kmsKeyId are required for Customer Managed Keys.
VmClusterId string: The OCID of the VmCluster.

adminPassword String
containerDatabaseId String: the identifier of the container database for underlying supporting resource.
dbHomeId String: The OCID of the Database Home.
kmsKeyId String: The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
kmsKeyVersionId String: The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions.
metadatas List<GetDistributedDatabaseDistributedDatabaseShardDetailMetadata>: Comma separated names of argument corresponding to which metadata need to be retrived.
name String: Name of the shard.
peerDetails List<GetDistributedDatabaseDistributedDatabaseShardDetailPeerDetail>: Peer details for the shard.
peerVmClusterIds List<String>
shardGroup String: The name of the shardGroup for the shard.
shardSpace 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.
source String: The source of Globally distributed database type: Use EXADB_XS for the Globally distributed database with Exascale based distributed database.
status String: Status of EXADB_XS based shard.
supportingResourceId String: the identifier of the underlying supporting resource.
timeCreated String: The time the Globally distributed database was created. An RFC3339 formatted datetime string
timeUpdated String: The time the Globally distributed database was last updated. An RFC3339 formatted datetime string
vaultId String: The OCID of the Oracle Cloud Infrastructure vault. This parameter and kmsKeyId are required for Customer Managed Keys.
vmClusterId String: The OCID of the VmCluster.

adminPassword string
containerDatabaseId string: the identifier of the container database for underlying supporting resource.
dbHomeId string: The OCID of the Database Home.
kmsKeyId string: The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
kmsKeyVersionId string: The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions.
metadatas GetDistributedDatabaseDistributedDatabaseShardDetailMetadata[]: Comma separated names of argument corresponding to which metadata need to be retrived.
name string: Name of the shard.
peerDetails GetDistributedDatabaseDistributedDatabaseShardDetailPeerDetail[]: Peer details for the shard.
peerVmClusterIds string[]
shardGroup string: The name of the shardGroup for the shard.
shardSpace 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.
source string: The source of Globally distributed database type: Use EXADB_XS for the Globally distributed database with Exascale based distributed database.
status string: Status of EXADB_XS based shard.
supportingResourceId string: the identifier of the underlying supporting resource.
timeCreated string: The time the Globally distributed database was created. An RFC3339 formatted datetime string
timeUpdated string: The time the Globally distributed database was last updated. An RFC3339 formatted datetime string
vaultId string: The OCID of the Oracle Cloud Infrastructure vault. This parameter and kmsKeyId are required for Customer Managed Keys.
vmClusterId string: The OCID of the VmCluster.

admin_password str
container_database_id str: the identifier of the container database for underlying supporting resource.
db_home_id str: The OCID of the Database Home.
kms_key_id str: The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
kms_key_version_id str: The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions.
metadatas Sequence[GetDistributedDatabaseDistributedDatabaseShardDetailMetadata]: Comma separated names of argument corresponding to which metadata need to be retrived.
name str: Name of the shard.
peer_details Sequence[GetDistributedDatabaseDistributedDatabaseShardDetailPeerDetail]: Peer details for the shard.
peer_vm_cluster_ids Sequence[str]
shard_group str: The name of the shardGroup for the shard.
shard_space 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.
source str: The source of Globally distributed database type: Use EXADB_XS for the Globally distributed database with Exascale based distributed database.
status str: Status of EXADB_XS based shard.
supporting_resource_id str: 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 kmsKeyId are required for Customer Managed Keys.
vm_cluster_id str: The OCID of the VmCluster.

adminPassword String
containerDatabaseId String: the identifier of the container database for underlying supporting resource.
dbHomeId String: The OCID of the Database Home.
kmsKeyId String: The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
kmsKeyVersionId String: The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions.
metadatas List<Property Map>: Comma separated names of argument corresponding to which metadata need to be retrived.
name String: Name of the shard.
peerDetails List<Property Map>: Peer details for the shard.
peerVmClusterIds List<String>
shardGroup String: The name of the shardGroup for the shard.
shardSpace 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.
source String: The source of Globally distributed database type: Use EXADB_XS for the Globally distributed database with Exascale based distributed database.
status String: Status of EXADB_XS based shard.
supportingResourceId String: the identifier of the underlying supporting resource.
timeCreated String: The time the Globally distributed database was created. An RFC3339 formatted datetime string
timeUpdated String: The time the Globally distributed database was last updated. An RFC3339 formatted datetime string
vaultId String: The OCID of the Oracle Cloud Infrastructure vault. This parameter and kmsKeyId are required for Customer Managed Keys.
vmClusterId String: The OCID of the VmCluster.

GetDistributedDatabaseDistributedDatabaseShardDetailMetadata

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.

GetDistributedDatabaseDistributedDatabaseShardDetailPeerDetail

ContainerDatabaseId string: the identifier of the container database for underlying supporting resource.
Metadatas List<GetDistributedDatabaseDistributedDatabaseShardDetailPeerDetailMetadata>: Comma separated names of argument corresponding to which metadata need to be retrived.
ProtectionMode string: The protectionMode for the shard peer.
ShardGroup string: The name of the shardGroup for the shard.
Status string: Status of EXADB_XS based shard.
SupportingResourceId string: the identifier of the underlying supporting resource.
TimeCreated string: The time the Globally distributed database was created. An RFC3339 formatted datetime string
TimeUpdated string: The time the Globally distributed database was last updated. An RFC3339 formatted datetime string
TransportType string: The redo transport type to use for this Data Guard association.
VmClusterId string: The OCID of the VmCluster.

ContainerDatabaseId string: the identifier of the container database for underlying supporting resource.
Metadatas []GetDistributedDatabaseDistributedDatabaseShardDetailPeerDetailMetadata: Comma separated names of argument corresponding to which metadata need to be retrived.
ProtectionMode string: The protectionMode for the shard peer.
ShardGroup string: The name of the shardGroup for the shard.
Status string: Status of EXADB_XS based shard.
SupportingResourceId string: the identifier of the underlying supporting resource.
TimeCreated string: The time the Globally distributed database was created. An RFC3339 formatted datetime string
TimeUpdated string: The time the Globally distributed database was last updated. An RFC3339 formatted datetime string
TransportType string: The redo transport type to use for this Data Guard association.
VmClusterId string: The OCID of the VmCluster.

containerDatabaseId String: the identifier of the container database for underlying supporting resource.
metadatas List<GetDistributedDatabaseDistributedDatabaseShardDetailPeerDetailMetadata>: Comma separated names of argument corresponding to which metadata need to be retrived.
protectionMode String: The protectionMode for the shard peer.
shardGroup String: The name of the shardGroup for the shard.
status String: Status of EXADB_XS based shard.
supportingResourceId String: the identifier of the underlying supporting resource.
timeCreated String: The time the Globally distributed database was created. An RFC3339 formatted datetime string
timeUpdated String: The time the Globally distributed database was last updated. An RFC3339 formatted datetime string
transportType String: The redo transport type to use for this Data Guard association.
vmClusterId String: The OCID of the VmCluster.

containerDatabaseId string: the identifier of the container database for underlying supporting resource.
metadatas GetDistributedDatabaseDistributedDatabaseShardDetailPeerDetailMetadata[]: Comma separated names of argument corresponding to which metadata need to be retrived.
protectionMode string: The protectionMode for the shard peer.
shardGroup string: The name of the shardGroup for the shard.
status string: Status of EXADB_XS based shard.
supportingResourceId string: the identifier of the underlying supporting resource.
timeCreated string: The time the Globally distributed database was created. An RFC3339 formatted datetime string
timeUpdated string: The time the Globally distributed database was last updated. An RFC3339 formatted datetime string
transportType string: The redo transport type to use for this Data Guard association.
vmClusterId string: The OCID of the VmCluster.

container_database_id str: the identifier of the container database for underlying supporting resource.
metadatas Sequence[GetDistributedDatabaseDistributedDatabaseShardDetailPeerDetailMetadata]: Comma separated names of argument corresponding to which metadata need to be retrived.
protection_mode str: The protectionMode for the shard peer.
shard_group str: The name of the shardGroup for the shard.
status str: Status of EXADB_XS based shard.
supporting_resource_id str: 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_id str: The OCID of the VmCluster.

containerDatabaseId String: the identifier of the container database for underlying supporting resource.
metadatas List<Property Map>: Comma separated names of argument corresponding to which metadata need to be retrived.
protectionMode String: The protectionMode for the shard peer.
shardGroup String: The name of the shardGroup for the shard.
status String: Status of EXADB_XS based shard.
supportingResourceId String: the identifier of the underlying supporting resource.
timeCreated String: The time the Globally distributed database was created. An RFC3339 formatted datetime string
timeUpdated String: The time the Globally distributed database was last updated. An RFC3339 formatted datetime string
transportType String: The redo transport type to use for this Data Guard association.
vmClusterId String: The OCID of the VmCluster.

GetDistributedDatabaseDistributedDatabaseShardDetailPeerDetailMetadata

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.

GetDistributedDatabaseDistributedDatabaseValidateNetworkDetail

IsSurrogate bool
ResourceName string
ShardGroup string: The name of the shardGroup for the shard.

IsSurrogate bool
ResourceName string
ShardGroup string: The name of the shardGroup for the shard.

isSurrogate Boolean
resourceName String
shardGroup String: The name of the shardGroup for the shard.

isSurrogate boolean
resourceName string
shardGroup string: The name of the shardGroup for the shard.

is_surrogate bool
resource_name str
shard_group str: The name of the shardGroup for the shard.

isSurrogate Boolean
resourceName String
shardGroup String: The name of the shardGroup for the shard.

Package Details

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

Viewing docs for Oracle Cloud Infrastructure v4.5.1
published on Friday, Apr 3, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-oci

oci.oci.getDistributedDatabaseDistributedDatabase

On this page

On this page

Using getDistributedDatabaseDistributedDatabase

getDistributedDatabaseDistributedDatabase Result

Supporting Types

GetDistributedDatabaseDistributedDatabaseCatalogDetail

GetDistributedDatabaseDistributedDatabaseCatalogDetailMetadata

GetDistributedDatabaseDistributedDatabaseCatalogDetailPeerDetail

GetDistributedDatabaseDistributedDatabaseCatalogDetailPeerDetailMetadata

GetDistributedDatabaseDistributedDatabaseConnectionString

GetDistributedDatabaseDistributedDatabaseDbBackupConfig

GetDistributedDatabaseDistributedDatabaseDbBackupConfigBackupDestinationDetail

GetDistributedDatabaseDistributedDatabaseGsmDetail

GetDistributedDatabaseDistributedDatabaseGsmDetailGsmImageDetail

GetDistributedDatabaseDistributedDatabaseGsmDetailMetadata

GetDistributedDatabaseDistributedDatabaseLatestGsmImageDetail

GetDistributedDatabaseDistributedDatabasePatchOperation

GetDistributedDatabaseDistributedDatabaseShardDetail

GetDistributedDatabaseDistributedDatabaseShardDetailMetadata

GetDistributedDatabaseDistributedDatabaseShardDetailPeerDetail

GetDistributedDatabaseDistributedDatabaseShardDetailPeerDetailMetadata

GetDistributedDatabaseDistributedDatabaseValidateNetworkDetail

Package Details

On this page

On this page