LaunchDbSystemDetails¶

class oci.database.models.LaunchDbSystemDetails(**kwargs)¶

Bases: oci.database.models.launch_db_system_base.LaunchDbSystemBase

Used for creating a new DB system. Does not use backups or an existing database for the creation of the initial database.

Attributes

`DATABASE_EDITION_ENTERPRISE_EDITION`	A constant which can be used with the database_edition property of a LaunchDbSystemDetails.
`DATABASE_EDITION_ENTERPRISE_EDITION_EXTREME_PERFORMANCE`	A constant which can be used with the database_edition property of a LaunchDbSystemDetails.
`DATABASE_EDITION_ENTERPRISE_EDITION_HIGH_PERFORMANCE`	A constant which can be used with the database_edition property of a LaunchDbSystemDetails.
`DATABASE_EDITION_STANDARD_EDITION`	A constant which can be used with the database_edition property of a LaunchDbSystemDetails.
`DISK_REDUNDANCY_HIGH`	A constant which can be used with the disk_redundancy property of a LaunchDbSystemDetails.
`DISK_REDUNDANCY_NORMAL`	A constant which can be used with the disk_redundancy property of a LaunchDbSystemDetails.
`LICENSE_MODEL_BRING_YOUR_OWN_LICENSE`	A constant which can be used with the license_model property of a LaunchDbSystemDetails.
`LICENSE_MODEL_LICENSE_INCLUDED`	A constant which can be used with the license_model property of a LaunchDbSystemDetails.
`SOURCE_DATABASE`	str(object=’’) -> str
`SOURCE_DB_BACKUP`	str(object=’’) -> str
`SOURCE_DB_SYSTEM`	str(object=’’) -> str
`SOURCE_NONE`	str(object=’’) -> str
`STORAGE_VOLUME_PERFORMANCE_MODE_BALANCED`	str(object=’’) -> str
`STORAGE_VOLUME_PERFORMANCE_MODE_HIGH_PERFORMANCE`	str(object=’’) -> str
`availability_domain`	[Required] Gets the availability_domain of this LaunchDbSystemBase.
`backup_network_nsg_ids`	Gets the backup_network_nsg_ids of this LaunchDbSystemBase.
`backup_subnet_id`	Gets the backup_subnet_id of this LaunchDbSystemBase.
`cluster_name`	Gets the cluster_name of this LaunchDbSystemBase.
`compartment_id`	[Required] Gets the compartment_id of this LaunchDbSystemBase.
`cpu_core_count`	[Required] Gets the cpu_core_count of this LaunchDbSystemBase.
`data_collection_options`	Gets the data_collection_options of this LaunchDbSystemBase.
`data_storage_percentage`	Gets the data_storage_percentage of this LaunchDbSystemBase.
`database_edition`	[Required] Gets the database_edition of this LaunchDbSystemDetails.
`db_home`	[Required] Gets the db_home of this LaunchDbSystemDetails.
`db_system_options`	Gets the db_system_options of this LaunchDbSystemBase.
`defined_tags`	Gets the defined_tags of this LaunchDbSystemBase.
`disk_redundancy`	Gets the disk_redundancy of this LaunchDbSystemDetails.
`display_name`	Gets the display_name of this LaunchDbSystemBase.
`domain`	Gets the domain of this LaunchDbSystemBase.
`fault_domains`	Gets the fault_domains of this LaunchDbSystemBase.
`freeform_tags`	Gets the freeform_tags of this LaunchDbSystemBase.
`hostname`	[Required] Gets the hostname of this LaunchDbSystemBase.
`initial_data_storage_size_in_gb`	Gets the initial_data_storage_size_in_gb of this LaunchDbSystemBase.
`kms_key_id`	Gets the kms_key_id of this LaunchDbSystemBase.
`kms_key_version_id`	Gets the kms_key_version_id of this LaunchDbSystemBase.
`license_model`	Gets the license_model of this LaunchDbSystemDetails.
`maintenance_window_details`	Gets the maintenance_window_details of this LaunchDbSystemDetails.
`node_count`	Gets the node_count of this LaunchDbSystemBase.
`nsg_ids`	Gets the nsg_ids of this LaunchDbSystemBase.
`private_ip`	Gets the private_ip of this LaunchDbSystemBase.
`shape`	[Required] Gets the shape of this LaunchDbSystemBase.
`source`	Gets the source of this LaunchDbSystemBase.
`sparse_diskgroup`	Gets the sparse_diskgroup of this LaunchDbSystemBase.
`ssh_public_keys`	[Required] Gets the ssh_public_keys of this LaunchDbSystemBase.
`storage_volume_performance_mode`	Gets the storage_volume_performance_mode of this LaunchDbSystemBase.
`subnet_id`	[Required] Gets the subnet_id of this LaunchDbSystemBase.
`time_zone`	Gets the time_zone of this LaunchDbSystemBase.

Methods

`__init__`(**kwargs)	Initializes a new LaunchDbSystemDetails object with values from keyword arguments.
`get_subtype`(object_dictionary)	Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

DATABASE_EDITION_ENTERPRISE_EDITION = 'ENTERPRISE_EDITION'¶: A constant which can be used with the database_edition property of a LaunchDbSystemDetails. This constant has a value of “ENTERPRISE_EDITION”

DATABASE_EDITION_ENTERPRISE_EDITION_EXTREME_PERFORMANCE = 'ENTERPRISE_EDITION_EXTREME_PERFORMANCE'¶: A constant which can be used with the database_edition property of a LaunchDbSystemDetails. This constant has a value of “ENTERPRISE_EDITION_EXTREME_PERFORMANCE”

DATABASE_EDITION_ENTERPRISE_EDITION_HIGH_PERFORMANCE = 'ENTERPRISE_EDITION_HIGH_PERFORMANCE'¶: A constant which can be used with the database_edition property of a LaunchDbSystemDetails. This constant has a value of “ENTERPRISE_EDITION_HIGH_PERFORMANCE”

DATABASE_EDITION_STANDARD_EDITION = 'STANDARD_EDITION'¶: A constant which can be used with the database_edition property of a LaunchDbSystemDetails. This constant has a value of “STANDARD_EDITION”

DISK_REDUNDANCY_HIGH = 'HIGH'¶: A constant which can be used with the disk_redundancy property of a LaunchDbSystemDetails. This constant has a value of “HIGH”

DISK_REDUNDANCY_NORMAL = 'NORMAL'¶: A constant which can be used with the disk_redundancy property of a LaunchDbSystemDetails. This constant has a value of “NORMAL”

LICENSE_MODEL_BRING_YOUR_OWN_LICENSE = 'BRING_YOUR_OWN_LICENSE'¶: A constant which can be used with the license_model property of a LaunchDbSystemDetails. This constant has a value of “BRING_YOUR_OWN_LICENSE”

LICENSE_MODEL_LICENSE_INCLUDED = 'LICENSE_INCLUDED'¶: A constant which can be used with the license_model property of a LaunchDbSystemDetails. This constant has a value of “LICENSE_INCLUDED”

SOURCE_DATABASE = 'DATABASE'¶

SOURCE_DB_BACKUP = 'DB_BACKUP'¶

SOURCE_DB_SYSTEM = 'DB_SYSTEM'¶

SOURCE_NONE = 'NONE'¶

STORAGE_VOLUME_PERFORMANCE_MODE_BALANCED = 'BALANCED'¶

STORAGE_VOLUME_PERFORMANCE_MODE_HIGH_PERFORMANCE = 'HIGH_PERFORMANCE'¶

__init__(**kwargs)¶

Initializes a new LaunchDbSystemDetails object with values from keyword arguments. The default value of the source attribute of this class is NONE and it should not be changed. 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 LaunchDbSystemDetails.
fault_domains (list[str]) – The value to assign to the fault_domains property of this LaunchDbSystemDetails.
display_name (str) – The value to assign to the display_name property of this LaunchDbSystemDetails.
availability_domain (str) – The value to assign to the availability_domain property of this LaunchDbSystemDetails.
subnet_id (str) – The value to assign to the subnet_id property of this LaunchDbSystemDetails.
backup_subnet_id (str) – The value to assign to the backup_subnet_id property of this LaunchDbSystemDetails.
nsg_ids (list[str]) – The value to assign to the nsg_ids property of this LaunchDbSystemDetails.
backup_network_nsg_ids (list[str]) – The value to assign to the backup_network_nsg_ids property of this LaunchDbSystemDetails.
shape (str) – The value to assign to the shape property of this LaunchDbSystemDetails.
time_zone (str) – The value to assign to the time_zone property of this LaunchDbSystemDetails.
db_system_options (oci.database.models.DbSystemOptions) – The value to assign to the db_system_options property of this LaunchDbSystemDetails.
storage_volume_performance_mode (str) – The value to assign to the storage_volume_performance_mode property of this LaunchDbSystemDetails. Allowed values for this property are: “BALANCED”, “HIGH_PERFORMANCE”
sparse_diskgroup (bool) – The value to assign to the sparse_diskgroup property of this LaunchDbSystemDetails.
ssh_public_keys (list[str]) – The value to assign to the ssh_public_keys property of this LaunchDbSystemDetails.
hostname (str) – The value to assign to the hostname property of this LaunchDbSystemDetails.
domain (str) – The value to assign to the domain property of this LaunchDbSystemDetails.
cpu_core_count (int) – The value to assign to the cpu_core_count property of this LaunchDbSystemDetails.
cluster_name (str) – The value to assign to the cluster_name property of this LaunchDbSystemDetails.
data_storage_percentage (int) – The value to assign to the data_storage_percentage property of this LaunchDbSystemDetails.
initial_data_storage_size_in_gb (int) – The value to assign to the initial_data_storage_size_in_gb property of this LaunchDbSystemDetails.
kms_key_id (str) – The value to assign to the kms_key_id property of this LaunchDbSystemDetails.
kms_key_version_id (str) – The value to assign to the kms_key_version_id property of this LaunchDbSystemDetails.
node_count (int) – The value to assign to the node_count property of this LaunchDbSystemDetails.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this LaunchDbSystemDetails.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this LaunchDbSystemDetails.
source (str) – The value to assign to the source property of this LaunchDbSystemDetails. Allowed values for this property are: “NONE”, “DB_BACKUP”, “DATABASE”, “DB_SYSTEM”
private_ip (str) – The value to assign to the private_ip property of this LaunchDbSystemDetails.
data_collection_options (oci.database.models.DataCollectionOptions) – The value to assign to the data_collection_options property of this LaunchDbSystemDetails.
db_home (oci.database.models.CreateDbHomeDetails) – The value to assign to the db_home property of this LaunchDbSystemDetails.
database_edition (str) – The value to assign to the database_edition property of this LaunchDbSystemDetails. Allowed values for this property are: “STANDARD_EDITION”, “ENTERPRISE_EDITION”, “ENTERPRISE_EDITION_HIGH_PERFORMANCE”, “ENTERPRISE_EDITION_EXTREME_PERFORMANCE”
disk_redundancy (str) – The value to assign to the disk_redundancy property of this LaunchDbSystemDetails. Allowed values for this property are: “HIGH”, “NORMAL”
license_model (str) – The value to assign to the license_model property of this LaunchDbSystemDetails. Allowed values for this property are: “LICENSE_INCLUDED”, “BRING_YOUR_OWN_LICENSE”
maintenance_window_details (oci.database.models.MaintenanceWindow) – The value to assign to the maintenance_window_details property of this LaunchDbSystemDetails.

availability_domain¶

[Required] Gets the availability_domain of this LaunchDbSystemBase. The availability domain where the DB system is located.

Returns:	The availability_domain of this LaunchDbSystemBase.
Return type:	str

backup_network_nsg_ids¶

Gets the backup_network_nsg_ids of this LaunchDbSystemBase. A list of the OCIDs of the network security groups (NSGs) that the backup network of this DB system belongs to. Setting this to an empty array after the list is created removes the resource from all NSGs. For more information about NSGs, see Security Rules. Applicable only to Exadata systems.

Returns:	The backup_network_nsg_ids of this LaunchDbSystemBase.
Return type:	list[str]

backup_subnet_id¶

Gets the backup_subnet_id of this LaunchDbSystemBase. The OCID of the backup network subnet the DB system is associated with. Applicable only to Exadata DB systems.

Subnet Restrictions: See the subnet restrictions information for subnetId.

Returns:	The backup_subnet_id of this LaunchDbSystemBase.
Return type:	str

cluster_name¶

Gets the cluster_name of this LaunchDbSystemBase. The cluster name for Exadata and 2-node RAC virtual machine DB systems. The cluster name must begin with an alphabetic character, and may contain hyphens (-). Underscores (_) are not permitted. The cluster name can be no longer than 11 characters and is not case sensitive.

Returns:	The cluster_name of this LaunchDbSystemBase.
Return type:	str

compartment_id¶

[Required] Gets the compartment_id of this LaunchDbSystemBase. The OCID of the compartment the DB system belongs in.

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

cpu_core_count¶

[Required] Gets the cpu_core_count of this LaunchDbSystemBase. The number of CPU cores to enable for a bare metal or Exadata DB system or AMD VMDB Systems. The valid values depend on the specified shape:

BM.DenseIO1.36 - Specify a multiple of 2, from 2 to 36.
BM.DenseIO2.52 - Specify a multiple of 2, from 2 to 52.
Exadata.Base.48 - Specify a multiple of 2, from 0 to 48.
Exadata.Quarter1.84 - Specify a multiple of 2, from 22 to 84.
Exadata.Half1.168 - Specify a multiple of 4, from 44 to 168.
Exadata.Full1.336 - Specify a multiple of 8, from 88 to 336.
Exadata.Quarter2.92 - Specify a multiple of 2, from 0 to 92.
Exadata.Half2.184 - Specify a multiple of 4, from 0 to 184.
Exadata.Full2.368 - Specify a multiple of 8, from 0 to 368.
VM.Standard.E4.Flex - Specify any thing from 1 to 64.

This parameter is not used for INTEL virtual machine DB systems because virtual machine DB systems have a set number of cores for each shape. For information about the number of cores for a virtual machine DB system shape, see Virtual Machine DB Systems

Returns:	The cpu_core_count of this LaunchDbSystemBase.
Return type:	int

data_collection_options¶

Gets the data_collection_options of this LaunchDbSystemBase.

Returns:	The data_collection_options of this LaunchDbSystemBase.
Return type:	oci.database.models.DataCollectionOptions

data_storage_percentage¶

Gets the data_storage_percentage of this LaunchDbSystemBase. The percentage assigned to DATA storage (user data and database files). The remaining percentage is assigned to RECO storage (database redo logs, archive logs, and recovery manager backups). Specify 80 or 40. The default is 80 percent assigned to DATA storage. Not applicable for virtual machine DB systems.

Returns:	The data_storage_percentage of this LaunchDbSystemBase.
Return type:	int

database_edition¶

[Required] Gets the database_edition of this LaunchDbSystemDetails. The Oracle Database Edition that applies to all the databases on the DB system. Exadata DB systems and 2-node RAC DB systems require ENTERPRISE_EDITION_EXTREME_PERFORMANCE.

Allowed values for this property are: “STANDARD_EDITION”, “ENTERPRISE_EDITION”, “ENTERPRISE_EDITION_HIGH_PERFORMANCE”, “ENTERPRISE_EDITION_EXTREME_PERFORMANCE”

Returns:	The database_edition of this LaunchDbSystemDetails.
Return type:	str

db_home¶

[Required] Gets the db_home of this LaunchDbSystemDetails.

Returns:	The db_home of this LaunchDbSystemDetails.
Return type:	oci.database.models.CreateDbHomeDetails

db_system_options¶

Gets the db_system_options of this LaunchDbSystemBase.

Returns:	The db_system_options of this LaunchDbSystemBase.
Return type:	oci.database.models.DbSystemOptions

defined_tags¶

Gets the defined_tags of this LaunchDbSystemBase. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

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

disk_redundancy¶

Gets the disk_redundancy of this LaunchDbSystemDetails. The type of redundancy configured for the DB system. Normal is 2-way redundancy, recommended for test and development systems. High is 3-way redundancy, recommended for production systems.

Allowed values for this property are: “HIGH”, “NORMAL”

Returns:	The disk_redundancy of this LaunchDbSystemDetails.
Return type:	str

display_name¶

Gets the display_name of this LaunchDbSystemBase. The user-friendly name for the DB system. The name does not have to be unique.

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

domain¶

Gets the domain of this LaunchDbSystemBase. A domain name used for the DB system. If the Oracle-provided Internet and VCN Resolver is enabled for the specified subnet, the domain name for the subnet is used (do not provide one). Otherwise, provide a valid DNS domain name. Hyphens (-) are not permitted.

Returns:	The domain of this LaunchDbSystemBase.
Return type:	str

fault_domains¶

Gets the fault_domains of this LaunchDbSystemBase. A Fault Domain is a grouping of hardware and infrastructure within an availability domain. Fault Domains let you distribute your instances so that they are not on the same physical hardware within a single availability domain. A hardware failure or maintenance that affects one Fault Domain does not affect DB systems in other Fault Domains.

If you do not specify the Fault Domain, the system selects one for you. To change the Fault Domain for a DB system, terminate it and launch a new DB system in the preferred Fault Domain.

If the node count is greater than 1, you can specify which Fault Domains these nodes will be distributed into. The system assigns your nodes automatically to the Fault Domains you specify so that no Fault Domain contains more than one node.

To get a list of Fault Domains, use the list_fault_domains() operation in the Identity and Access Management Service API.

Example: FAULT-DOMAIN-1

Returns:	The fault_domains of this LaunchDbSystemBase.
Return type:	list[str]

freeform_tags¶

Gets the freeform_tags of this LaunchDbSystemBase. Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.

Example: {“Department”: “Finance”}

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

static get_subtype(object_dictionary)¶: Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

hostname¶

[Required] Gets the hostname of this LaunchDbSystemBase. The hostname for the DB system. The hostname must begin with an alphabetic character, and can contain alphanumeric characters and hyphens (-). The maximum length of the hostname is 16 characters for bare metal and virtual machine DB systems, and 12 characters for Exadata DB systems.

The maximum length of the combined hostname and domain is 63 characters.

Note: The hostname must be unique within the subnet. If it is not unique, the DB system will fail to provision.

Returns:	The hostname of this LaunchDbSystemBase.
Return type:	str

initial_data_storage_size_in_gb¶

Gets the initial_data_storage_size_in_gb of this LaunchDbSystemBase. Size (in GB) of the initial data volume that will be created and attached to a virtual machine DB system. You can scale up storage after provisioning, as needed. Note that the total storage size attached will be more than the amount you specify to allow for REDO/RECO space and software volume.

Returns:	The initial_data_storage_size_in_gb of this LaunchDbSystemBase.
Return type:	int

kms_key_id¶

Gets the kms_key_id of this LaunchDbSystemBase. The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.

Returns:	The kms_key_id of this LaunchDbSystemBase.
Return type:	str

kms_key_version_id¶

Gets the kms_key_version_id of this LaunchDbSystemBase. The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation. Autonomous Database Serverless does not use key versions, hence is not applicable for Autonomous Database Serverless instances.

Returns:	The kms_key_version_id of this LaunchDbSystemBase.
Return type:	str

license_model¶

Gets the license_model of this LaunchDbSystemDetails. The Oracle license model that applies to all the databases on the DB system. The default is LICENSE_INCLUDED.

Allowed values for this property are: “LICENSE_INCLUDED”, “BRING_YOUR_OWN_LICENSE”

Returns:	The license_model of this LaunchDbSystemDetails.
Return type:	str

maintenance_window_details¶

Gets the maintenance_window_details of this LaunchDbSystemDetails.

Returns:	The maintenance_window_details of this LaunchDbSystemDetails.
Return type:	oci.database.models.MaintenanceWindow

node_count¶

Gets the node_count of this LaunchDbSystemBase. The number of nodes to launch for a 2-node RAC virtual machine DB system. Specify either 1 or 2.

Returns:	The node_count of this LaunchDbSystemBase.
Return type:	int

nsg_ids¶

Gets the nsg_ids of this LaunchDbSystemBase. The list of OCIDs for the network security groups (NSGs) to which this resource belongs. Setting this to an empty list removes all resources from all NSGs. For more information about NSGs, see Security Rules. NsgIds restrictions: - A network security group (NSG) is optional for Autonomous Databases with private access. The nsgIds list can be empty.

Returns:	The nsg_ids of this LaunchDbSystemBase.
Return type:	list[str]

private_ip¶

Gets the private_ip of this LaunchDbSystemBase. A private IP address of your choice. Must be an available IP address within the subnet’s CIDR. If you don’t specify a value, Oracle automatically assigns a private IP address from the subnet.

Returns:	The private_ip of this LaunchDbSystemBase.
Return type:	str

shape¶

[Required] Gets the shape of this LaunchDbSystemBase. The shape of the DB system. The shape determines resources allocated to the DB system. - For virtual machine shapes, the number of CPU cores and memory - For bare metal and Exadata shapes, the number of CPU cores, memory, and storage

To get a list of shapes, use the list_db_system_shapes() operation.

Returns:	The shape of this LaunchDbSystemBase.
Return type:	str

source¶

Gets the source of this LaunchDbSystemBase. The source of the database: Use NONE for creating a new database. Use DB_BACKUP for creating a new database by restoring from a backup. Use DATABASE for creating a new database from an existing database, including archive redo log data. The default is NONE.

Allowed values for this property are: “NONE”, “DB_BACKUP”, “DATABASE”, “DB_SYSTEM”

Returns:	The source of this LaunchDbSystemBase.
Return type:	str

sparse_diskgroup¶

Gets the sparse_diskgroup of this LaunchDbSystemBase. If true, Sparse Diskgroup is configured for Exadata dbsystem. If False, Sparse diskgroup is not configured.

Returns:	The sparse_diskgroup of this LaunchDbSystemBase.
Return type:	bool

ssh_public_keys¶

[Required] Gets the ssh_public_keys of this LaunchDbSystemBase. The public key portion of the key pair to use for SSH access to the DB system. Multiple public keys can be provided. The length of the combined keys cannot exceed 40,000 characters.

Returns:	The ssh_public_keys of this LaunchDbSystemBase.
Return type:	list[str]

storage_volume_performance_mode¶

Gets the storage_volume_performance_mode of this LaunchDbSystemBase. The block storage volume performance level. Valid values are BALANCED and HIGH_PERFORMANCE. See Block Volume Performance for more information.

Allowed values for this property are: “BALANCED”, “HIGH_PERFORMANCE”

Returns:	The storage_volume_performance_mode of this LaunchDbSystemBase.
Return type:	str

subnet_id¶

[Required] Gets the subnet_id of this LaunchDbSystemBase. The OCID of the subnet the DB system is associated with.

Subnet Restrictions: - For bare metal DB systems and for single node virtual machine DB systems, do not use a subnet that overlaps with 192.168.16.16/28. - For Exadata and virtual machine 2-node RAC DB systems, do not use a subnet that overlaps with 192.168.128.0/20.

These subnets are used by the Oracle Clusterware private interconnect on the database instance. Specifying an overlapping subnet will cause the private interconnect to malfunction. This restriction applies to both the client subnet and the backup subnet.

Returns:	The subnet_id of this LaunchDbSystemBase.
Return type:	str

time_zone¶

Gets the time_zone of this LaunchDbSystemBase. The time zone to use for the DB system. For details, see DB System Time Zones.

Returns:	The time_zone of this LaunchDbSystemBase.
Return type:	str