CreateDbSystemDetails¶

class oci.mysql.models.CreateDbSystemDetails(**kwargs)¶

Bases: object

Details required to create a DB System.

Attributes:

`CRASH_RECOVERY_DISABLED`	A constant which can be used with the crash_recovery property of a CreateDbSystemDetails.
`CRASH_RECOVERY_ENABLED`	A constant which can be used with the crash_recovery property of a CreateDbSystemDetails.
`DATABASE_MANAGEMENT_DISABLED`	A constant which can be used with the database_management property of a CreateDbSystemDetails.
`DATABASE_MANAGEMENT_ENABLED`	A constant which can be used with the database_management property of a CreateDbSystemDetails.
`access_mode`	Gets the access_mode of this CreateDbSystemDetails. The access mode indicating if the database access will be restricted only to administrators or not: - UNRESTRICTED (default): the access to the database is not restricted; - RESTRICTED: the access will be allowed only to users with specific privileges; RESTRICTED will correspond to setting the MySQL system variable `offline_mode`__ to ON.
`admin_password`	Gets the admin_password of this CreateDbSystemDetails.
`admin_username`	Gets the admin_username of this CreateDbSystemDetails.
`availability_domain`	Gets the availability_domain of this CreateDbSystemDetails.
`backup_policy`	Gets the backup_policy of this CreateDbSystemDetails.
`compartment_id`	[Required] Gets the compartment_id of this CreateDbSystemDetails.
`configuration_id`	Gets the configuration_id of this CreateDbSystemDetails.
`crash_recovery`	Gets the crash_recovery of this CreateDbSystemDetails.
`customer_contacts`	Gets the customer_contacts of this CreateDbSystemDetails.
`data_storage`	Gets the data_storage of this CreateDbSystemDetails.
`data_storage_size_in_gbs`	Gets the data_storage_size_in_gbs of this CreateDbSystemDetails.
`database_console`	Gets the database_console of this CreateDbSystemDetails.
`database_management`	Gets the database_management of this CreateDbSystemDetails.
`database_mode`	Gets the database_mode of this CreateDbSystemDetails. The database mode indicating the types of statements that will be allowed to run in the DB system. This mode will apply only to statements run by user connections. Replicated write statements will continue to be allowed regardless of the DatabaseMode. - READ_WRITE (default): allow running read and write statements on the DB system; - READ_ONLY: only allow running read statements on the DB system.
`defined_tags`	Gets the defined_tags of this CreateDbSystemDetails.
`deletion_policy`	Gets the deletion_policy of this CreateDbSystemDetails.
`description`	Gets the description of this CreateDbSystemDetails.
`display_name`	Gets the display_name of this CreateDbSystemDetails.
`encrypt_data`	Gets the encrypt_data of this CreateDbSystemDetails.
`fault_domain`	Gets the fault_domain of this CreateDbSystemDetails.
`freeform_tags`	Gets the freeform_tags of this CreateDbSystemDetails.
`hostname_label`	Gets the hostname_label of this CreateDbSystemDetails.
`ip_address`	Gets the ip_address of this CreateDbSystemDetails.
`ipv6_address_ipv6_subnet_cidr_pair_details`	Gets the ipv6_address_ipv6_subnet_cidr_pair_details of this CreateDbSystemDetails.
`is_highly_available`	Gets the is_highly_available of this CreateDbSystemDetails.
`is_ipv6_enabled`	Gets the is_ipv6_enabled of this CreateDbSystemDetails.
`maintenance`	Gets the maintenance of this CreateDbSystemDetails.
`mysql_version`	Gets the mysql_version of this CreateDbSystemDetails.
`nsg_ids`	Gets the nsg_ids of this CreateDbSystemDetails.
`port`	Gets the port of this CreateDbSystemDetails.
`port_x`	Gets the port_x of this CreateDbSystemDetails.
`read_endpoint`	Gets the read_endpoint of this CreateDbSystemDetails.
`rest`	Gets the rest of this CreateDbSystemDetails.
`secure_connections`	Gets the secure_connections of this CreateDbSystemDetails.
`security_attributes`	Gets the security_attributes of this CreateDbSystemDetails.
`shape_name`	[Required] Gets the shape_name of this CreateDbSystemDetails.
`source`	Gets the source of this CreateDbSystemDetails.
`subnet_id`	[Required] Gets the subnet_id of this CreateDbSystemDetails.
`telemetry_configuration`	Gets the telemetry_configuration of this CreateDbSystemDetails.

Methods:

__init__(**kwargs)

Initializes a new CreateDbSystemDetails object with values from keyword arguments.

CRASH_RECOVERY_DISABLED = 'DISABLED'¶: A constant which can be used with the crash_recovery property of a CreateDbSystemDetails. This constant has a value of “DISABLED”

CRASH_RECOVERY_ENABLED = 'ENABLED'¶: A constant which can be used with the crash_recovery property of a CreateDbSystemDetails. This constant has a value of “ENABLED”

DATABASE_MANAGEMENT_DISABLED = 'DISABLED'¶: A constant which can be used with the database_management property of a CreateDbSystemDetails. This constant has a value of “DISABLED”

DATABASE_MANAGEMENT_ENABLED = 'ENABLED'¶: A constant which can be used with the database_management property of a CreateDbSystemDetails. This constant has a value of “ENABLED”

__init__(**kwargs)¶

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

Parameters

display_name (str) – The value to assign to the display_name property of this CreateDbSystemDetails.
description (str) – The value to assign to the description property of this CreateDbSystemDetails.
compartment_id (str) – The value to assign to the compartment_id property of this CreateDbSystemDetails.
rest (oci.mysql.models.CreateRestDetails) – The value to assign to the rest property of this CreateDbSystemDetails.
database_console (oci.mysql.models.CreateDatabaseConsoleDetails) – The value to assign to the database_console property of this CreateDbSystemDetails.
is_highly_available (bool) – The value to assign to the is_highly_available property of this CreateDbSystemDetails.
availability_domain (str) – The value to assign to the availability_domain property of this CreateDbSystemDetails.
fault_domain (str) – The value to assign to the fault_domain property of this CreateDbSystemDetails.
configuration_id (str) – The value to assign to the configuration_id property of this CreateDbSystemDetails.
shape_name (str) – The value to assign to the shape_name property of this CreateDbSystemDetails.
mysql_version (str) – The value to assign to the mysql_version property of this CreateDbSystemDetails.
subnet_id (str) – The value to assign to the subnet_id property of this CreateDbSystemDetails.
nsg_ids (list[str]) – The value to assign to the nsg_ids property of this CreateDbSystemDetails.
security_attributes (dict(str, dict(str, object))) – The value to assign to the security_attributes property of this CreateDbSystemDetails.
admin_username (str) – The value to assign to the admin_username property of this CreateDbSystemDetails.
admin_password (str) – The value to assign to the admin_password property of this CreateDbSystemDetails.
data_storage_size_in_gbs (int) – The value to assign to the data_storage_size_in_gbs property of this CreateDbSystemDetails.
data_storage (oci.mysql.models.DataStorageDetails) – The value to assign to the data_storage property of this CreateDbSystemDetails.
hostname_label (str) – The value to assign to the hostname_label property of this CreateDbSystemDetails.
ip_address (str) – The value to assign to the ip_address property of this CreateDbSystemDetails.
is_ipv6_enabled (bool) – The value to assign to the is_ipv6_enabled property of this CreateDbSystemDetails.
ipv6_address_ipv6_subnet_cidr_pair_details (oci.mysql.models.Ipv6AddressIpv6SubnetCidrPairDetails) – The value to assign to the ipv6_address_ipv6_subnet_cidr_pair_details property of this CreateDbSystemDetails.
port (int) – The value to assign to the port property of this CreateDbSystemDetails.
port_x (int) – The value to assign to the port_x property of this CreateDbSystemDetails.
backup_policy (oci.mysql.models.CreateBackupPolicyDetails) – The value to assign to the backup_policy property of this CreateDbSystemDetails.
source (oci.mysql.models.CreateDbSystemSourceDetails) – The value to assign to the source property of this CreateDbSystemDetails.
maintenance (oci.mysql.models.CreateMaintenanceDetails) – The value to assign to the maintenance property of this CreateDbSystemDetails.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CreateDbSystemDetails.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CreateDbSystemDetails.
deletion_policy (oci.mysql.models.CreateDeletionPolicyDetails) – The value to assign to the deletion_policy property of this CreateDbSystemDetails.
crash_recovery (str) – The value to assign to the crash_recovery property of this CreateDbSystemDetails. Allowed values for this property are: “ENABLED”, “DISABLED”
database_management (str) – The value to assign to the database_management property of this CreateDbSystemDetails. Allowed values for this property are: “ENABLED”, “DISABLED”
secure_connections (oci.mysql.models.SecureConnectionDetails) – The value to assign to the secure_connections property of this CreateDbSystemDetails.
encrypt_data (oci.mysql.models.EncryptDataDetails) – The value to assign to the encrypt_data property of this CreateDbSystemDetails.
database_mode (str) – The value to assign to the database_mode property of this CreateDbSystemDetails.
access_mode (str) – The value to assign to the access_mode property of this CreateDbSystemDetails.
customer_contacts (list[oci.mysql.models.CustomerContact]) – The value to assign to the customer_contacts property of this CreateDbSystemDetails.
read_endpoint (oci.mysql.models.CreateReadEndpointDetails) – The value to assign to the read_endpoint property of this CreateDbSystemDetails.
telemetry_configuration (oci.mysql.models.CreateTelemetryConfigurationDetails) – The value to assign to the telemetry_configuration property of this CreateDbSystemDetails.

property access_mode¶

Gets the access_mode of this CreateDbSystemDetails. The access mode indicating if the database access will be restricted only to administrators or not:

UNRESTRICTED (default): the access to the database is not restricted;

RESTRICTED: the access will be allowed only to users with specific privileges; RESTRICTED will correspond to setting the MySQL system variable `offline_mode`__ to ON.

Returns: The access_mode of this CreateDbSystemDetails.
Return type: str

property admin_password¶

Gets the admin_password of this CreateDbSystemDetails. The password for the administrative user. The password must be between 8 and 32 characters long, and must contain at least 1 numeric character, 1 lowercase character, 1 uppercase character, and 1 special (nonalphanumeric) character.

Returns: The admin_password of this CreateDbSystemDetails.
Return type: str

property admin_username¶

Gets the admin_username of this CreateDbSystemDetails. The username for the administrative user.

Returns: The admin_username of this CreateDbSystemDetails.
Return type: str

property availability_domain¶

Gets the availability_domain of this CreateDbSystemDetails. The availability domain on which to deploy the Read/Write endpoint. This defines the preferred primary instance.

In a failover scenario, the Read/Write endpoint is redirected to one of the other availability domains and the MySQL instance in that domain is promoted to the primary instance. This redirection does not affect the IP address of the DB System in any way.

For a standalone DB System, this defines the availability domain in which the DB System is placed.

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

property backup_policy¶

Gets the backup_policy of this CreateDbSystemDetails.

Returns: The backup_policy of this CreateDbSystemDetails.
Return type: oci.mysql.models.CreateBackupPolicyDetails

property compartment_id¶

[Required] Gets the compartment_id of this CreateDbSystemDetails. The OCID of the compartment.

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

property configuration_id¶

Gets the configuration_id of this CreateDbSystemDetails. The OCID of the Configuration to be used for this DB System.

Returns: The configuration_id of this CreateDbSystemDetails.
Return type: str

property crash_recovery¶

Gets the crash_recovery of this CreateDbSystemDetails. Whether to run the DB System with InnoDB Redo Logs and the Double Write Buffer enabled or disabled, and whether to enable or disable syncing of the Binary Logs.

Allowed values for this property are: “ENABLED”, “DISABLED”

Returns: The crash_recovery of this CreateDbSystemDetails.
Return type: str

property customer_contacts¶

Gets the customer_contacts of this CreateDbSystemDetails. The list of customer email addresses that receive information from Oracle about the specified OCI DB System resource. Oracle uses these email addresses to send notifications about planned and unplanned software maintenance updates, information about system hardware, and other information needed by administrators. Up to 10 email addresses can be added to the customer contacts for a DB System.

Returns: The customer_contacts of this CreateDbSystemDetails.
Return type: list[oci.mysql.models.CustomerContact]

property data_storage¶

Gets the data_storage of this CreateDbSystemDetails.

Returns: The data_storage of this CreateDbSystemDetails.
Return type: oci.mysql.models.DataStorageDetails

property data_storage_size_in_gbs¶

Gets the data_storage_size_in_gbs of this CreateDbSystemDetails. Initial size of the data volume in GBs that will be created and attached. Keep in mind that this only specifies the size of the database data volume, the log volume for the database will be scaled appropriately with its shape.

Returns: The data_storage_size_in_gbs of this CreateDbSystemDetails.
Return type: int

property database_console¶

Gets the database_console of this CreateDbSystemDetails.

Returns: The database_console of this CreateDbSystemDetails.
Return type: oci.mysql.models.CreateDatabaseConsoleDetails

property database_management¶

Gets the database_management of this CreateDbSystemDetails. Whether to enable monitoring via the Database Management service.

Allowed values for this property are: “ENABLED”, “DISABLED”

Returns: The database_management of this CreateDbSystemDetails.
Return type: str

property database_mode¶

Gets the database_mode of this CreateDbSystemDetails. The database mode indicating the types of statements that will be allowed to run in the DB system. This mode will apply only to statements run by user connections. Replicated write statements will continue to be allowed regardless of the DatabaseMode.

READ_WRITE (default): allow running read and write statements on the DB system;

READ_ONLY: only allow running read statements on the DB system.

Returns: The database_mode of this CreateDbSystemDetails.
Return type: str

property defined_tags¶

Gets the defined_tags of this CreateDbSystemDetails. Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {“foo-namespace”: {“bar-key”: “value”}}

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

property deletion_policy¶

Gets the deletion_policy of this CreateDbSystemDetails.

Returns: The deletion_policy of this CreateDbSystemDetails.
Return type: oci.mysql.models.CreateDeletionPolicyDetails

property description¶

Gets the description of this CreateDbSystemDetails. User-provided data about the DB System.

Returns: The description of this CreateDbSystemDetails.
Return type: str

property display_name¶

Gets the display_name of this CreateDbSystemDetails. The user-friendly name for the DB System. It does not have to be unique.

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

property encrypt_data¶

Gets the encrypt_data of this CreateDbSystemDetails.

Returns: The encrypt_data of this CreateDbSystemDetails.
Return type: oci.mysql.models.EncryptDataDetails

property fault_domain¶

Gets the fault_domain of this CreateDbSystemDetails. The fault domain on which to deploy the Read/Write endpoint. This defines the preferred primary instance.

In a failover scenario, the Read/Write endpoint is redirected to one of the other fault domains and the MySQL instance in that domain is promoted to the primary instance. This redirection does not affect the IP address of the DB System in any way.

For a standalone DB System, this defines the fault domain in which the DB System is placed.

Returns: The fault_domain of this CreateDbSystemDetails.
Return type: str

property freeform_tags¶

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

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

property hostname_label¶

Gets the hostname_label of this CreateDbSystemDetails. The hostname for the primary endpoint of the DB System. Used for DNS.

The value is the hostname portion of the primary private IP’s fully qualified domain name (FQDN) (for example, “dbsystem-1” in FQDN “dbsystem-1.subnet123.vcn1.oraclevcn.com”).

Must be unique across all VNICs in the subnet and comply with RFC 952 and RFC 1123.

Returns: The hostname_label of this CreateDbSystemDetails.
Return type: str

property ip_address¶

Gets the ip_address of this CreateDbSystemDetails. The IP address the DB System is configured to listen on. A private IP address of your choice to assign to the primary endpoint of the DB System. 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. This should be a “dotted-quad” style IPv4 address.

Returns: The ip_address of this CreateDbSystemDetails.
Return type: str

property ipv6_address_ipv6_subnet_cidr_pair_details¶

Gets the ipv6_address_ipv6_subnet_cidr_pair_details of this CreateDbSystemDetails.

Returns: The ipv6_address_ipv6_subnet_cidr_pair_details of this CreateDbSystemDetails.
Return type: oci.mysql.models.Ipv6AddressIpv6SubnetCidrPairDetails

property is_highly_available¶

Gets the is_highly_available of this CreateDbSystemDetails. Specifies if the DB System is highly available.

When creating a DB System with High Availability, three instances are created and placed according to your region- and subnet-type. The secondaries are placed automatically in the other two availability or fault domains. You can choose the preferred location of your primary instance, only.

Returns: The is_highly_available of this CreateDbSystemDetails.
Return type: bool

property is_ipv6_enabled¶

Gets the is_ipv6_enabled of this CreateDbSystemDetails. Whether to allocate an IPv6 address at DB system creation from an IPv6 enabled subnet. When provided you may optionally provide an IPv6 prefix (ipv6AddressIpv6SubnetCidrPairDetails) of your choice to assign the IPv6 address from. If ipv6AddressIpv6SubnetCidrPairDetails is not provided then an IPv6 prefix is chosen for you.

Returns: The is_ipv6_enabled of this CreateDbSystemDetails.
Return type: bool

property maintenance¶

Gets the maintenance of this CreateDbSystemDetails.

Returns: The maintenance of this CreateDbSystemDetails.
Return type: oci.mysql.models.CreateMaintenanceDetails

property mysql_version¶

Gets the mysql_version of this CreateDbSystemDetails. The specific MySQL version identifier.

Returns: The mysql_version of this CreateDbSystemDetails.
Return type: str

property nsg_ids¶

Gets the nsg_ids of this CreateDbSystemDetails. Network Security Group OCIDs used for the VNIC attachment.

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

property port¶

Gets the port of this CreateDbSystemDetails. The port for primary endpoint of the DB System to listen on.

Returns: The port of this CreateDbSystemDetails.
Return type: int

property port_x¶

Gets the port_x of this CreateDbSystemDetails. The TCP network port on which X Plugin listens for connections. This is the X Plugin equivalent of port.

Returns: The port_x of this CreateDbSystemDetails.
Return type: int

property read_endpoint¶

Gets the read_endpoint of this CreateDbSystemDetails.

Returns: The read_endpoint of this CreateDbSystemDetails.
Return type: oci.mysql.models.CreateReadEndpointDetails

property rest¶

Gets the rest of this CreateDbSystemDetails.

Returns: The rest of this CreateDbSystemDetails.
Return type: oci.mysql.models.CreateRestDetails

property secure_connections¶

Gets the secure_connections of this CreateDbSystemDetails.

Returns: The secure_connections of this CreateDbSystemDetails.
Return type: oci.mysql.models.SecureConnectionDetails

property security_attributes¶

Gets the security_attributes of this CreateDbSystemDetails. Security Attributes for this resource. Each key is predefined and scoped to a namespace. For more information, see `ZPR Artifacts`__. Example: {“Oracle-ZPR”: {“MaxEgressCount”: {“value”: “42”, “mode”: “audit”}}}

Returns: The security_attributes of this CreateDbSystemDetails.
Return type: dict(str, dict(str, object))

property shape_name¶

[Required] Gets the shape_name of this CreateDbSystemDetails. The name of the shape. The shape determines the resources allocated - CPU cores and memory for VM shapes; CPU cores, memory and storage for non-VM (or bare metal) shapes. To get a list of shapes, use the list_shapes() operation.

Returns: The shape_name of this CreateDbSystemDetails.
Return type: str

property source¶

Gets the source of this CreateDbSystemDetails.

Returns: The source of this CreateDbSystemDetails.
Return type: oci.mysql.models.CreateDbSystemSourceDetails

property subnet_id¶

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

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

property telemetry_configuration¶

Gets the telemetry_configuration of this CreateDbSystemDetails.

Returns: The telemetry_configuration of this CreateDbSystemDetails.
Return type: oci.mysql.models.CreateTelemetryConfigurationDetails