CreateDistributedDatabaseDetails¶

class oci.distributed_database_v26.models.CreateDistributedDatabaseDetails(**kwargs)¶

Bases: object

Details required for creation of the Globally distributed database.

Methods

__init__(**kwargs) Initializes a new CreateDistributedDatabaseDetails object with values from keyword arguments.

Attributes

`catalog_details`	[Required] Gets the catalog_details of this CreateDistributedDatabaseDetails.
`character_set`	[Required] Gets the character_set of this CreateDistributedDatabaseDetails.
`compartment_id`	[Required] Gets the compartment_id of this CreateDistributedDatabaseDetails.
`composite_data_guard_shard_spaces`	Gets the composite_data_guard_shard_spaces of this CreateDistributedDatabaseDetails.
`composite_raft_shard_spaces`	Gets the composite_raft_shard_spaces of this CreateDistributedDatabaseDetails.
`database_version`	[Required] Gets the database_version of this CreateDistributedDatabaseDetails.
`db_backup_config`	Gets the db_backup_config of this CreateDistributedDatabaseDetails.
`defined_tags`	Gets the defined_tags of this CreateDistributedDatabaseDetails.
`display_name`	[Required] Gets the display_name of this CreateDistributedDatabaseDetails.
`freeform_tags`	Gets the freeform_tags of this CreateDistributedDatabaseDetails.
`gsm_ssh_public_key`	Gets the gsm_ssh_public_key of this CreateDistributedDatabaseDetails.
`listener_port`	[Required] Gets the listener_port of this CreateDistributedDatabaseDetails.
`listener_port_tls`	Gets the listener_port_tls of this CreateDistributedDatabaseDetails.
`ncharacter_set`	[Required] Gets the ncharacter_set of this CreateDistributedDatabaseDetails.
`notification_topic_ids`	Gets the notification_topic_ids of this CreateDistributedDatabaseDetails.
`ons_port_local`	[Required] Gets the ons_port_local of this CreateDistributedDatabaseDetails.
`ons_port_remote`	[Required] Gets the ons_port_remote of this CreateDistributedDatabaseDetails.
`prefix`	[Required] Gets the prefix of this CreateDistributedDatabaseDetails.
`private_endpoint_ids`	[Required] Gets the private_endpoint_ids of this CreateDistributedDatabaseDetails.
`scan_listener_port`	Gets the scan_listener_port of this CreateDistributedDatabaseDetails.
`system_chunk_count`	Gets the system_chunk_count of this CreateDistributedDatabaseDetails.
`system_data_guard_databases`	Gets the system_data_guard_databases of this CreateDistributedDatabaseDetails.
`system_raft_clusters`	Gets the system_raft_clusters of this CreateDistributedDatabaseDetails.
`system_raft_replication_unit_count`	Gets the system_raft_replication_unit_count of this CreateDistributedDatabaseDetails.
`user_shard_spaces`	Gets the user_shard_spaces of this CreateDistributedDatabaseDetails.
`vcn_nsg_ids`	Gets the vcn_nsg_ids of this CreateDistributedDatabaseDetails.

__init__(**kwargs)¶

Initializes a new CreateDistributedDatabaseDetails object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

compartment_id (str) – The value to assign to the compartment_id property of this CreateDistributedDatabaseDetails.
display_name (str) – The value to assign to the display_name property of this CreateDistributedDatabaseDetails.
database_version (str) – The value to assign to the database_version property of this CreateDistributedDatabaseDetails.
prefix (str) – The value to assign to the prefix property of this CreateDistributedDatabaseDetails.
private_endpoint_ids (list[str]) – The value to assign to the private_endpoint_ids property of this CreateDistributedDatabaseDetails.
notification_topic_ids (list[str]) – The value to assign to the notification_topic_ids property of this CreateDistributedDatabaseDetails.
character_set (str) – The value to assign to the character_set property of this CreateDistributedDatabaseDetails.
ncharacter_set (str) – The value to assign to the ncharacter_set property of this CreateDistributedDatabaseDetails.
listener_port (int) – The value to assign to the listener_port property of this CreateDistributedDatabaseDetails.
listener_port_tls (int) – The value to assign to the listener_port_tls property of this CreateDistributedDatabaseDetails.
ons_port_local (int) – The value to assign to the ons_port_local property of this CreateDistributedDatabaseDetails.
ons_port_remote (int) – The value to assign to the ons_port_remote property of this CreateDistributedDatabaseDetails.
scan_listener_port (int) – The value to assign to the scan_listener_port property of this CreateDistributedDatabaseDetails.
system_chunk_count (int) – The value to assign to the system_chunk_count property of this CreateDistributedDatabaseDetails.
system_raft_replication_unit_count (int) – The value to assign to the system_raft_replication_unit_count property of this CreateDistributedDatabaseDetails.
composite_raft_shard_spaces (list[oci.distributed_database_v26.models.CreateCompositeRaftShardSpaceDetails]) – The value to assign to the composite_raft_shard_spaces property of this CreateDistributedDatabaseDetails.
composite_data_guard_shard_spaces (list[oci.distributed_database_v26.models.CreateCompositeDataGuardShardSpaceDetails]) – The value to assign to the composite_data_guard_shard_spaces property of this CreateDistributedDatabaseDetails.
system_raft_clusters (list[oci.distributed_database_v26.models.CreateSystemRaftClusterDetails]) – The value to assign to the system_raft_clusters property of this CreateDistributedDatabaseDetails.
system_data_guard_databases (oci.distributed_database_v26.models.CreateSystemDataGuardDatabaseDetails) – The value to assign to the system_data_guard_databases property of this CreateDistributedDatabaseDetails.
user_shard_spaces (list[oci.distributed_database_v26.models.CreateUserShardSpaceDetails]) – The value to assign to the user_shard_spaces property of this CreateDistributedDatabaseDetails.
catalog_details (list[oci.distributed_database_v26.models.CreateDistributedDatabaseCatalogDetails]) – The value to assign to the catalog_details property of this CreateDistributedDatabaseDetails.
gsm_ssh_public_key (str) – The value to assign to the gsm_ssh_public_key property of this CreateDistributedDatabaseDetails.
db_backup_config (oci.distributed_database_v26.models.DistributedDbBackupConfig) – The value to assign to the db_backup_config property of this CreateDistributedDatabaseDetails.
vcn_nsg_ids (list[oci.distributed_database_v26.models.VcnNsgIdsDetails]) – The value to assign to the vcn_nsg_ids property of this CreateDistributedDatabaseDetails.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CreateDistributedDatabaseDetails.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CreateDistributedDatabaseDetails.

catalog_details¶

[Required] Gets the catalog_details of this CreateDistributedDatabaseDetails. Collection of catalog details for the Globally distributed database.

Returns:	The catalog_details of this CreateDistributedDatabaseDetails.
Return type:	list[oci.distributed_database_v26.models.CreateDistributedDatabaseCatalogDetails]

character_set¶

[Required] Gets the character_set of this CreateDistributedDatabaseDetails. The character set for the database.

Returns:	The character_set of this CreateDistributedDatabaseDetails.
Return type:	str

compartment_id¶

[Required] Gets the compartment_id of this CreateDistributedDatabaseDetails. The OCID of the Globally distributed database compartment.

Returns:	The compartment_id of this CreateDistributedDatabaseDetails.
Return type:	str

composite_data_guard_shard_spaces¶

Gets the composite_data_guard_shard_spaces of this CreateDistributedDatabaseDetails. Collection of composite data guard shard spaces.

Returns:	The composite_data_guard_shard_spaces of this CreateDistributedDatabaseDetails.
Return type:	list[oci.distributed_database_v26.models.CreateCompositeDataGuardShardSpaceDetails]

composite_raft_shard_spaces¶

Gets the composite_raft_shard_spaces of this CreateDistributedDatabaseDetails. Collection of composite raft shards.

Returns:	The composite_raft_shard_spaces of this CreateDistributedDatabaseDetails.
Return type:	list[oci.distributed_database_v26.models.CreateCompositeRaftShardSpaceDetails]

database_version¶

[Required] Gets the database_version of this CreateDistributedDatabaseDetails. Oracle Database version for the shards and catalog used in Globally distributed database.

Returns:	The database_version of this CreateDistributedDatabaseDetails.
Return type:	str

db_backup_config¶

Gets the db_backup_config of this CreateDistributedDatabaseDetails.

Returns:	The db_backup_config of this CreateDistributedDatabaseDetails.
Return type:	oci.distributed_database_v26.models.DistributedDbBackupConfig

defined_tags¶

Gets the defined_tags of this CreateDistributedDatabaseDetails. Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {“foo-namespace”: {“bar-key”: “value”}}

Returns:	The defined_tags of this CreateDistributedDatabaseDetails.
Return type:	dict(str, dict(str, object))

display_name¶

[Required] Gets the display_name of this CreateDistributedDatabaseDetails. The display name of the Globally distributed database.

Returns:	The display_name of this CreateDistributedDatabaseDetails.
Return type:	str

freeform_tags¶

Gets the freeform_tags of this CreateDistributedDatabaseDetails. Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {“bar-key”: “value”}

Returns:	The freeform_tags of this CreateDistributedDatabaseDetails.
Return type:	dict(str, str)

gsm_ssh_public_key¶

Gets the gsm_ssh_public_key of this CreateDistributedDatabaseDetails. The SSH public key for Global service manager instances.

Returns:	The gsm_ssh_public_key of this CreateDistributedDatabaseDetails.
Return type:	str

listener_port¶

[Required] Gets the listener_port of this CreateDistributedDatabaseDetails. 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.

Returns:	The listener_port of this CreateDistributedDatabaseDetails.
Return type:	int

listener_port_tls¶

Gets the listener_port_tls of this CreateDistributedDatabaseDetails. 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.

Returns:	The listener_port_tls of this CreateDistributedDatabaseDetails.
Return type:	int

ncharacter_set¶

[Required] Gets the ncharacter_set of this CreateDistributedDatabaseDetails. The national character set for the database.

Returns:	The ncharacter_set of this CreateDistributedDatabaseDetails.
Return type:	str

notification_topic_ids¶

Gets the notification_topic_ids of this CreateDistributedDatabaseDetails. The collection of OCID for the notification topics associated with the globally distributed database.

Returns:	The notification_topic_ids of this CreateDistributedDatabaseDetails.
Return type:	list[str]

ons_port_local¶

[Required] Gets the ons_port_local of this CreateDistributedDatabaseDetails. 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.

Returns:	The ons_port_local of this CreateDistributedDatabaseDetails.
Return type:	int

ons_port_remote¶

[Required] Gets the ons_port_remote of this CreateDistributedDatabaseDetails. 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.

Returns:	The ons_port_remote of this CreateDistributedDatabaseDetails.
Return type:	int

prefix¶

[Required] Gets the prefix of this CreateDistributedDatabaseDetails. 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.

Returns:	The prefix of this CreateDistributedDatabaseDetails.
Return type:	str

private_endpoint_ids¶

[Required] Gets the private_endpoint_ids of this CreateDistributedDatabaseDetails. The collection of OCID of the private endpoints associated with the Globally distributed database.

Returns:	The private_endpoint_ids of this CreateDistributedDatabaseDetails.
Return type:	list[str]

scan_listener_port¶

Gets the scan_listener_port of this CreateDistributedDatabaseDetails. 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.

Returns:	The scan_listener_port of this CreateDistributedDatabaseDetails.
Return type:	int

system_chunk_count¶

Gets the system_chunk_count of this CreateDistributedDatabaseDetails. Count of chunks associated with system raft clusters or system data guard databases.

Returns:	The system_chunk_count of this CreateDistributedDatabaseDetails.
Return type:	int

system_data_guard_databases¶

Gets the system_data_guard_databases of this CreateDistributedDatabaseDetails.

Returns:	The system_data_guard_databases of this CreateDistributedDatabaseDetails.
Return type:	oci.distributed_database_v26.models.CreateSystemDataGuardDatabaseDetails

system_raft_clusters¶

Gets the system_raft_clusters of this CreateDistributedDatabaseDetails. Collection of system raft clusters.

Returns:	The system_raft_clusters of this CreateDistributedDatabaseDetails.
Return type:	list[oci.distributed_database_v26.models.CreateSystemRaftClusterDetails]

system_raft_replication_unit_count¶

Gets the system_raft_replication_unit_count of this CreateDistributedDatabaseDetails. Number of replication units associated with system raft clusters.

Returns:	The system_raft_replication_unit_count of this CreateDistributedDatabaseDetails.
Return type:	int

user_shard_spaces¶

Gets the user_shard_spaces of this CreateDistributedDatabaseDetails. Collection of user defined shard spaces.

Returns:	The user_shard_spaces of this CreateDistributedDatabaseDetails.
Return type:	list[oci.distributed_database_v26.models.CreateUserShardSpaceDetails]

vcn_nsg_ids¶

Gets the vcn_nsg_ids of this CreateDistributedDatabaseDetails. The list of network security group (NSG) details to be associated with the distributed database.

Returns:	The vcn_nsg_ids of this CreateDistributedDatabaseDetails.
Return type:	list[oci.distributed_database_v26.models.VcnNsgIdsDetails]