oracle.oci.oci_mysql_db_system – Manage a DbSystem resource in Oracle Cloud Infrastructure¶
Note
This plugin is part of the oracle.oci collection (version 5.3.0).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install oracle.oci
.
To use it in a playbook, specify: oracle.oci.oci_mysql_db_system
.
New in version 2.9.0: of oracle.oci
Synopsis¶
This module allows the user to create, update and delete a DbSystem resource in Oracle Cloud Infrastructure
For state=present, creates and launches a DB System.
This resource has the following action operations in the oracle.oci.oci_mysql_db_system_actions module: restart, start, stop.
Requirements¶
The below requirements are needed on the host that executes this module.
python >= 3.6
Python SDK for Oracle Cloud Infrastructure https://oracle-cloud-infrastructure-python-sdk.readthedocs.io
Parameters¶
Parameter | Choices/Defaults | Comments | ||
---|---|---|---|---|
admin_password
string
|
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.
This parameter is updatable.
|
|||
admin_username
string
|
The username for the administrative user.
This parameter is updatable.
|
|||
api_user
string
|
The OCID of the user, on whose behalf, OCI APIs are invoked. If not set, then the value of the OCI_USER_ID environment variable, if any, is used. This option is required if the user is not specified through a configuration file (See
config_file_location ). To get the user's OCID, please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm. |
|||
api_user_fingerprint
string
|
Fingerprint for the key pair being used. If not set, then the value of the OCI_USER_FINGERPRINT environment variable, if any, is used. This option is required if the key fingerprint is not specified through a configuration file (See
config_file_location ). To get the key pair's fingerprint value please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm. |
|||
api_user_key_file
string
|
Full path and filename of the private key (in PEM format). If not set, then the value of the OCI_USER_KEY_FILE variable, if any, is used. This option is required if the private key is not specified through a configuration file (See
config_file_location ). If the key is encrypted with a pass-phrase, the api_user_key_pass_phrase option must also be provided. |
|||
api_user_key_pass_phrase
string
|
Passphrase used by the key referenced in
api_user_key_file , if it is encrypted. If not set, then the value of the OCI_USER_KEY_PASS_PHRASE variable, if any, is used. This option is required if the key passphrase is not specified through a configuration file (See config_file_location ). |
|||
auth_purpose
string
|
|
The auth purpose which can be used in conjunction with 'auth_type=instance_principal'. The default auth_purpose for instance_principal is None.
|
||
auth_type
string
|
|
The type of authentication to use for making API requests. By default
auth_type="api_key" based authentication is performed and the API key (see api_user_key_file) in your config file will be used. If this 'auth_type' module option is not specified, the value of the OCI_ANSIBLE_AUTH_TYPE, if any, is used. Use auth_type="instance_principal" to use instance principal based authentication when running ansible playbooks within an OCI compute instance. |
||
availability_domain
string
|
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.
This parameter is updatable.
|
|||
backup_policy
dictionary
|
This parameter is updatable.
|
|||
defined_tags
dictionary
|
Usage of predefined tag keys. These predefined keys are scoped to namespaces.
Tags defined here will be copied verbatim as tags on the Backup resource created by this BackupPolicy.
Example: `{"foo-namespace": {"bar-key": "value"}}`
This parameter is updatable.
|
|||
freeform_tags
dictionary
|
Simple key-value pair applied without any predefined name, type or scope. Exists for cross-compatibility only.
Tags defined here will be copied verbatim as tags on the Backup resource created by this BackupPolicy.
Example: `{"bar-key": "value"}`
This parameter is updatable.
|
|||
is_enabled
boolean
|
|
Specifies if automatic backups are enabled.
This parameter is updatable.
|
||
pitr_policy
dictionary
|
||||
is_enabled
boolean
/ required
|
|
Specifies if PITR is enabled or disabled.
|
||
retention_in_days
integer
|
Number of days to retain an automatic backup.
This parameter is updatable.
|
|||
window_start_time
string
|
The start of a 30-minute window of time in which daily, automated backups occur.
This should be in the format of the "Time" portion of an RFC3339-formatted timestamp. Any second or sub-second time data will be truncated to zero.
At some point in the window, the system may incur a brief service disruption as the backup is performed.
This parameter is updatable.
|
|||
cert_bundle
string
|
The full path to a CA certificate bundle to be used for SSL verification. This will override the default CA certificate bundle. If not set, then the value of the OCI_ANSIBLE_CERT_BUNDLE variable, if any, is used.
|
|||
compartment_id
string
|
The OCID of the compartment.
Required for create using state=present.
Required for update when environment variable
OCI_USE_NAME_AS_IDENTIFIER is set.Required for delete when environment variable
OCI_USE_NAME_AS_IDENTIFIER is set. |
|||
config_file_location
string
|
Path to configuration file. If not set then the value of the OCI_CONFIG_FILE environment variable, if any, is used. Otherwise, defaults to ~/.oci/config.
|
|||
config_profile_name
string
|
The profile to load from the config file referenced by
config_file_location . If not set, then the value of the OCI_CONFIG_PROFILE environment variable, if any, is used. Otherwise, defaults to the "DEFAULT" profile in config_file_location . |
|||
configuration_id
string
|
The OCID of the Configuration to be used for this DB System.
This parameter is updatable.
|
|||
crash_recovery
string
|
|
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.
This parameter is updatable.
|
||
data_storage_size_in_gbs
integer
|
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.
This parameter is updatable.
|
|||
database_management
string
|
|
Whether to enable monitoring via the Database Management service.
This parameter is updatable.
|
||
db_system_id
string
|
The DB System OCID.
Required for update using state=present when environment variable
OCI_USE_NAME_AS_IDENTIFIER is not set.Required for delete using state=absent when environment variable
OCI_USE_NAME_AS_IDENTIFIER is not set.aliases: id |
|||
defined_tags
dictionary
|
Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: `{"foo-namespace": {"bar-key": "value"}}`
This parameter is updatable.
|
|||
deletion_policy
dictionary
|
This parameter is updatable.
|
|||
automatic_backup_retention
string
|
|
Specifies if any automatic backups created for a DB System should be retained or deleted when the DB System is deleted.
This parameter is updatable.
|
||
final_backup
string
|
|
Specifies whether or not a backup is taken when the DB System is deleted. REQUIRE_FINAL_BACKUP: a backup is taken if the DB System is deleted. SKIP_FINAL_BACKUP: a backup is not taken if the DB System is deleted.
This parameter is updatable.
|
||
is_delete_protected
boolean
|
|
Specifies whether the DB System can be deleted. Set to true to prevent deletion, false (default) to allow.
This parameter is updatable.
|
||
description
string
|
User-provided data about the DB System.
This parameter is updatable.
|
|||
display_name
string
|
The user-friendly name for the DB System. It does not have to be unique.
Required for create, update, delete when environment variable
OCI_USE_NAME_AS_IDENTIFIER is set.This parameter is updatable when
OCI_USE_NAME_AS_IDENTIFIER is not set.aliases: name |
|||
fault_domain
string
|
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.
This parameter is updatable.
|
|||
force_create
boolean
|
|
Whether to attempt non-idempotent creation of a resource. By default, create resource is an idempotent operation, and doesn't create the resource if it already exists. Setting this option to true, forcefully creates a copy of the resource, even if it already exists.This option is mutually exclusive with key_by.
|
||
freeform_tags
dictionary
|
Simple key-value pair applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}`
This parameter is updatable.
|
|||
hostname_label
string
|
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.
This parameter is updatable.
|
|||
ip_address
string
|
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.
This parameter is updatable.
|
|||
is_highly_available
boolean
|
|
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.
This parameter is updatable.
|
||
key_by
list
/ elements=string
|
The list of attributes of this resource which should be used to uniquely identify an instance of the resource. By default, all the attributes of a resource are used to uniquely identify a resource.
|
|||
maintenance
dictionary
|
This parameter is updatable.
|
|||
window_start_time
string
|
The start of the 2 hour maintenance window.
This string is of the format: "{day-of-week} {time-of-day}".
"{day-of-week}" is a case-insensitive string like "mon", "tue", &c.
"{time-of-day}" is the "Time" portion of an RFC3339-formatted timestamp. Any second or sub-second time data will be truncated to zero.
If you set the read replica maintenance window to "" or if not specified, the read replica is set same as the DB system maintenance window.
This parameter is updatable.
|
|||
mysql_version
string
|
The specific MySQL version identifier.
This parameter is updatable.
|
|||
port
integer
|
The port for primary endpoint of the DB System to listen on.
This parameter is updatable.
|
|||
port_x
integer
|
The TCP network port on which X Plugin listens for connections. This is the X Plugin equivalent of port.
This parameter is updatable.
|
|||
realm_specific_endpoint_template_enabled
boolean
|
|
Enable/Disable realm specific endpoint template for service client. By Default, realm specific endpoint template is disabled. If not set, then the value of the OCI_REALM_SPECIFIC_SERVICE_ENDPOINT_TEMPLATE_ENABLED variable, if any, is used.
|
||
region
string
|
The Oracle Cloud Infrastructure region to use for all OCI API requests. If not set, then the value of the OCI_REGION variable, if any, is used. This option is required if the region is not specified through a configuration file (See
config_file_location ). Please refer to https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/regions.htm for more information on OCI regions. |
|||
shape_name
string
|
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 ListShapes operation.
Required for create using state=present.
This parameter is updatable.
|
|||
source
dictionary
|
||||
backup_id
string
|
The OCID of the backup to be used as the source for the new DB System.
Required when source_type is 'BACKUP'
|
|||
db_system_id
string
|
The OCID of the DB System from which a backup shall be selected to be restored when creating the new DB System. Use this together with recovery point to perform a point in time recovery operation.
Required when source_type is 'PITR'
|
|||
recovery_point
string
|
The date and time, as per RFC 3339, of the change up to which the new DB System shall be restored to, using a backup and logs from the original DB System. In case no point in time is specified, then this new DB System shall be restored up to the latest change recorded for the original DB System.
Applicable when source_type is 'PITR'
|
|||
source_type
string
|
|
The specific source identifier.
|
||
source_url
string
|
The Pre-Authenticated Request (PAR) of a bucket/prefix or PAR of a @.manifest.json object from the Object Storage. Check Using Pre-Authenticated Requests for information related to PAR creation. Please create PAR with "Permit object reads" access type and "Enable Object Listing" permission when using a bucket/prefix PAR. Please create PAR with "Permit object reads" access type when using a @.manifest.json object PAR.
Required when source_type is 'IMPORTURL'
|
|||
state
string
|
|
The state of the DbSystem.
Use state=present to create or update a DbSystem.
Use state=absent to delete a DbSystem.
|
||
subnet_id
string
|
The OCID of the subnet the DB System is associated with.
Required for create using state=present.
This parameter is updatable.
|
|||
tenancy
string
|
OCID of your tenancy. If not set, then the value of the OCI_TENANCY variable, if any, is used. This option is required if the tenancy OCID is not specified through a configuration file (See
config_file_location ). To get the tenancy OCID, please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm |
|||
wait
boolean
|
|
Whether to wait for create or delete operation to complete.
|
||
wait_timeout
integer
|
Time, in seconds, to wait when wait=yes. Defaults to 1200 for most of the services but some services might have a longer wait timeout.
|
Notes¶
Note
For OCI python sdk configuration, please refer to https://oracle-cloud-infrastructure-python-sdk.readthedocs.io/en/latest/configuration.html
Examples¶
- name: Create db_system
oci_mysql_db_system:
# required
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
subnet_id: "ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx"
shape_name: shape_name_example
# optional
source:
# required
backup_id: "ocid1.backup.oc1..xxxxxxEXAMPLExxxxxx"
source_type: BACKUP
display_name: display_name_example
description: description_example
is_highly_available: true
availability_domain: Uocm:PHX-AD-1
fault_domain: FAULT-DOMAIN-1
mysql_version: mysql_version_example
configuration_id: "ocid1.configuration.oc1..xxxxxxEXAMPLExxxxxx"
admin_username: admin_username_example
admin_password: example-password
data_storage_size_in_gbs: 56
hostname_label: hostname_label_example
ip_address: ip_address_example
port: 56
port_x: 56
backup_policy:
# optional
is_enabled: true
window_start_time: window_start_time_example
retention_in_days: 56
freeform_tags: {'Department': 'Finance'}
defined_tags: {'Operations': {'CostCenter': 'US'}}
pitr_policy:
# required
is_enabled: true
maintenance:
# optional
window_start_time: window_start_time_example
freeform_tags: {'Department': 'Finance'}
defined_tags: {'Operations': {'CostCenter': 'US'}}
deletion_policy:
# optional
automatic_backup_retention: DELETE
final_backup: SKIP_FINAL_BACKUP
is_delete_protected: true
crash_recovery: ENABLED
database_management: ENABLED
- name: Update db_system
oci_mysql_db_system:
# required
db_system_id: "ocid1.dbsystem.oc1..xxxxxxEXAMPLExxxxxx"
# optional
display_name: display_name_example
description: description_example
subnet_id: "ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx"
is_highly_available: true
availability_domain: Uocm:PHX-AD-1
fault_domain: FAULT-DOMAIN-1
shape_name: shape_name_example
mysql_version: mysql_version_example
configuration_id: "ocid1.configuration.oc1..xxxxxxEXAMPLExxxxxx"
admin_username: admin_username_example
admin_password: example-password
data_storage_size_in_gbs: 56
hostname_label: hostname_label_example
ip_address: ip_address_example
port: 56
port_x: 56
backup_policy:
# optional
is_enabled: true
window_start_time: window_start_time_example
retention_in_days: 56
freeform_tags: {'Department': 'Finance'}
defined_tags: {'Operations': {'CostCenter': 'US'}}
pitr_policy:
# required
is_enabled: true
maintenance:
# optional
window_start_time: window_start_time_example
freeform_tags: {'Department': 'Finance'}
defined_tags: {'Operations': {'CostCenter': 'US'}}
deletion_policy:
# optional
automatic_backup_retention: DELETE
final_backup: SKIP_FINAL_BACKUP
is_delete_protected: true
crash_recovery: ENABLED
database_management: ENABLED
- name: Update db_system using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
oci_mysql_db_system:
# required
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
display_name: display_name_example
# optional
description: description_example
subnet_id: "ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx"
is_highly_available: true
availability_domain: Uocm:PHX-AD-1
fault_domain: FAULT-DOMAIN-1
shape_name: shape_name_example
mysql_version: mysql_version_example
configuration_id: "ocid1.configuration.oc1..xxxxxxEXAMPLExxxxxx"
admin_username: admin_username_example
admin_password: example-password
data_storage_size_in_gbs: 56
hostname_label: hostname_label_example
ip_address: ip_address_example
port: 56
port_x: 56
backup_policy:
# optional
is_enabled: true
window_start_time: window_start_time_example
retention_in_days: 56
freeform_tags: {'Department': 'Finance'}
defined_tags: {'Operations': {'CostCenter': 'US'}}
pitr_policy:
# required
is_enabled: true
maintenance:
# optional
window_start_time: window_start_time_example
freeform_tags: {'Department': 'Finance'}
defined_tags: {'Operations': {'CostCenter': 'US'}}
deletion_policy:
# optional
automatic_backup_retention: DELETE
final_backup: SKIP_FINAL_BACKUP
is_delete_protected: true
crash_recovery: ENABLED
database_management: ENABLED
- name: Delete db_system
oci_mysql_db_system:
# required
db_system_id: "ocid1.dbsystem.oc1..xxxxxxEXAMPLExxxxxx"
state: absent
- name: Delete db_system using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
oci_mysql_db_system:
# required
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
display_name: display_name_example
state: absent
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description | ||||
---|---|---|---|---|---|---|
db_system
complex
|
on success |
Details of the DbSystem resource acted upon by the current operation
Sample:
{'availability_domain': 'Uocm:PHX-AD-1', 'backup_policy': {'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'freeform_tags': {'Department': 'Finance'}, 'is_enabled': True, 'pitr_policy': {'is_enabled': True}, 'retention_in_days': 56, 'window_start_time': 'window_start_time_example'}, 'channels': [{'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'display_name': 'display_name_example', 'freeform_tags': {'Department': 'Finance'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'is_enabled': True, 'lifecycle_details': 'lifecycle_details_example', 'lifecycle_state': 'lifecycle_state_example', 'source': {'anonymous_transactions_handling': {'last_configured_log_filename': 'last_configured_log_filename_example', 'last_configured_log_offset': 56, 'policy': 'ERROR_ON_ANONYMOUS', 'uuid': None}, 'hostname': 'hostname_example', 'port': 56, 'source_type': 'MYSQL', 'ssl_ca_certificate': {'certificate_type': 'PEM', 'contents': 'contents_example'}, 'ssl_mode': 'VERIFY_IDENTITY', 'username': 'username_example'}, 'target': {'applier_username': 'applier_username_example', 'channel_name': 'channel_name_example', 'db_system_id': 'ocid1.dbsystem.oc1..xxxxxxEXAMPLExxxxxx', 'delay_in_seconds': 56, 'filters': [{'type': 'REPLICATE_DO_DB', 'value': 'value_example'}], 'tables_without_primary_key_handling': 'RAISE_ERROR', 'target_type': 'DBSYSTEM'}, 'time_created': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00'}], 'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'configuration_id': 'ocid1.configuration.oc1..xxxxxxEXAMPLExxxxxx', 'crash_recovery': 'ENABLED', 'current_placement': {'availability_domain': 'Uocm:PHX-AD-1', 'fault_domain': 'FAULT-DOMAIN-1'}, 'data_storage_size_in_gbs': 56, 'database_management': 'ENABLED', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'deletion_policy': {'automatic_backup_retention': 'DELETE', 'final_backup': 'SKIP_FINAL_BACKUP', 'is_delete_protected': True}, 'description': 'description_example', 'display_name': 'display_name_example', 'endpoints': [{'hostname': 'hostname_example', 'ip_address': 'ip_address_example', 'modes': [], 'port': 56, 'port_x': 56, 'resource_id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'resource_type': 'DBSYSTEM', 'status': 'ACTIVE', 'status_details': 'status_details_example'}], 'fault_domain': 'FAULT-DOMAIN-1', 'freeform_tags': {'Department': 'Finance'}, 'heat_wave_cluster': {'cluster_size': 56, 'is_lakehouse_enabled': True, 'lifecycle_state': 'lifecycle_state_example', 'shape_name': 'shape_name_example', 'time_created': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00'}, 'hostname_label': 'hostname_label_example', 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'ip_address': 'ip_address_example', 'is_heat_wave_cluster_attached': True, 'is_highly_available': True, 'lifecycle_details': 'lifecycle_details_example', 'lifecycle_state': 'CREATING', 'maintenance': {'window_start_time': 'window_start_time_example'}, 'mysql_version': 'mysql_version_example', 'point_in_time_recovery_details': {'time_earliest_recovery_point': '2013-10-20T19:20:30+01:00', 'time_latest_recovery_point': '2013-10-20T19:20:30+01:00'}, 'port': 56, 'port_x': 56, 'shape_name': 'shape_name_example', 'source': {'backup_id': 'ocid1.backup.oc1..xxxxxxEXAMPLExxxxxx', 'db_system_id': 'ocid1.dbsystem.oc1..xxxxxxEXAMPLExxxxxx', 'recovery_point': '2013-10-20T19:20:30+01:00', 'source_type': 'NONE'}, 'subnet_id': 'ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx', 'time_created': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00'}
|
||||
availability_domain
string
|
on success |
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.
Sample:
Uocm:PHX-AD-1
|
||||
backup_policy
complex
|
on success |
|
||||
defined_tags
dictionary
|
on success |
Usage of predefined tag keys. These predefined keys are scoped to namespaces.
Tags defined here will be copied verbatim as tags on the Backup resource created by this BackupPolicy.
Example: `{"foo-namespace": {"bar-key": "value"}}`
Sample:
{'Operations': {'CostCenter': 'US'}}
|
||||
freeform_tags
dictionary
|
on success |
Simple key-value pair applied without any predefined name, type or scope. Exists for cross-compatibility only.
Tags defined here will be copied verbatim as tags on the Backup resource created by this BackupPolicy.
Example: `{"bar-key": "value"}`
Sample:
{'Department': 'Finance'}
|
||||
is_enabled
boolean
|
on success |
If automated backups are enabled or disabled.
Sample:
True
|
||||
pitr_policy
complex
|
on success |
|
||||
is_enabled
boolean
|
on success |
Specifies if PITR is enabled or disabled.
Sample:
True
|
||||
retention_in_days
integer
|
on success |
The number of days automated backups are retained.
Sample:
56
|
||||
window_start_time
string
|
on success |
The start of a 30-minute window of time in which daily, automated backups occur.
This should be in the format of the "Time" portion of an RFC3339-formatted timestamp. Any second or sub-second time data will be truncated to zero.
At some point in the window, the system may incur a brief service disruption as the backup is performed.
If not defined, a window is selected from the following Region-based time-spans: - eu-frankfurt-1: 20:00 - 04:00 UTC - us-ashburn-1: 03:00 - 11:00 UTC - uk-london-1: 06:00 - 14:00 UTC - ap-tokyo-1: 13:00 - 21:00 - us-phoenix-1: 06:00 - 14:00
Sample:
window_start_time_example
|
||||
channels
complex
|
on success |
A list with a summary of all the Channels attached to the DB System.
|
||||
compartment_id
string
|
on success |
The OCID of the compartment.
Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
|
||||
defined_tags
dictionary
|
on success |
Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: `{"foo-namespace": {"bar-key": "value"}}`
Sample:
{'Operations': {'CostCenter': 'US'}}
|
||||
display_name
string
|
on success |
The user-friendly name for the Channel. It does not have to be unique.
Sample:
display_name_example
|
||||
freeform_tags
dictionary
|
on success |
Simple key-value pair applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}`
Sample:
{'Department': 'Finance'}
|
||||
id
string
|
on success |
The OCID of the Channel.
Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
|
||||
is_enabled
boolean
|
on success |
Whether the Channel has been enabled by the user.
Sample:
True
|
||||
lifecycle_details
string
|
on success |
A message describing the state of the Channel.
Sample:
lifecycle_details_example
|
||||
lifecycle_state
string
|
on success |
The state of the Channel.
Sample:
lifecycle_state_example
|
||||
source
complex
|
on success |
|
||||
anonymous_transactions_handling
complex
|
on success |
|
||||
last_configured_log_filename
string
|
on success |
Specifies one of the coordinates (file) at which the replica should begin reading the source's log. As this value specifies the point where replication starts from, it is only used once, when it starts. It is never used again, unless a new UpdateChannel operation modifies it.
Sample:
last_configured_log_filename_example
|
||||
last_configured_log_offset
integer
|
on success |
Specifies one of the coordinates (offset) at which the replica should begin reading the source's log. As this value specifies the point where replication starts from, it is only used once, when it starts. It is never used again, unless a new UpdateChannel operation modifies it.
Sample:
56
|
||||
policy
string
|
on success |
Specifies how the replication channel handles anonymous transactions.
Sample:
ERROR_ON_ANONYMOUS
|
||||
uuid
string
|
on success |
The UUID that is used as a prefix when generating transaction identifiers for anonymous transactions coming from the source. You can change the UUID later.
Sample:
null
|
||||
hostname
string
|
on success |
The network address of the MySQL instance.
Sample:
hostname_example
|
||||
port
integer
|
on success |
The port the source MySQL instance listens on.
Sample:
56
|
||||
source_type
string
|
on success |
The specific source identifier.
Sample:
MYSQL
|
||||
ssl_ca_certificate
complex
|
on success |
|
||||
certificate_type
string
|
on success |
The type of CA certificate.
Sample:
PEM
|
||||
contents
string
|
on success |
The string containing the CA certificate in PEM format.
Sample:
contents_example
|
||||
ssl_mode
string
|
on success |
The SSL mode of the Channel.
Sample:
VERIFY_IDENTITY
|
||||
username
string
|
on success |
The name of the replication user on the source MySQL instance. The username has a maximum length of 96 characters. For more information, please see the MySQL documentation
Sample:
username_example
|
||||
target
complex
|
on success |
|
||||
applier_username
string
|
on success |
The username for the replication applier of the target MySQL DB System.
Sample:
applier_username_example
|
||||
channel_name
string
|
on success |
The case-insensitive name that identifies the replication channel. Channel names must follow the rules defined for MySQL identifiers. The names of non-Deleted Channels must be unique for each DB System.
Sample:
channel_name_example
|
||||
db_system_id
string
|
on success |
The OCID of the source DB System.
Sample:
ocid1.dbsystem.oc1..xxxxxxEXAMPLExxxxxx
|
||||
delay_in_seconds
integer
|
on success |
Specifies the amount of time, in seconds, that the channel waits before applying a transaction received from the source.
Sample:
56
|
||||
filters
complex
|
on success |
Replication filter rules to be applied at the DB System Channel target.
|
||||
type
string
|
on success |
The type of the filter rule.
For details on each type, see Replication Filtering Rules
Sample:
REPLICATE_DO_DB
|
||||
value
string
|
on success |
The body of the filter rule. This can represent a database, a table, or a database pair (represented as "db1->db2"). For more information, see Replication Filtering Rules.
Sample:
value_example
|
||||
tables_without_primary_key_handling
string
|
on success |
Specifies how a replication channel handles the creation and alteration of tables that do not have a primary key.
Sample:
RAISE_ERROR
|
||||
target_type
string
|
on success |
The specific target identifier.
Sample:
DBSYSTEM
|
||||
time_created
string
|
on success |
The date and time the Channel was created, as described by RFC 3339.
Sample:
2013-10-20T19:20:30+01:00
|
||||
time_updated
string
|
on success |
The time the Channel was last updated, as described by RFC 3339.
Sample:
2013-10-20T19:20:30+01:00
|
||||
compartment_id
string
|
on success |
The OCID of the compartment the DB System belongs in.
Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
|
||||
configuration_id
string
|
on success |
The OCID of the Configuration to be used for Instances in this DB System.
Sample:
ocid1.configuration.oc1..xxxxxxEXAMPLExxxxxx
|
||||
crash_recovery
string
|
on success |
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.
Sample:
ENABLED
|
||||
current_placement
complex
|
on success |
|
||||
availability_domain
string
|
on success |
The availability domain in which the DB System is placed.
Sample:
Uocm:PHX-AD-1
|
||||
fault_domain
string
|
on success |
The fault domain in which the DB System is placed.
Sample:
FAULT-DOMAIN-1
|
||||
data_storage_size_in_gbs
integer
|
on success |
Initial size of the data volume in GiBs that will be created and attached.
Sample:
56
|
||||
database_management
string
|
on success |
Whether to enable monitoring via the Database Management service.
Sample:
ENABLED
|
||||
defined_tags
dictionary
|
on success |
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}`
Sample:
{'Operations': {'CostCenter': 'US'}}
|
||||
deletion_policy
complex
|
on success |
|
||||
automatic_backup_retention
string
|
on success |
Specifies if any automatic backups created for a DB System should be retained or deleted when the DB System is deleted.
Sample:
DELETE
|
||||
final_backup
string
|
on success |
Specifies whether or not a backup is taken when the DB System is deleted. REQUIRE_FINAL_BACKUP: a backup is taken if the DB System is deleted. SKIP_FINAL_BACKUP: a backup is not taken if the DB System is deleted.
Sample:
SKIP_FINAL_BACKUP
|
||||
is_delete_protected
boolean
|
on success |
Specifies whether the DB System can be deleted. Set to true to prevent deletion, false (default) to allow.
Sample:
True
|
||||
description
string
|
on success |
User-provided data about the DB System.
Sample:
description_example
|
||||
display_name
string
|
on success |
The user-friendly name for the DB System. It does not have to be unique.
Sample:
display_name_example
|
||||
endpoints
complex
|
on success |
The network endpoints available for this DB System.
|
||||
hostname
string
|
on success |
The network address of the DB System.
Sample:
hostname_example
|
||||
ip_address
string
|
on success |
The IP address the DB System is configured to listen on.
Sample:
ip_address_example
|
||||
modes
list
/ elements=string
|
on success |
The access modes from the client that this endpoint supports.
|
||||
port
integer
|
on success |
The port the MySQL instance listens on.
Sample:
56
|
||||
port_x
integer
|
on success |
The network port where to connect to use this endpoint using the X protocol.
Sample:
56
|
||||
resource_id
string
|
on success |
The OCID of the resource that this endpoint is attached to.
Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
|
||||
resource_type
string
|
on success |
The type of endpoint that clients and connectors can connect to.
Sample:
DBSYSTEM
|
||||
status
string
|
on success |
The state of the endpoints, as far as it can seen from the DB System. There may be some inconsistency with the actual state of the MySQL service.
Sample:
ACTIVE
|
||||
status_details
string
|
on success |
Additional information about the current endpoint status.
Sample:
status_details_example
|
||||
fault_domain
string
|
on success |
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.
Sample:
FAULT-DOMAIN-1
|
||||
freeform_tags
dictionary
|
on success |
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}`
Sample:
{'Department': 'Finance'}
|
||||
heat_wave_cluster
complex
|
on success |
|
||||
cluster_size
integer
|
on success |
The number of analytics-processing compute instances, of the specified shape, in the HeatWave cluster.
Sample:
56
|
||||
is_lakehouse_enabled
boolean
|
on success |
Lakehouse enabled status for the HeatWave cluster.
Sample:
True
|
||||
lifecycle_state
string
|
on success |
The current state of the MySQL HeatWave cluster.
Sample:
lifecycle_state_example
|
||||
shape_name
string
|
on success |
The shape determines resources to allocate to the HeatWave nodes - CPU cores, memory.
Sample:
shape_name_example
|
||||
time_created
string
|
on success |
The date and time the HeatWave cluster was created, as described by RFC 3339.
Sample:
2013-10-20T19:20:30+01:00
|
||||
time_updated
string
|
on success |
The time the HeatWave cluster was last updated, as described by RFC 3339.
Sample:
2013-10-20T19:20:30+01:00
|
||||
hostname_label
string
|
on success |
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.
Sample:
hostname_label_example
|
||||
id
string
|
on success |
The OCID of the DB System.
Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
|
||||
ip_address
string
|
on success |
The IP address the DB System is configured to listen on. A private IP address of the primary endpoint of the DB System. Must be an available IP address within the subnet's CIDR. This will be a "dotted-quad" style IPv4 address.
Sample:
ip_address_example
|
||||
is_heat_wave_cluster_attached
boolean
|
on success |
If the DB System has a HeatWave Cluster attached.
Sample:
True
|
||||
is_highly_available
boolean
|
on success |
Specifies if the DB System is highly available.
Sample:
True
|
||||
lifecycle_details
string
|
on success |
Additional information about the current lifecycleState.
Sample:
lifecycle_details_example
|
||||
lifecycle_state
string
|
on success |
The current state of the DB System.
Sample:
CREATING
|
||||
maintenance
complex
|
on success |
|
||||
window_start_time
string
|
on success |
The start time of the maintenance window.
This string is of the format: "{day-of-week} {time-of-day}".
"{day-of-week}" is a case-insensitive string like "mon", "tue", &c.
"{time-of-day}" is the "Time" portion of an RFC3339-formatted timestamp. Any second or sub-second time data will be truncated to zero.
If you set the read replica maintenance window to "" or if not specified, the read replica is set same as the DB system maintenance window.
Sample:
window_start_time_example
|
||||
mysql_version
string
|
on success |
Name of the MySQL Version in use for the DB System.
Sample:
mysql_version_example
|
||||
point_in_time_recovery_details
complex
|
on success |
|
||||
time_earliest_recovery_point
string
|
on success |
Earliest recovery time point for the DB System, as described by RFC 3339.
Sample:
2013-10-20T19:20:30+01:00
|
||||
time_latest_recovery_point
string
|
on success |
Latest recovery time point for the DB System, as described by RFC 3339.
Sample:
2013-10-20T19:20:30+01:00
|
||||
port
integer
|
on success |
The port for primary endpoint of the DB System to listen on.
Sample:
56
|
||||
port_x
integer
|
on success |
The network port on which X Plugin listens for TCP/IP connections. This is the X Plugin equivalent of port.
Sample:
56
|
||||
shape_name
string
|
on success |
The shape of the primary instances of the DB System. The shape determines resources allocated to a DB System - 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 ListShapes operation.
Sample:
shape_name_example
|
||||
source
complex
|
on success |
|
||||
backup_id
string
|
on success |
The OCID of the backup to be used as the source for the new DB System.
Sample:
ocid1.backup.oc1..xxxxxxEXAMPLExxxxxx
|
||||
db_system_id
string
|
on success |
The OCID of the DB System from which a backup shall be selected to be restored when creating the new DB System. Use this together with recovery point to perform a point in time recovery operation.
Sample:
ocid1.dbsystem.oc1..xxxxxxEXAMPLExxxxxx
|
||||
recovery_point
string
|
on success |
The date and time, as per RFC 3339, of the change up to which the new DB System shall be restored to, using a backup and logs from the original DB System. In case no point in time is specified, then this new DB System shall be restored up to the latest change recorded for the original DB System.
Sample:
2013-10-20T19:20:30+01:00
|
||||
source_type
string
|
on success |
The specific source identifier.
Sample:
NONE
|
||||
subnet_id
string
|
on success |
The OCID of the subnet the DB System is associated with.
Sample:
ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx
|
||||
time_created
string
|
on success |
The date and time the DB System was created.
Sample:
2013-10-20T19:20:30+01:00
|
||||
time_updated
string
|
on success |
The time the DB System was last updated.
Sample:
2013-10-20T19:20:30+01:00
|
Authors¶
Oracle (@oracle)