Class CreateDistributedDatabaseDetails
Details required for creation of the Globally distributed database.
Inherited Members
Namespace: Oci.Distributeddatabasev26Service.Models
Assembly: OCI.DotNetSDK.Distributeddatabasev26.dll
Syntax
public class CreateDistributedDatabaseDetails
Properties
CatalogDetails
Declaration
[Required(ErrorMessage = "CatalogDetails is required.")]
[JsonProperty(PropertyName = "catalogDetails")]
public List<CreateDistributedDatabaseCatalogDetails> CatalogDetails { get; set; }
Property Value
| Type | Description |
|---|---|
| List<CreateDistributedDatabaseCatalogDetails> | Collection of catalog details for the Globally distributed database. |
Remarks
Required
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<CreateCompositeDataGuardShardSpaceDetails> CompositeDataGuardShardSpaces { get; set; }
Property Value
| Type | Description |
|---|---|
| List<CreateCompositeDataGuardShardSpaceDetails> | Collection of composite data guard shard spaces. |
CompositeRaftShardSpaces
Declaration
[JsonProperty(PropertyName = "compositeRaftShardSpaces")]
public List<CreateCompositeRaftShardSpaceDetails> CompositeRaftShardSpaces { get; set; }
Property Value
| Type | Description |
|---|---|
| List<CreateCompositeRaftShardSpaceDetails> | Collection of composite raft shards. |
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 |
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"} |
GsmSshPublicKey
Declaration
[JsonProperty(PropertyName = "gsmSshPublicKey")]
public string GsmSshPublicKey { get; set; }
Property Value
| Type | Description |
|---|---|
| string | The SSH public key for Global service manager instances. |
ListenerPort
Declaration
[Required(ErrorMessage = "ListenerPort is required.")]
[JsonProperty(PropertyName = "listenerPort")]
public int? ListenerPort { get; set; }
Property Value
| Type | Description |
|---|---|
| int? | The listener port number for the Globally distributed database. The listener port number has to be unique for a customer tenancy across all distributed databases. Same port number should not be re-used for any other distributed database. |
Remarks
Required
ListenerPortTls
Declaration
[JsonProperty(PropertyName = "listenerPortTls")]
public int? ListenerPortTls { get; set; }
Property Value
| Type | Description |
|---|---|
| int? | The TLS listener port number for the Globally distributed database. The TLS listener port number has to be unique for a customer tenancy across all distributed databases. Same port number should not be re-used for any other distributed database. For EXADB based distributed databases, tls is not supported hence the listenerPortTls is not needed to be provided in create payload. |
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? | The ons local port number for the Globally distributed database. The onsPortLocal has to be unique for a customer tenancy across all distributed databases. Same port number should not be re-used for any other distributed database. |
Remarks
Required
OnsPortRemote
Declaration
[Required(ErrorMessage = "OnsPortRemote is required.")]
[JsonProperty(PropertyName = "onsPortRemote")]
public int? OnsPortRemote { get; set; }
Property Value
| Type | Description |
|---|---|
| int? | The ons remote port number for the Globally distributed database. The onsPortRemote has to be unique for a customer tenancy across all distributed databases. Same port number should not be re-used for any other distributed database. |
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 endpoints associated with the Globally distributed database. |
Remarks
Required
ScanListenerPort
Declaration
[JsonProperty(PropertyName = "scanListenerPort")]
public int? ScanListenerPort { get; set; }
Property Value
| Type | Description |
|---|---|
| int? | TCP SCAN listener port for new clusters to be created. Applicable only when shard and catalog source types are XS_NEW_VAULT_AND_CLUSTER or XS_NEW_CLUSTER. Defaults to 1521 when not provided. |
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 CreateSystemDataGuardDatabaseDetails SystemDataGuardDatabases { get; set; }
Property Value
| Type | Description |
|---|---|
| CreateSystemDataGuardDatabaseDetails |
SystemRaftClusters
Declaration
[JsonProperty(PropertyName = "systemRaftClusters")]
public List<CreateSystemRaftClusterDetails> SystemRaftClusters { get; set; }
Property Value
| Type | Description |
|---|---|
| List<CreateSystemRaftClusterDetails> | 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. |
UserShardSpaces
Declaration
[JsonProperty(PropertyName = "userShardSpaces")]
public List<CreateUserShardSpaceDetails> UserShardSpaces { get; set; }
Property Value
| Type | Description |
|---|---|
| List<CreateUserShardSpaceDetails> | 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 to be associated with the distributed database. |