Class DistributedDatabase

[JsonProperty(PropertyName = "autoResourceManagementConfig")]
public AutoResourceManagementConfigurationDetails AutoResourceManagementConfig { get; set; }

Property Value

Type	Description
AutoResourceManagementConfigurationDetails

CatalogDetails

Declaration

[JsonProperty(PropertyName = "catalogDetails")]
public List<DistributedDatabaseCatalog> CatalogDetails { get; set; }

Property Value

Type	Description
List<DistributedDatabaseCatalog>	Catalog details associated with the distributed database.

CharacterSet

Declaration

[Required(ErrorMessage = "CharacterSet is required.")]
[JsonProperty(PropertyName = "characterSet")]
public string CharacterSet { get; set; }

Property Value

Type	Description
string	The character set for the database.

Remarks

Required

CompartmentId

Declaration

[Required(ErrorMessage = "CompartmentId is required.")]
[JsonProperty(PropertyName = "compartmentId")]
public string CompartmentId { get; set; }

Property Value

Type	Description
string	The OCID of the Globally distributed database compartment.

Remarks

Required

CompositeDataGuardShardSpaces

Declaration

[JsonProperty(PropertyName = "compositeDataGuardShardSpaces")]
public List<CompositeDataGuardShardSpace> CompositeDataGuardShardSpaces { get; set; }

Property Value

Type	Description
List<CompositeDataGuardShardSpace>	Collection of composite data guard shard spaces.

CompositeRaftShardSpaces

Declaration

[JsonProperty(PropertyName = "compositeRaftShardSpaces")]
public List<CompositeRaftShardSpace> CompositeRaftShardSpaces { get; set; }

Property Value

Type	Description
List<CompositeRaftShardSpace>	Collection of composite raft shards.

ConnectionStrings

Declaration

[JsonProperty(PropertyName = "connectionStrings")]
public DistributedDbConnectionString ConnectionStrings { get; set; }

Property Value

Type	Description
DistributedDbConnectionString

DatabaseVersion

Declaration

[Required(ErrorMessage = "DatabaseVersion is required.")]
[JsonProperty(PropertyName = "databaseVersion")]
public string DatabaseVersion { get; set; }

Property Value

Type	Description
string	Oracle Database version for the shards and catalog used in Globally distributed database.

Remarks

Required

DbBackupConfig

Declaration

[JsonProperty(PropertyName = "dbBackupConfig")]
public DistributedDbBackupConfig DbBackupConfig { get; set; }

Property Value

Type	Description
DistributedDbBackupConfig

DbDeploymentType

Declaration

[Required(ErrorMessage = "DbDeploymentType is required.")]
[JsonProperty(PropertyName = "dbDeploymentType")]
[JsonConverter(typeof(ResponseEnumConverter))]
public DistributedDatabase.DbDeploymentTypeEnum? DbDeploymentType { get; set; }

Property Value

Type	Description
DistributedDatabase.DbDeploymentTypeEnum?	The distributed database deployment type.

Remarks

Required

DefinedTags

Declaration

[JsonProperty(PropertyName = "definedTags")]
public Dictionary<string, Dictionary<string, object>> DefinedTags { get; set; }

Property Value

Type	Description
Dictionary<string, Dictionary<string, object>>	Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}}

DisplayName

Declaration

[Required(ErrorMessage = "DisplayName is required.")]
[JsonProperty(PropertyName = "displayName")]
public string DisplayName { get; set; }

Property Value

Type	Description
string	The display name of the Globally distributed database.

Remarks

Required

FreeformTags

Declaration

[JsonProperty(PropertyName = "freeformTags")]
public Dictionary<string, string> FreeformTags { get; set; }

Property Value

Type	Description
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"}

GdsControlNodeDetails

Declaration

[JsonProperty(PropertyName = "gdsControlNodeDetails")]
public List<DistributedDatabaseGdsControlNode> GdsControlNodeDetails { get; set; }

Property Value

Type	Description
List<DistributedDatabaseGdsControlNode>	Global Database Services Control(GDS CTL) instances associated with the distributed database.

GsmDetails

Declaration

[JsonProperty(PropertyName = "gsmDetails")]
public List<DistributedDatabaseGsm> GsmDetails { get; set; }

Property Value

Type	Description
List<DistributedDatabaseGsm>	Global Service Manager (GSM) instances associated with the distributed database.

GsmSshPublicKey

Declaration

[JsonProperty(PropertyName = "gsmSshPublicKey")]
public string GsmSshPublicKey { get; set; }

Property Value

Type	Description
string	The SSH public key for Global service manager instances.

Id

Declaration

[Required(ErrorMessage = "Id is required.")]
[JsonProperty(PropertyName = "id")]
public string Id { get; set; }

Property Value

Type	Description
string	The OCID of the Globally distributed database.

Remarks

Required

LatestGsmImageDetails

Declaration

[JsonProperty(PropertyName = "latestGsmImageDetails")]
public DistributedDbGsmImage LatestGsmImageDetails { get; set; }

Property Value

Type	Description
DistributedDbGsmImage

LifecycleDetails

Declaration

[Required(ErrorMessage = "LifecycleDetails is required.")]
[JsonProperty(PropertyName = "lifecycleDetails")]
public string LifecycleDetails { get; set; }

Property Value

Type	Description
string	The lifecycleDetails for the Globally distributed database.

Remarks

Required

LifecycleState

Declaration

[Required(ErrorMessage = "LifecycleState is required.")]
[JsonProperty(PropertyName = "lifecycleState")]
[JsonConverter(typeof(ResponseEnumConverter))]
public DistributedDatabase.LifecycleStateEnum? LifecycleState { get; set; }

Property Value

Type	Description
DistributedDatabase.LifecycleStateEnum?	Lifecycle states for the Globally distributed database.

Remarks

Required

ListenerPort

Declaration

[Required(ErrorMessage = "ListenerPort is required.")]
[JsonProperty(PropertyName = "listenerPort")]
public int? ListenerPort { get; set; }

Property Value

Type	Description
int?	The Global service manager listener port number for the Globally distributed database.

Remarks

Required

ListenerPortTls

Declaration

[JsonProperty(PropertyName = "listenerPortTls")]
public int? ListenerPortTls { get; set; }

Property Value

Type	Description
int?	The TLS listener port number for Globally distributed database.

Metadata

Declaration

[JsonProperty(PropertyName = "metadata")]
public DistributedDbMetadata Metadata { get; set; }

Property Value

Type	Description
DistributedDbMetadata

NcharacterSet

Declaration

[Required(ErrorMessage = "NcharacterSet is required.")]
[JsonProperty(PropertyName = "ncharacterSet")]
public string NcharacterSet { get; set; }

Property Value

Type	Description
string	The national character set for the database.

Remarks

Required

NotificationTopicIds

Declaration

[JsonProperty(PropertyName = "notificationTopicIds")]
public List<string> NotificationTopicIds { get; set; }

Property Value

Type	Description
List<string>	The collection of OCID for the notification topics associated with the globally distributed database.

OnsPortLocal

Declaration

[Required(ErrorMessage = "OnsPortLocal is required.")]
[JsonProperty(PropertyName = "onsPortLocal")]
public int? OnsPortLocal { get; set; }

Property Value

Type	Description
int?	Ons local port number.

Remarks

Required

OnsPortRemote

Declaration

[Required(ErrorMessage = "OnsPortRemote is required.")]
[JsonProperty(PropertyName = "onsPortRemote")]
public int? OnsPortRemote { get; set; }

Property Value

Type	Description
int?	Ons remote port number.

Remarks

Required

Prefix

Declaration

[Required(ErrorMessage = "Prefix is required.")]
[JsonProperty(PropertyName = "prefix")]
public string Prefix { get; set; }

Property Value

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

Remarks

Required

PrivateEndpointIds

Declaration

[Required(ErrorMessage = "PrivateEndpointIds is required.")]
[JsonProperty(PropertyName = "privateEndpointIds")]
public List<string> PrivateEndpointIds { get; set; }

Property Value

Type	Description
List<string>	The collection of OCID of the private endpoint associated with Globally distributed autonomous database.

Remarks

Required

ReplicationMethod

Declaration

[JsonProperty(PropertyName = "replicationMethod")]
[JsonConverter(typeof(ResponseEnumConverter))]
public DistributedDatabase.ReplicationMethodEnum? ReplicationMethod { get; set; }

Property Value

Type	Description
DistributedDatabase.ReplicationMethodEnum?	The Replication method for Globally distributed database. Use RAFT for Raft based replication. With RAFT replication, shards cannot have peers details set on them. In case shards need to have peers, please do not set RAFT replicationMethod. For all non RAFT replication cases (with or without peers), please set replicationMethod as DG or do not set any value for replicationMethod.

ScanListenerPort

Declaration

[JsonProperty(PropertyName = "scanListenerPort")]
public int? ScanListenerPort { get; set; }

Property Value

Type	Description
int?	The TCP SCAN listener port for database clusters with source type XS_NEW_VAULT_AND_CLUSTER or XS_NEW_CLUSTER.

ShardingMethod

Declaration

[Required(ErrorMessage = "ShardingMethod is required.")]
[JsonProperty(PropertyName = "shardingMethod")]
[JsonConverter(typeof(ResponseEnumConverter))]
public DistributedDatabase.ShardingMethodEnum? ShardingMethod { get; set; }

Property Value

Type	Description
DistributedDatabase.ShardingMethodEnum?	Sharding methods for the Globally distributed database.

Remarks

Required

SystemChunkCount

Declaration

[JsonProperty(PropertyName = "systemChunkCount")]
public int? SystemChunkCount { get; set; }

Property Value

Type	Description
int?	Count of chunks associated with system raft clusters or system data guard databases.

SystemDataGuardDatabases

Declaration

[JsonProperty(PropertyName = "systemDataGuardDatabases")]
public SystemDataGuardDatabase SystemDataGuardDatabases { get; set; }

Property Value

Type	Description
SystemDataGuardDatabase

SystemRaftClusters

Declaration

[JsonProperty(PropertyName = "systemRaftClusters")]
public List<SystemRaftCluster> SystemRaftClusters { get; set; }

Property Value

Type	Description
List<SystemRaftCluster>	Collection of system raft clusters.

SystemRaftReplicationUnitCount

Declaration

[JsonProperty(PropertyName = "systemRaftReplicationUnitCount")]
public int? SystemRaftReplicationUnitCount { get; set; }

Property Value

Type	Description
int?	Number of replication units associated with system raft clusters.

SystemTags

Declaration

[JsonProperty(PropertyName = "systemTags")]
public Dictionary<string, Dictionary<string, object>> SystemTags { get; set; }

Property Value

Type	Description
Dictionary<string, Dictionary<string, object>>	Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud": {"free-tier-retained": "true"}}

TimeCreated

Declaration

[Required(ErrorMessage = "TimeCreated is required.")]
[JsonProperty(PropertyName = "timeCreated")]
public DateTime? TimeCreated { get; set; }

Property Value

Type	Description
DateTime?	The time the Globally distributed database was created. An RFC3339 formatted datetime string.

Remarks

Required

TimeUpdated

Declaration

[Required(ErrorMessage = "TimeUpdated is required.")]
[JsonProperty(PropertyName = "timeUpdated")]
public DateTime? TimeUpdated { get; set; }

Property Value

Type	Description
DateTime?	The time the Globally distributed database was last updated. An RFC3339 formatted datetime string.

Remarks

Required

UserShardSpaces

Declaration

[JsonProperty(PropertyName = "userShardSpaces")]
public List<UserShardSpace> UserShardSpaces { get; set; }

Property Value

Type	Description
List<UserShardSpace>	Collection of user defined shard spaces.

VcnNsgIds

Declaration

[JsonProperty(PropertyName = "vcnNsgIds")]
public List<VcnNsgIdsDetails> VcnNsgIds { get; set; }

Property Value

Type	Description
List<VcnNsgIdsDetails>	The list of network security group (NSG) details associated with the distributed database.